Members
(constant) APP_TOPIC
- Source:
(constant) CONFIG_TOPIC
- Source:
Methods
(async) configureCache() → {Promise}
Async function to configure localforage and setup the cache
- Source:
Returns:
A promise that, when resolved, returns an axios instance configured to use localforage as a cache.
- Type
- Promise
generateMainMessagesFile(processedDirectories, log, writeFileSync, i18nDir`)
Create main src/i18n/index.js
messages import file.
Parameters:
Name | Type | Description |
---|---|---|
processedDirectories |
List of directories with a boolean flag whether its "index.js" file is written The format is "[{ directory: "frontend-component-example", isWritten: false }, ...]" |
|
log |
Mockable process.stdout.write |
|
writeFileSync |
Mockable fs.writeFileSync |
|
i18nDir` |
Path to |
- Source:
generateSubdirectoryMessageFile(directory, log, writeFileSync, i18nDir)
Create frontend-app-example/index.js file with proper imports.
Parameters:
Name | Type | Description |
---|---|---|
directory |
a directory name containing .json files from Transifex e.g. "frontend-app-example". |
|
log |
Mockable process.stdout.write |
|
writeFileSync |
Mockable fs.writeFileSync |
|
i18nDir |
Path to |
- Source:
Returns:
object - An object containing directory name and whether its "index.js" file was successfully written.
Type Definitions
AppConfigWithComponentPropOverrides
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
componentPropOverrides |
ComponentPropOverrides | The component prop overrides configuration. |
- Source:
ComponentPropOverride
Type:
- object
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
key |
string | boolean | Record.<string, any> | function |
<optional> |
The custom prop value. |
- Source:
ComponentPropOverrides
Type:
- object
Properties:
Name | Type | Description |
---|---|---|
targets |
Record.<string, ComponentPropOverride> | A mapping of component targets to custom props. |
- Source:
ComponentPropOverridesOptions
Type:
- object
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
allowedPropNames |
Array.<string> |
<optional> |
["className"] | The list of prop names allowed to be overridden. |
allowsDataAttributes |
boolean |
<optional> |
true | Whether to allow |
- Source:
Events
APP_ANALYTICS_INITIALIZED
Event published when the application initialization sequence has finished initializing the analytics service and executing any analytics handlers.
- Source:
APP_AUTH_INITIALIZED
Event published when the application initialization sequence has finished determining the user's authentication state, creating an authenticated API client, and executing auth handlers.
- Source:
APP_CONFIG_INITIALIZED
Event published when the application initialization sequence has finished loading any dynamic configuration setup in a custom config handler.
- Source:
APP_I18N_INITIALIZED
Event published when the application initialization sequence has finished initializing internationalization and executing any i18n handlers.
- Source:
APP_INIT_ERROR
Event published when the application initialization sequence has aborted. This is frequently used to show an error page when an initialization error has occurred.
- Source:
- See:
-
- {@link module:React~ErrorPage}
APP_LOGGING_INITIALIZED
Event published when the application initialization sequence has finished initializing the logging service and executing any logging handlers.
- Source:
APP_READY
Event published when the application initialization sequence has finished. Applications should subscribe to this event and start rendering the UI when it has fired.
- Source: