|
1 | 1 | ---
|
2 | 2 | title: Slider
|
| 3 | +description: UI component for picking numeric values from a range. |
| 4 | +contributors: |
| 5 | + - rigor789 |
| 6 | + - Ombuweb |
3 | 7 | ---
|
4 | 8 |
|
5 |
| -<!-- TODO: Add flavors --> |
6 |
| - |
7 | 9 | `<Slider>` is a UI component that provides a slider control for picking values within a specified numeric range.
|
8 | 10 |
|
9 |
| ---- |
10 |
| - |
11 | 11 | <DeviceFrame type="ios">
|
12 |
| -<img src="https://raw.githubusercontent.com/nativescript-vue/nativescript-vue-ui-tests/master/screenshots/ios-simulator103iPhone6/Slider.png"/> |
| 12 | +<img src="../screenshots/ios/Slider.png"/> |
13 | 13 | </DeviceFrame>
|
14 | 14 | <DeviceFrame type="android">
|
15 |
| -<img src="https://raw.githubusercontent.com/nativescript-vue/nativescript-vue-ui-tests/master/screenshots/android23/Slider.png" /> |
| 15 | +<img src="../screenshots/android/Slider.png"/> |
16 | 16 | </DeviceFrame>
|
17 | 17 |
|
18 |
| -### Simple Slider and listening to its value change event |
19 |
| - |
20 |
| -<!-- /// flavor plain --> |
21 |
| - |
22 |
| -To listen to the `valueChange` event, register the listener in the Slider's `loaded` event handler. |
23 |
| - |
24 |
| -<!-- Is the preceeding phrase accurate --> |
25 |
| - |
26 |
| -```xml |
27 |
| -<Slider value="10" minValue="0" maxValue="100" loaded="{{ onSliderLoaded }}" /> |
28 |
| -``` |
29 |
| - |
30 |
| -```ts |
31 |
| -import { Observable, Slider } from '@nativescript/core' |
32 |
| - |
33 |
| -export class HelloWorldModel extends Observable { |
34 |
| - constructor() { |
35 |
| - super() |
36 |
| - } |
37 |
| - onSliderLoaded(args: EventData) { |
38 |
| - const slider = args.object as Slider |
39 |
| - |
40 |
| - slider.on('valueChange', (args: PropertyChangeData) => { |
41 |
| - console.log('valueChange: ', args.value, 'Old: ' + args.oldValue) |
42 |
| - }) |
43 |
| - } |
44 |
| -} |
45 |
| -``` |
46 |
| - |
47 |
| -<!-- /// |
48 |
| -
|
49 |
| -/// flavor angular |
50 |
| -
|
51 |
| -```xml |
52 |
| -<Slider |
53 |
| - value="10" |
54 |
| - minValue="0" |
55 |
| - maxValue="100" |
56 |
| - (valueChange)="onSliderValueChange($event)" |
57 |
| -> |
58 |
| -</Slider> |
59 |
| -``` |
60 |
| -
|
61 |
| -```ts |
62 |
| -import { Component } from '@angular/core' |
63 |
| -import { Slider } from '@nativescript/core' |
64 |
| -
|
65 |
| -@Component({ |
66 |
| - moduleId: module.id, |
67 |
| - templateUrl: './usage.component.html' |
68 |
| -}) |
69 |
| -export class UsageComponent { |
70 |
| - onSliderValueChange(args) { |
71 |
| - const slider = args.object as Slider |
72 |
| - console.log(`Slider new value ${args.value}`) |
73 |
| - } |
74 |
| -} |
75 |
| -``` |
76 |
| -
|
77 |
| -/// |
78 |
| -
|
79 |
| -/// flavor vue |
80 |
| -
|
81 |
| -```xml |
82 |
| -<Slider value="80" @valueChange="onValueChanged" /> |
83 |
| -``` |
84 |
| -
|
85 |
| -`<Slider>` provides two-way data binding using `v-model`: |
86 |
| -
|
87 |
| -```xml |
88 |
| -<Slider v-model="value" /> |
89 |
| -``` |
90 |
| -
|
91 |
| -/// |
92 |
| -
|
93 |
| -/// flavor svelte |
94 |
| -
|
95 |
| -```tsx |
96 |
| -<slider value="80" on:valueChange="{onValueChanged}" /> |
97 |
| -``` |
98 |
| -
|
99 |
| -`<slider>` provides two-way data binding of `value`: |
100 |
| -
|
101 |
| -```xml |
102 |
| -<slider bind:value="{value}" /> |
103 |
| -``` |
104 |
| -
|
105 |
| -/// |
106 |
| -
|
107 |
| -/// flavor react |
108 |
| -
|
109 |
| -```tsx |
110 |
| -<slider value={0} onValueChange={onValueChange} /> |
111 |
| -``` |
112 |
| -
|
113 |
| -/// --> |
| 18 | +<<< @/../examples/src/ui/Slider/template.xml#example |
114 | 19 |
|
115 | 20 | ## Props
|
116 | 21 |
|
117 | 22 | ### value
|
118 | 23 |
|
119 |
| -```xml |
120 |
| -<Slider value="10" /> |
| 24 | +```ts |
| 25 | +value: number |
121 | 26 | ```
|
122 | 27 |
|
123 |
| -Gets or sets the currently selected value of the slider. Defaults to `0`. |
| 28 | +Gets or sets the currently selected value of the slider. |
124 | 29 |
|
125 |
| ---- |
| 30 | +Defaults to `0`. |
126 | 31 |
|
127 | 32 | ### minValue
|
128 | 33 |
|
129 |
| -```xml |
130 |
| -<Slider minValue="0" /> |
| 34 | +```ts |
| 35 | +minValue: number |
131 | 36 | ```
|
132 | 37 |
|
133 | 38 | Gets or sets the minimum value of the slider.
|
134 | 39 |
|
135 |
| ---- |
136 |
| - |
137 | 40 | ### maxValue
|
138 | 41 |
|
139 |
| -```xml |
140 |
| -<Slider maxValue="100"/> |
| 42 | +```ts |
| 43 | +maxValue: number |
141 | 44 | ```
|
142 | 45 |
|
143 | 46 | Gets or sets the maximum value of the slider.
|
144 | 47 |
|
145 |
| ---- |
146 |
| - |
147 | 48 | ### ...Inherited
|
148 | 49 |
|
149 |
| -For additional inherited properties, refer to the [API Reference](https://docs.nativescript.org/api-reference/classes/slider). |
| 50 | +For additional inherited properties, refer to the [API Reference](/api/class/Slider). |
150 | 51 |
|
151 | 52 | ## Events
|
152 | 53 |
|
153 | 54 | ### valueChange
|
154 | 55 |
|
155 | 56 | ```ts
|
156 |
| -slider.on('valueChange', (args: PropertyChangeData) => { |
157 |
| - console.log('valueChange: ', args.value, 'Old: ' + args.oldValue) |
| 57 | +on('valueChange', (args: PropertyChangeData) => { |
| 58 | + const slider = args.object as Slider |
| 59 | + console.log('Slider value changed to', args.value) |
158 | 60 | })
|
159 | 61 | ```
|
160 | 62 |
|
161 |
| -Emitted when the value of the slider changes. See [PropertyChangeData](https://docs.nativescript.org/api-reference/interfaces/propertychangedata) interface for available data. |
| 63 | +Emitted when the value of the slider changes. |
162 | 64 |
|
163 |
| ---- |
| 65 | +See [PropertyChangeData](/api/interface/PropertyChangeData). |
164 | 66 |
|
165 | 67 | ## Native component
|
166 | 68 |
|
|
0 commit comments