API Reference › core-react› Settings

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.  
SettingsProvidersChangedEvent Event class for this.onSettingsProvidersChanged which is emitted when a new SettingsTabsProvider is added or removed. Deprecated

Global Functions

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

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  
SettingsProvidersChangedEventArgs Arguments of this.onSettingsProvidersChanged event. Deprecated
SettingsTabEntry Interface used to populate a tab entry in the SettingContainer control  
SettingsTabsProvider Setting Provider interface.  

Last Updated: 13 May, 2024