API Reference › appui-react› Settings

Settings

Classes and components used by settings pages displayed in the modal settings stage

Classes

Name Description  
AppUiSettings These are the UI settings that are stored in the Redux store. Deprecated

Constants

Name Description  
SettingsManager  

Global Functions

Name Description  
getQuantityFormatsSettingsManagerEntry Return a SettingsTabEntry that can be used to define the available settings that can be set for an application.  
getUiSettingsManagerEntry Return a SettingsTabEntry that can be used to define the available settings that can be set for an application.  
QuantityFormatSettingsPage UI Component shown in settings page to set the active Presentation Unit System and to set format overrides.  
UiSettingsPage UiSettingsPage displaying the active UI settings. Deprecated

Interfaces

Name Description  
InitialAppUiSettings Default values that may be specified for AppUiSettings. Deprecated
QuantityFormatterSettingsOptions Options to initialize the settings page that allows users to set Quantity formatting overrides.  
UnitSystemSelectorProps Props for UnitSystemSelector  

Type Aliases

Name Description  
SettingsManager Settings Manager class.  
SettingsTabEntry Interface used to populate a tab entry in the SettingContainer control  
SettingsTabsProvider Setting Provider interface.  

Last Updated: 07 August, 2024