UserSettingsItem

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

info

The following entity is available under an experimental flag and its API and behavior are subject to change.

The ui5-user-settings-item represents an item in the ui5-user-settings-dialog.

ES6 Module Import

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

You can disable the UserSettingsItem by setting the enabled property to false, or use the UserSettingsItem in read-only mode by setting the editable property to false.

Note: Disabled and read-only states shouldn't be used together.

Properties

text

Description	Defines the text of the user settings item.
Type	string
Default	""

tooltip

Description	Defines the tooltip of the component. A tooltip attribute should be provided to represent the meaning or function when the component is collapsed and only the icon is visible.
Type	string
Default	""

headerText

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

selected

Description	Shows item tab.
Type	boolean
Default	false

disabled

Description	Defines whether the component is in disabled state. Note: A disabled component is completely noninteractive.
Type	boolean
Default	false

loading

Description	Indicates whether a loading indicator should be shown.
Type	boolean
Default	false

loadingReason

Description	Indicates why the control is in loading state.
Type	string | undefined
Default	undefined

icon

Description	Defines the icon of the component.
Type	string
Default	"globe"

accessibleName

Description	Defines the accessible ARIA name of the component.
Type	string | undefined
Default	undefined

Slots

default

Description	Defines the tab views of the user settings item. The tab views are displayed by default if there is no selected page view.
Type	Array<UserSettingsView>

pages

Description	Defines the page views of the user settings item. If there are no tab views, the first page view will be shown unless there is selected one. If there is selected page view it will be shown no matter if there are tab views.
Type	Array<UserSettingsView>

Events

selection-change

Description	Fired when a selected view changed.
Type	CustomEvent<UserSettingsItemViewSelectEventDetail>
Parameters	view: UserSettingsView The selected view.
Bubbles	No
Cancelable	Yes - via preventDefault()

Methods

No methods available for this component.

CSS Parts

No CSS parts available for this component.