Skip to content

Commit 99ae841

Browse files
committed
docs: cleanup Slider
1 parent ed699c0 commit 99ae841

File tree

6 files changed

+34
-119
lines changed

6 files changed

+34
-119
lines changed
16.6 KB
Loading

content/screenshots/ios/Slider.png

60.6 KB
Loading

content/ui/segmentedbar.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
---
22
title: SegmentedBar
33
description: UI component for discrete slection.
4+
contributors:
5+
- rigor789
6+
- Ombuweb
47
---
58

69
`<SegmentedBar>` is a UI bar component that displays a set of buttons for discrete selection.

content/ui/slider.md

Lines changed: 21 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -1,166 +1,68 @@
11
---
22
title: Slider
3+
description: UI component for picking numeric values from a range.
4+
contributors:
5+
- rigor789
6+
- Ombuweb
37
---
48

5-
<!-- TODO: Add flavors -->
6-
79
`<Slider>` is a UI component that provides a slider control for picking values within a specified numeric range.
810

9-
---
10-
1111
<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"/>
1313
</DeviceFrame>
1414
<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"/>
1616
</DeviceFrame>
1717

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
11419

11520
## Props
11621

11722
### value
11823

119-
```xml
120-
<Slider value="10" />
24+
```ts
25+
value: number
12126
```
12227

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.
12429

125-
---
30+
Defaults to `0`.
12631

12732
### minValue
12833

129-
```xml
130-
<Slider minValue="0" />
34+
```ts
35+
minValue: number
13136
```
13237

13338
Gets or sets the minimum value of the slider.
13439

135-
---
136-
13740
### maxValue
13841

139-
```xml
140-
<Slider maxValue="100"/>
42+
```ts
43+
maxValue: number
14144
```
14245

14346
Gets or sets the maximum value of the slider.
14447

145-
---
146-
14748
### ...Inherited
14849

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).
15051

15152
## Events
15253

15354
### valueChange
15455

15556
```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)
15860
})
15961
```
16062

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.
16264

163-
---
65+
See [PropertyChangeData](/api/interface/PropertyChangeData).
16466

16567
## Native component
16668

examples/flows/screenshots.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ output.screenshots = [
1515
'ScrollView',
1616
'SearchBar',
1717
'SegmentedBar',
18+
'Slider',
1819
]

examples/src/ui/Slider/template.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<Page>
2+
<GridLayout padding="8">
3+
<ContentView verticalAlignment="center">
4+
<!-- #region example -->
5+
<Slider value="75" minValue="0" maxValue="100" />
6+
<!-- #endregion example -->
7+
</ContentView>
8+
</GridLayout>
9+
</Page>

0 commit comments

Comments
 (0)