Components

JcuApp

<JcuApp />

Constructor

# <JcuApp />

Parameters:
Name Type Attributes Description
title string

Title to appear in heading of application

basePath string

Base path of the application (e.g. App-specific hosting URL)

login LoginMode

Enum dictating the login type (e.g FORCED login)

navItems Array.<NavItem> <optional>

An array of NavItems to be added to the app router and navigation bar

popup boolean <optional>

Boolean prop to set whether the login mode should be popup or redirect

theme string <optional>

Theme to be used by application, specified by a predefined name

logoutPage React.ReactElement <optional>

React element to load upon successful user logout

openPage React.ReactElement <optional>

React element to load before the config provided application open date

closePage React.ReactElement <optional>

React element to load after the config provided application close date

safePaths Array.<string> <optional>

List of internal app routes that can be accessed without authentication (e.g. for FORCED login apps)

shape Shape <optional>

The layout "shape" of this app. Defaults to COLUMN, a vertically scrolling column with the width constrained to some reasonable limit.

View Source components/JcuApp.tsx, line 62

Classes

JcuApp

Members

number

# static exports.LoginMode

Enum for different login modes for the JcuApp

Properties:
Name Type Description
NONE

No login required or offered

OPTIONAL

No login required, but login can be required for access to restricted content

FORCED

Login is required to use the app. Automatically redirects users to Forgerock when the app loads.

View Source components/JcuApp.tsx, line 20

number

# static exports.Shape

Different "shapes" JcuApp content can be, used to control the size and behaviour of the wrapping elements.

Later we will add a shape for apps that fill the screen without scrolling, like a slippy map.

Properties:
Name Type Description
COLUMN

Assume that the app's content is in a vertically-scrolling column constrained to some reasonable width, where "reasonable" is defined by the theme (usually around 1000 pixels)

WIDECOLUMN

App content can fill the full width of the browser window, no matter how silly that gets

View Source components/JcuApp.tsx, line 41