SettingsPanelDisplayOptions

View as Markdown

Display options for Settings Panel navigation.

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
enableCollapseViewbooleanWhether users can collapse Settings Panel navigation to an icon railtrue
showModuleDescriptionsbooleanWhether to show Description subtitles under each Module in Settings Panel navigationtrue
showModuleIconsbooleanWhether to show Icons for each Module when navigation is expanded.
Collapsed (icon-rail) navigation always shows icons.
true
showNavigationSearchbooleanWhether to show the module search field above Settings Panel navigationtrue

Property Details

enableCollapseView

Whether users can collapse Settings Panel navigation to an icon rail

TypeScript
enableCollapseView?: boolean;
Default Value

true

Property Value

boolean

showModuleDescriptions

Whether to show Description subtitles under each Module in Settings Panel navigation

TypeScript
showModuleDescriptions?: boolean;
Default Value

true

Property Value

boolean

showModuleIcons

Whether to show Icons for each Module when navigation is expanded. Collapsed (icon-rail) navigation always shows icons.

TypeScript
showModuleIcons?: boolean;
Default Value

true

Property Value

boolean

showNavigationSearch

Whether to show the module search field above Settings Panel navigation

TypeScript
showNavigationSearch?: boolean;
Default Value

true

Property Value

boolean