What does the component do?
A slider allows users to adjust a value or selection within a specified range by dragging a slider.
When should the component be used?
- To provide users with a simple and intuitive way to adjust values within a certain range.
- When a precise or quick adjustment of a value is required.
- To save space on the user interface by using an interactive control.
Rules
- Use labels and icons to make the value range of the slider clear.
- The slider should only be used for simple value ranges (from/to, fast/slow, heavy/light).
- The slider should not be used to indicate the progress of a process or operation.
- The slider should provide visual feedback when the value is changed, e.g. by displaying the current value next to the slider.
| Number | Type | Description | Optional | Info |
|---|---|---|---|---|
| 1 | Component | sbb-icon | Yes | Prefix |
| 2 | Component | Slider | No | |
| 1 | Component | sbb-icon | Yes | Suffix |
Playground
The sbb-slider is an input component that allows for the selection of a value within a range.
This can be set using the min and max properties (default values are 0 and 100),
while the initial value can be set using the value property (string), or the valueAsNumber (number).
If no value is provided, by default it is set halfway between the minimum and maximum.
<sbb-slider max="5" min="1"></sbb-slider>
<sbb-slider value="0"></sbb-slider>
In sbb-form-field
The component can be used within a sbb-form-field component.
<sbb-form-field>
<label>Slider</label>
<sbb-slider value="0"></sbb-slider>
</sbb-form-field>
Slots
The component can optionally display two sbb-icons at either end;
consumers could set one/both of them using the startIcon and endIcon properties,
or can provide their own using the two slots named prefix and suffix.
<sbb-slider start-icon="circle-minus-small" end-icon="circle-plus-small"></sbb-slider>
<sbb-slider>
<sbb-icon slot="prefix" name="battery-level-empty-small"></sbb-icon>
<sbb-icon slot="suffix" name="battery-level-high-small"></sbb-icon>
</sbb-slider>
States
It is possible to display the component in disabled or readonly state by using the self-named properties.
<sbb-slider disabled></sbb-slider>
<sbb-slider readonly></sbb-slider>
Events
Consumers can listen to the native change event on the sbb-slider component to intercept the input's change event;
the current value can be read from event.target.value or event.target.valueAsNumber.
Keyboard interaction
The sbb-slider has the following behaviour on keypress when focused:
| Key | Action |
|---|---|
| Right arrow | Increment the slider value by one (or one step). |
| Up arrow | Increment the slider value by one (or one step). |
| Left arrow | Decrement the slider value by one (or one step). |
| Down arrow | Decrement the slider value by one (or one step). |
| Page up | Increment the slider value by ten (or ten steps). |
| Page down | Decrement the slider value by ten (or ten steps). |
| End | Set the value to the maximum. |
| Home | Set the value to the minimum. |
Properties
| Name | Attribute | Privacy | Type | Default | Description |
|---|---|---|---|---|---|
disabled | disabled | public | boolean | false | Whether the component is disabled. |
endIcon | end-icon | public | string | undefined | Name of the icon at component's end, which will be forward to the nested sbb-icon. | |
form | form | public | string | undefined | The | |
max | max | public | string | undefined | '100' | Maximum acceptable value for the inner HTMLInputElement. |
min | min | public | string | undefined | '0' | Minimum acceptable value for the inner HTMLInputElement. |
name | name | public | string | undefined | '' | Name of the inner HTMLInputElement. |
readonly | readonly | public | boolean | undefined | false | Readonly state for the inner HTMLInputElement. Since the input range does not allow this attribute, it will be merged with the disabled one. |
startIcon | start-icon | public | string | undefined | Name of the icon at component's start, which will be forward to the nested sbb-icon. | |
value | value | public | string | undefined | '' | Value for the inner HTMLInputElement. |
valueAsNumber | value-as-number | public | number | undefined | Numeric value for the inner HTMLInputElement. |
Events
| Name | Type | Description | Inherited From |
|---|---|---|---|
didChange | CustomEvent<void> | Deprecated. used for React. Will probably be removed once React 19 is available. | |
input | InputEvent |
Slots
| Name | Description |
|---|---|
prefix | Use this slot to render an icon on the left side of the input. |
suffix | Use this slot to render an icon on the right side of the input. |