F2.AppConfig Class
The AppConfig object represents an app's meta data
src\classes\appConfig.js:1
Properties
| Name | Description |
|---|---|
| appId | The unique ID of the app. More information can be found here |
| containerLocale | The language and region specification for this container
represented as an IETF-defined standard language tag,
e.g. |
| context | An object that represents the context of an app |
| enableBatchRequests | True if the app should be requested in a single request with other apps. |
| height | The height of the app. The initial height will be pulled from the F2.AppConfig object |
| instanceId | The unique runtime ID of the app. This property is populated during the F2.registerApps process |
| localeSupport | The languages and regions supported by this app represented
as an array of IETF-defined standard language tags,
e.g. |
| manifestUrl | The url to retrieve the F2.AppManifest object. |
| maxWidth | The recommended maximum width in pixels that this app should be run. It is up to the container to implement the logic to prevent an app from being run when the maxWidth requirements are not met. |
| minGridSize | The recommended minimum grid size that this app should be run. This value corresponds to the 12-grid system that is used by the container. This property should be set by apps that require a certain number of columns in their layout. |
| minWidth | The recommended minimum width in pixels that this app should be run. **It is up to the container to implement the logic to prevent an app from being run when the minWidth requirements are not met. |
| name | The name of the app |
| root | The root DOM element that contains the app This property is populated during the F2.registerApps process |
Properties
containerLocale String
The language and region specification for this container
represented as an IETF-defined standard language tag,
e.g. "en-us" or "de-de". This is passed during the
F2.registerApps process.
Default: null
context Object
An object that represents the context of an app
enableBatchRequests Bool
True if the app should be requested in a single request with other apps.
Default: false
instanceId String
The unique runtime ID of the app.
This property is populated during the F2.registerApps process
localeSupport Array
The languages and regions supported by this app represented
as an array of IETF-defined standard language tags,
e.g. ["en-us","de-de"].
Default: []
maxWidth Int
The recommended maximum width in pixels that this app should be run. It is up to the container to implement the logic to prevent an app from being run when the maxWidth requirements are not met.
minGridSize Int
The recommended minimum grid size that this app should be run. This value corresponds to the 12-grid system that is used by the container. This property should be set by apps that require a certain number of columns in their layout.
Default: 4
minWidth Int
The recommended minimum width in pixels that this app should be run. **It is up to the container to implement the logic to prevent an app from being run when the minWidth requirements are not met.
Default: 300
name String
The name of the app
root Element
The root DOM element that contains the app
This property is populated during the F2.registerApps process