Skip to main content

SegmentedButtonItem

Users can use the ui5-segmented-button-item as part of a ui5-segmented-button.

Clicking or tapping on a ui5-segmented-button-item changes its state to pressed. The item returns to its initial state when the user clicks or taps on it again. By applying additional custom CSS-styling classes, apps can give a different style to any ui5-segmented-button-item.

ES6 Module Import​

import "@ui5/webcomponents/dist/SegmentedButtonItem.js";

Properties​

design​

DescriptionNote: The property is inherited and not supported. If set, it won't take any effect.
Type"Default" | "Positive" | "Negative" | "Transparent" | "Emphasized" | "Attention"
Default"Default"

iconEnd​

DescriptionNote: The property is inherited and not supported. If set, it won't take any effect.
Typeboolean
Defaultfalse

submits​

DescriptionNote: The property is inherited and not supported. If set, it won't take any effect.
Typeboolean
Defaultfalse
DeprecatedSet the "type" property to "Submit" to achieve the same result. The "submits" property is ignored if "type" is set to any value other than "Button".

accessibilityAttributes​

DescriptionNote: The property is inherited and not supported. If set, it won't take any effect.
TypeAccessibilityAttributes
Default

type​

DescriptionNote: The property is inherited and not supported. If set, it won't take any effect.
Type"Button" | "Submit" | "Reset"
Default"Button"

accessibleRole​

DescriptionNote: The property is inherited and not supported. If set, it won't take any effect.
Type"Button" | "Link"
Default"Button"

pressed​

DescriptionDetermines whether the component is displayed as pressed.
Typeboolean
Defaultfalse

disabled​

DescriptionDefines whether the component is disabled. A disabled component can't be pressed or focused, and it is not in the tab chain.
Typeboolean
Defaultfalse

icon​

DescriptionDefines the icon, displayed as graphical element within the component. The SAP-icons font provides numerous options.
Example: See all the available icons within the Icon Explorer.
Typestring
Default""

tooltip​

DescriptionDefines the tooltip of the component.
Note: A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function.
Typestring
Default""
Since1.2.0

accessibleName​

DescriptionDefines the accessible ARIA name of the component.
Typestring | undefined
Defaultundefined
Since1.0.0-rc.15

accessibleNameRef​

DescriptionReceives id(or many ids) of the elements that label the component.
Typestring
Default""
Since1.1.0

Slots​

default​

DescriptionDefines the text of the component.
Note: Although this slot accepts HTML Elements, it is strongly recommended that you only use text in order to preserve the intended design.
TypeArray<Node>

Events​

click​

DescriptionFired when the component is activated either with a mouse/tap or by using the Enter or Space key.
Note: The event will not be fired if the disabled property is set to true.
TypeEvent

Methods​

No methods available for this component.

CSS Parts​

NameDescription
buttonUsed to style the native button element