Home > @datashaper/app-framework
| Enumeration | Description |
|---|---|
| CommandBarSection | |
| ResourceGroupType | |
| ResourceTreeViewMode |
| Function | Description |
|---|---|
| useApplicationSettingsValue() | Return a read-only copy of the application settings. Note that settings are managed in the centralized settings panel. |
| useDataPackage() | |
| useDatasetMenuItems(selected, onClick) | |
| useDataTableSource(pkg) | Use the raw source table from a data package without any workflow applied to it. |
| useHelpOnMount(key) | Request help when a component renders |
| useLoadDataPackage() | Load a datapackage json from a URL |
| useMenuButtonStyles() | |
| useOnOutsideClick(ref, onClickOutside) | Hook that alerts clicks outside of the passed ref |
| usePersistenceService() | |
| useTableBundle(name) | |
| useTableBundleOutput(pkg) | Uses the latest table from a data package. This is update as the package changes |
| useTableBundles() |
| Interface | Description |
|---|---|
| AppProfile | Classes implementing this interface are used to represent the Profile within the app framework. This largely includes user interface elements that build upon the underlying Profile functionality. |
| AppProfileInitializationContext | |
| AppServices | |
| DataShaperAppProps | |
| ProfileComponentProps | |
| RecoilBasedProfileHostProps | |
| ResourceRoute | Data attached to resource-tree nodes |
| ResourceRouteGroup |
| Variable | Description |
|---|---|
| DataShaperApp | A component for rendering a data-shaper application. This includes a resource management UI area and a main area that renders selected content based on its profile type. It is expected that this application is rendered under a react-router Router component. |
| RecoilBasedProfileHost |