UNPKG

@kelvininc/ui-components

Version:
78 lines (57 loc) 4.65 kB
<!-- Auto Generated Below --> ## Usage ### React import React from 'react'; import { KvRange } from '@kelvininc/react-ui-components'; export const KvRangeExample: React.FC = () => ( <> <KvRange min={0} max={100} step={1} value={0} /> </> ); ## Properties | Property | Attribute | Description | Type | Default | | ----------------- | -------------------- | ---------------------------------- | --------------------------- | ----------- | | `disabled` | `disabled` | (optional) Range input disabled | `boolean` | `false` | | `hideLabel` | `hide-label` | (optional) Hide value label | `boolean` | `false` | | `hideMinMaxLabel` | `hide-min-max-label` | (optional) Hide min and max labels | `boolean` | `false` | | `max` | `max` | (required) Range maximum value | `number` | `undefined` | | `maxLabel` | `max-label` | (optional) Max label | `string` | `undefined` | | `min` | `min` | (required) Range minimum value | `number` | `undefined` | | `minLabel` | `min-label` | (optional) Min label | `string` | `undefined` | | `step` | `step` | (optional) Range value step | `number` | `1` | | `value` | `value` | (optional) Range value | `number` | `0` | | `valueFormatter` | `value-formatter` | (optional) Range value formatter | `(value: number) => string` | `identity` | ## Events | Event | Description | Type | | ------------- | ------------------------------ | --------------------- | | `valueChange` | Emitted when the value changes | `CustomEvent<number>` | ## CSS Custom Properties | Name | Description | | ------------------------------------- | ---------------------------------------------- | | `--range-height` | Height of the range slider | | `--range-height` | Height of the range slider | | `--range-label-color` | range labels color | | `--range-label-color` | range labels color | | `--range-margin-top` | Margin top of the range slider | | `--range-margin-top` | Margin top of the range slider | | `--range-selector-border-radius` | Border radius of the range thumb | | `--range-selector-border-radius` | Border radius of the range thumb | | `--range-selector-radius` | Radius of the range thumb | | `--range-selector-radius` | Radius of the range thumb | | `--range-width` | Width of the range slider | | `--range-width` | Width of the range slider | | `--select-label-color` | select labels color | | `--select-label-color` | select labels color | | `--select-label-disabled-color` | disabled select labels color | | `--select-label-disabled-color` | disabled select labels color | | `--slider-background-empty` | color of the slider when its empty | | `--slider-background-empty` | color of the slider when its empty | | `--slider-background-filled` | color of the slider when its full | | `--slider-background-filled` | color of the slider when its full | | `--slider-background-filled-disabled` | color of the slider when its disabled and full | | `--slider-background-filled-disabled` | color of the slider when its disabled and full | | `--thumb-background-color` | thumb background color | | `--thumb-background-color` | thumb background color | | `--thumb-border-color` | thumb border color | | `--thumb-border-color` | thumb border color | ----------------------------------------------