UserSettingsDialog

<ui5-user-settings-dialog> | Since 2.8.0

The ui5-user-settings-dialog is an SAP Fiori-specific web component used in the ui5-user-menu. It allows the user to easily view information and settings for an account.

ES6 Module Import

import "@ui5/webcomponents-fiori/dist/UserSettingsDialog.js";

Basic Sample

Properties

headerText

Description	Defines the headerText of the item.
Type	string | undefined
Default	undefined

open

Description	Defines, if the User Settings Dialog is opened.
Type	boolean
Default	false

showSearchField

Description	Defines if the Search Field would be displayed. Note: By default the Search Field is not displayed.
Type	boolean
Default	false

Slots

default

Description	Defines the user settings items. Note: If no setting item is set as selected, the first one will be selected.
Type	Array<UserSettingsItem>

fixedItems

Description	Defines the fixed user settings items.
Type	Array<UserSettingsItem>

Events

before-close

Description	Fired before the settings dialog is closed.
Type	CustomEvent
Bubbles	No
Cancelable	Yes - via preventDefault()

close

Description	Fired when a settings dialog is closed.
Type	CustomEvent
Bubbles	No
Cancelable	No

open

Description	Fired when a settings dialog is open.
Type	CustomEvent
Bubbles	No
Cancelable	No

selection-change

Description	Fired when an item is selected.
Type	CustomEvent<UserSettingsItemSelectEventDetail>
Parameters	item: UserSettingsItem The selected user settings item.
Bubbles	No
Cancelable	Yes - via preventDefault()

Methods

No methods available for this component.

CSS Parts

No CSS parts available for this component.

CSS Custom States

No CSS custom states available for this component.