Home > @activeviam/activeui-sdk > ActiveUIOptions
ActiveUIOptions interface
Options for creating an instance of ActiveUI.
Signature:
export interface ActiveUIOptions
Properties
| Property | Type | Description |
|---|---|---|
| assertAntDesignRootClassOnBody | boolean | Whether ActiveUI-SDK should check that body has the Ant Design root class name. Defaults to true. |
| automaticRestoreStorageType | AutomaticRestoreStorageType | Type of storage used to store last state of the application and restore it at startup |
| contentServerRootFolderName | string | Custom name of the Content Server root folder. |
| defaultSettings | SettingsMap | Settings map that will be merged on top of the default one. |
| enableFullSizeEscapeShortcut | boolean | Enable exiting full-screen mode using the Escape key. |
| enableHistoryKeyboardShortcuts | boolean | Enable global undo/redo keyboard controls: Ctrl+Z/Cmd+Z for undo, Ctrl+Y/Cmd+Y or Ctrl+Shift+Z/Cmd+Shift+Z for redo |
| experimentalFlags | string[] | A list of experimental features to activate in ActiveUI. See the documentation for an exhaustive list of available features. |
| fetchTranslation | FetchTranslation | Takes locale and default "fetch translation" method and returns a promise resolving to the translation data. |
| notifyUncaughtExceptions | boolean | Whether ActiveUI SDK should display an error notification when facing an uncaught exception, or let it propagate. Defaults to true. |
| plugins | Partial<PluginsRegistry> | A map with plugin types as keys. Values are lists of ActiveUIPlugins to be registered. |
| securityType | SerializedPlugin | The serialized authentication holder plugin to use. Refer to the Public Plugins page in the ActiveUI Developer documentation for a list of built-in implementations. |
| state | ApplicationState | Object that will be merged on top of the default initial state. |
| storagePrefix | string | A string that will prefix any item name stored in the browser's localStorage/sessionStorage. Defaults to activeui. |
| supportedLocales | LocaleDescription[] | List of the locales supported by the project. |
| synchronizeLocale | boolean | Set to false to disable server calls to synchronize locale. |