UNPKG

@ui5/webcomponents-react

Version:

React Wrapper for UI5 Web Components and additional components

73 lines (72 loc) 3.14 kB
import '@ui5/webcomponents/dist/SegmentedButtonItem.js'; import type { ReactNode } from 'react'; import type { CommonProps, Ui5DomRef } from '../../types/index.js'; interface SegmentedButtonItemAttributes { /** * Defines the accessible ARIA name of the component. * @default undefined */ accessibleName?: string | undefined; /** * Receives id(or many ids) of the elements that label the component. * * **Note:** Available since [v1.1.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.1.0) of **@ui5/webcomponents**. * @default undefined */ accessibleNameRef?: string | undefined; /** * Defines whether the component is disabled. * A disabled component can't be selected or * focused, and it is not in the tab chain. * @default false */ disabled?: boolean; /** * Defines 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](https://sdk.openui5.org/test-resources/sap/m/demokit/iconExplorer/webapp/index.html). * @default undefined */ icon?: string | undefined; /** * Determines whether the component is displayed as selected. * @default false */ selected?: boolean; /** * Defines the tooltip of the component. * * **Note:** A tooltip attribute should be provided for icon-only buttons, in order to represent their exact meaning/function. * * **Note:** Available since [v1.2.0](https://github.com/SAP/ui5-webcomponents/releases/tag/v1.2.0) of **@ui5/webcomponents**. * @default undefined */ tooltip?: string | undefined; } interface SegmentedButtonItemDomRef extends Required<SegmentedButtonItemAttributes>, Ui5DomRef { } interface SegmentedButtonItemPropTypes extends SegmentedButtonItemAttributes, Omit<CommonProps, keyof SegmentedButtonItemAttributes | 'children'> { /** * Defines 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. */ children?: ReactNode | ReactNode[]; } /** * Users can use the `SegmentedButtonItem` as part of a `SegmentedButton`. * * Clicking or tapping on a `SegmentedButtonItem` changes its state to `selected`. * 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 * `SegmentedButtonItem`. * * * * __Note__: This is a UI5 Web Component! [Repository](https://github.com/SAP/ui5-webcomponents) | [Documentation](https://sap.github.io/ui5-webcomponents/) */ declare const SegmentedButtonItem: import("react").ForwardRefExoticComponent<SegmentedButtonItemPropTypes & import("../../internal/withWebComponent.js").WithWebComponentPropTypes & import("react").RefAttributes<SegmentedButtonItemDomRef>>; export { SegmentedButtonItem }; export type { SegmentedButtonItemDomRef, SegmentedButtonItemPropTypes };