mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-15 01:41:20 +08:00
5b817d3008
* feat(components): [slider] placement feat: add fallback placements feat: rename tooltip-placement refactor: test code docs: add placement attribute docs: prettier * docs: example placement
119 lines
8.8 KiB
Markdown
119 lines
8.8 KiB
Markdown
---
|
||
title: Slider
|
||
lang: en-US
|
||
---
|
||
|
||
# Slider
|
||
|
||
Drag the slider within a fixed range.
|
||
|
||
## Basic usage
|
||
|
||
The current value is displayed when the slider is being dragged.
|
||
|
||
:::demo Customize the initial value of the slider by setting the binding value.
|
||
|
||
slider/basic-usage
|
||
|
||
:::
|
||
|
||
## Discrete values
|
||
|
||
The options can be discrete.
|
||
|
||
:::demo Set step size with the `step` attribute. You can display breakpoints by setting the `show-stops` attribute.
|
||
|
||
slider/discrete-values
|
||
|
||
:::
|
||
|
||
## Slider with input box
|
||
|
||
Set value via a input box.
|
||
|
||
:::demo Set the `show-input` attribute to display an input box on the right.
|
||
|
||
slider/slider-with-input-box
|
||
|
||
:::
|
||
|
||
## Sizes
|
||
|
||
:::demo
|
||
|
||
slider/sizes
|
||
|
||
:::
|
||
|
||
## Placement
|
||
|
||
You can custom tooltip placement.
|
||
|
||
:::demo
|
||
|
||
slider/placement
|
||
|
||
:::
|
||
|
||
## Range selection
|
||
|
||
Selecting a range of values is supported.
|
||
|
||
:::demo Setting the `range` attribute activates range mode, where the binding value is an array made up of two boundary values.
|
||
|
||
slider/range-selection
|
||
|
||
:::
|
||
|
||
## Vertical mode
|
||
|
||
:::demo Setting the `vertical` attribute to `true` enables vertical mode. In vertical mode, the `height` attribute is required.
|
||
|
||
slider/vertical-mode
|
||
|
||
:::
|
||
|
||
## Show marks
|
||
|
||
:::demo Setting this `marks` attribute can show mark on slider.
|
||
|
||
slider/show-marks
|
||
|
||
:::
|
||
|
||
## Attributes
|
||
|
||
| Attribute | Description | Type | Accepted Values | Default |
|
||
| --------------------- | --------------------------------------------------------------------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------- | ------- |
|
||
| model-value / v-model | binding value | number | — | 0 |
|
||
| min | minimum value | number | — | 0 |
|
||
| max | maximum value | number | — | 100 |
|
||
| disabled | whether Slider is disabled | boolean | — | false |
|
||
| step | step size | number | — | 1 |
|
||
| show-input | whether to display an input box, works when `range` is false | boolean | — | false |
|
||
| show-input-controls | whether to display control buttons when `show-input` is true | boolean | — | true |
|
||
| size | size of the slider | string | large / default / small | default |
|
||
| input-size | size of the input box, when set `size`, the default is the value of `size` | string | large / default / small | default |
|
||
| show-stops | whether to display breakpoints | boolean | — | false |
|
||
| show-tooltip | whether to display tooltip value | boolean | — | true |
|
||
| format-tooltip | format to display tooltip value | function(value) | — | — |
|
||
| range | whether to select a range | boolean | — | false |
|
||
| vertical | vertical mode | boolean | — | false |
|
||
| height | Slider height, required in vertical mode | string | — | — |
|
||
| label | label for screen reader | string | — | — |
|
||
| range-start-label | when `range` is true, screen reader label for the start of the range | string | — | — |
|
||
| range-end-label | when `range` is true, screen reader label for the end of the range | string | — | — |
|
||
| format-value-text | format to display the `aria-valuenow` attribute for screen readers | function(value) | — | — |
|
||
| debounce | debounce delay when typing, in milliseconds, works when `show-input` is true | number | — | 300 |
|
||
| tooltip-class | custom class name for the tooltip | string | — | — |
|
||
| placement | position of Tooltip | string | top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end | top |
|
||
| marks | marks， type of key must be `number` and must in closed interval `[min, max]`, each mark can custom style | object | — | — |
|
||
| validate-event | whether to trigger form validation | boolean | - | true |
|
||
|
||
## Events
|
||
|
||
| Event Name | Description | Parameters |
|
||
| ---------- | ----------------------------------------------------------------------------------------------------------------- | -------------------- |
|
||
| change | triggers when the value changes (if the mouse is being dragged, this event only fires when the mouse is released) | value after changing |
|
||
| input | triggers when the data changes (It'll be emitted in real time during sliding) | value after changing |
|