Home > @datashaper/app-framework > DataShaperAppProps
Signature:
export interface DataShaperAppProps<T = unknown> | Property | Modifiers | Type | Description |
|---|---|---|---|
| appContext? | T | (Optional) Apps may supply an arbitrary context object that will be passed down to resources. This provides a seam for injecting app-specific functionality into resources such as async pre-load setup. NOTE: in the future this should be replaced by a dependency injection system. | |
| children | React.ReactNode | The child node to render as the "Front Page" of the app. This is the default view when no resource is selected | |
| className? | string | (Optional) CSS Classname | |
| defaultHelp? | string | (Optional) Indicates the help content to show when the application has no resources selected. | |
| defaultResourceTreeViewMode? | ResourceTreeViewMode | (Optional) The default view mode to use on load | |
| defaultSettings? | unknown | (Optional) Object of user-definable application-level settings. | |
| examples? | FileDefinition[] | (Optional) Examples to provide | |
| fallback? | React.ReactNode | (Optional) The React node to render when the selected resource cannot be found | |
| initialDataPackageUrl? | string | (Optional) The initial data-package URL to load (useful for demos) | |
| initialRoute? | string | (Optional) The initial route to load (useful for demos). Resources are routed under /resource/{resource.name} |
|
| profiles? | AppProfile[] | (Optional) Custom profile renderers |