UNPKG

@kelvininc/ui-components

Version:
70 lines (46 loc) 2.61 kB
<!-- Auto Generated Below --> ## Usage ### React ```tsx import React from 'react'; import { KvTimePickerSelectOption } from '@kelvininc/react-ui-components/client'; export const KvTimePickerSelectOptionExample: React.FC = () => ( <> {/*-- With all properties (only label and value are mandatory) --*/} <KvTimePickerSelectOption label="Option 1" link="option1" selected={false} > </KvTimePickerSelectOption> </> ); ``` ## Properties | Property | Attribute | Description | Type | Default | | -------------------- | ------------------- | -------------------------------------------------------------------------- | -------------------------- | ----------- | | `customAttributes` | `custom-attributes` | (optional) Custom attributes to be applied to the option container element | `{ [x: string]: string; }` | `{}` | | `description` | `description` | (optional) The description of the text displayed | `string` | `undefined` | | `label` _(required)_ | `label` | (required) The text to display on the item | `string` | `undefined` | | `selected` | `selected` | (optional) If `true` the item is selected | `boolean` | `false` | | `value` _(required)_ | `value` | (required) The item value | `string` | `undefined` | ## Events | Event | Description | Type | | -------------- | ---------------------------------------- | --------------------- | | `itemSelected` | Emitted when the user clicks on the item | `CustomEvent<string>` | ## CSS Custom Properties | Name | Description | | ---------------------------------------------- | --------------------- | | `--time-picker-select-option-background-color` | Background color. | | `--time-picker-select-option-height` | Select option height. | | `--time-picker-select-option-padding` | Select padding. | ## Dependencies ### Used by - [kv-relative-time-picker](../relative-time-picker) ### Graph ```mermaid graph TD; kv-relative-time-picker --> kv-time-picker-select-option style kv-time-picker-select-option fill:#f9f,stroke:#333,stroke-width:4px ``` ----------------------------------------------