Settings

Manager and UI Components that allow users to modify settings for different packages and extensions.

Classes

Name Description  
ActivateSettingsTabEvent Event class for onActivateSettingsTab which is emitted when API call needs to set the active settings tab (ie via Tool key-in). Beta
ProcessSettingsContainerCloseEvent Event class for onProcessSettingsContainerClose which is emitted when the settings container will be closed. Beta
ProcessSettingsTabActivationEvent Event class for onProcessSettingsTabActivation which is emitted when a new Tab needs to be activated. Beta
SettingsManager Settings Manager class. Beta
SettingsProvidersChangedEvent Event class for onSettingsProvidersChanged which is emitted when a new SettingsProvider is added or removed. Beta

Global Functions

Name Description  
SettingsContainer SettingsContainer component that displays Setting Tabs on Left and the P Beta
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. Beta
useSaveBeforeClosingSettingsContainer Hook to use within Settings Page component to allow saving the current page's data before the Setting Container is closed. Beta

Interfaces

Name Description  
ActivateSettingsTabEventArgs Arguments of onActivateSettingsTab event. Beta
ProcessSettingsContainerCloseEventArgs Arguments of onProcessSettingsContainerClose event. Beta
ProcessSettingsTabActivationEventArgs Arguments of onProcessSettingsTabActivation event. Beta
SettingsContainerProps Beta
SettingsProvider Setting Provider interface. Beta
SettingsProvidersChangedEventArgs Arguments of onSettingsProvidersChanged event. Beta
SettingsTabEntry Interface used to populate a tab entry in the SettingContainer control @beta  

Last Updated: 02 April, 2021