Interface TemplateOpts

interface TemplateOpts {
    apiErrorHandler?: ApiErrorHandler;
    appInitialization?: ((logger) => Promise<boolean>)[];
    appInitializationLoader?: ComponentClass<{
        appStatus: AppStatus;
    }, any> | FunctionComponent<{
        appStatus: AppStatus;
    }>;
    appName?: string;
    blockPages?: BlockPage[];
    error500Component?: ComponentClass<BlockComponentProps, any> | FunctionComponent<BlockComponentProps>;
    errorMessageI18nHandler?: ErrorMessageI18nHandler;
    i18nOptions?: InitOptions<object>;
    logger?: Logger;
    navigationComponent?: ComponentClass<NavigationComponentProps, any> | FunctionComponent<NavigationComponentProps>;
    notFound404Component?: ComponentClass<BlockComponentProps, any> | FunctionComponent<BlockComponentProps>;
    pageTitleConfiguration?: PageTitleConfiguration;
    theme?: Theme;
    toastConfiguration?: ToastConfiguration;
}

Properties

apiErrorHandler? appInitialization? appInitializationLoader? appName? blockPages? error500Component? errorMessageI18nHandler? i18nOptions? logger? navigationComponent? notFound404Component? pageTitleConfiguration? theme? toastConfiguration?

Properties

Optional apiErrorHandler

apiErrorHandler?: ApiErrorHandler

The onApiError callback to retry request or not

Optional appInitialization

appInitialization?: ((logger) => Promise<boolean>)[]

An array of methods to run on app initialization (before the page renders). Use this to initialize user sessions, initial data setup and validation etc. If any of these methods return false, the app will stop and not initialize.

Type declaration

    • (logger): Promise<boolean>

    • Parameters

      • logger: Logger

      Returns Promise<boolean>

Optional appInitializationLoader

appInitializationLoader?: ComponentClass<{
    appStatus: AppStatus;
}, any> | FunctionComponent<{
    appStatus: AppStatus;
}>

Component to render while the app is initializing. If the app fails to initialize, this will be displayed forever. Use this to show your app logo or similar while the app is loading.

Optional appName

appName?: string

Name of the app (for use in logging and identification)

Optional blockPages

blockPages?: BlockPage[]

List of pages (as blocks) that make up this template

Optional error500Component

error500Component?: ComponentClass<BlockComponentProps, any> | FunctionComponent<BlockComponentProps>

Component to render when a 500 error occurs (crash)

Optional errorMessageI18nHandler

errorMessageI18nHandler?: ErrorMessageI18nHandler

Translation method for handling error messages

Optional i18nOptions

i18nOptions?: InitOptions<object>

i18n options to use for this template. Can be a blank object if using the default i18n options

Optional logger

logger?: Logger

Logger to use in the application

Optional navigationComponent

navigationComponent?: ComponentClass<NavigationComponentProps, any> | FunctionComponent<NavigationComponentProps>

Component to use for rendering navigation bars and sidebars

Optional notFound404Component

notFound404Component?: ComponentClass<BlockComponentProps, any> | FunctionComponent<BlockComponentProps>

Component to render when 404

Optional pageTitleConfiguration

pageTitleConfiguration?: PageTitleConfiguration

Configuration for the page title

Optional theme

theme?: Theme

Theme to use for this template. Can be a blank object if using the default theme

Optional toastConfiguration

toastConfiguration?: ToastConfiguration

Configuration for app toast messages

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc