Settings
Manager and UI Components that allow users to modify settings for different packages and extensions.
Classes
| Name | Description | |
|---|---|---|
| ActivateSettingsTabEvent | Event class for this.onActivateSettingsTab which is emitted when API call needs to set the active settings tab (ie via Tool key-in). | Deprecated |
| ProcessSettingsContainerCloseEvent | Event class for this.onProcessSettingsContainerClose which is emitted when the settings container will be closed. | Deprecated |
| ProcessSettingsTabActivationEvent | Event class for this.onProcessSettingsTabActivation which is emitted when a new Tab needs to be activated. | Deprecated |
| SettingsManager | Settings Manager class. | Deprecated |
| SettingsProvidersChangedEvent | Event class for this.onSettingsProvidersChanged which is emitted when a new SettingsTabsProvider is added or removed. | Deprecated |
Global Functions
| Name | Description | |
|---|---|---|
| SettingsContainer | Component that displays setting tabs on the left and the setting page on the right. | Deprecated |
| useSaveBeforeActivatingNewSettingsTab | Hook to use within Settings Page component to allow saving the current page's data before loading to the requested Setting Tab's page. | Deprecated |
| useSaveBeforeClosingSettingsContainer | Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed. | Deprecated |
Interfaces
| Name | Description | |
|---|---|---|
| ActivateSettingsTabEventArgs | Arguments of this.onActivateSettingsTab event. | Deprecated |
| ProcessSettingsContainerCloseEventArgs | Arguments of this.onProcessSettingsContainerClose event. | Deprecated |
| ProcessSettingsTabActivationEventArgs | Arguments of this.onProcessSettingsTabActivation event. | Deprecated |
| SettingsContainerProps | Properties of SettingsContainer component. | Deprecated |
| SettingsProvidersChangedEventArgs | Arguments of this.onSettingsProvidersChanged event. | Deprecated |
| SettingsTabEntry | Interface used to populate a tab entry in the SettingContainer control | Deprecated |
| SettingsTabsProvider | Setting Provider interface. | Deprecated |
Last Updated: 08 August, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.