Skip to content

Commit f4e1c3e

Browse files
committed
docs: cleanup TimePicker
1 parent 9a74d38 commit f4e1c3e

File tree

4 files changed

+34
-170
lines changed

4 files changed

+34
-170
lines changed
25.1 KB
Loading
60.9 KB
Loading

content/ui/time-picker.md

Lines changed: 21 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -8,254 +8,105 @@ title: TimePicker
88

99
See also: [DatePicker](/ui/date-picker).
1010

11-
---
12-
1311
<DeviceFrame type="ios">
14-
<img src="https://raw.githubusercontent.com/nativescript-vue/nativescript-vue-ui-tests/master/screenshots/ios-simulator103iPhone6/TimePicker.png"/>
12+
<img src="../screenshots/ios/TimePicker.png"/>
1513
</DeviceFrame>
1614
<DeviceFrame type="android">
17-
<img src="https://raw.githubusercontent.com/nativescript-vue/nativescript-vue-ui-tests/master/screenshots/android23/TimePicker.png" />
15+
<img src="../screenshots/android/TimePicker.png"/>
1816
</DeviceFrame>
1917

20-
## Creating a simple TimePicker
21-
22-
To listen to time change event, handle the `timeChange` event in the `loaded` event handler of the `<TimePicker>`
23-
24-
<!-- /// flavor plain -->
25-
26-
```xml
27-
<TimePicker
28-
hour="10"
29-
minute="25"
30-
loaded="onPickerLoaded"
31-
/>
32-
```
33-
34-
```ts
35-
import { TimePicker } from '@nativescript/core'
36-
37-
export function onPickerLoaded(args) {
38-
const timePicker = args.object as TimePicker
39-
40-
// Configurable properties of TimePicker
41-
timePicker.hour = 10
42-
timePicker.minute = 25
43-
timePicker.minuteInterval = 5
44-
timePicker.minHour = 7
45-
timePicker.maxHour = 11
46-
timePicker.minMinute = 10
47-
timePicker.maxMinute = 45
48-
49-
timePicker.on('timeChange', (data: PropertyChangeData) => {
50-
// data is of type PropertyChangeData
51-
console.log('Picked TIME: ', data.value)
52-
console.log('Previous TIME: ', data.oldValue)
53-
})
54-
}
55-
```
56-
57-
<!-- ///
58-
59-
/// flavor angular
60-
61-
```xml
62-
<TimePicker
63-
hour="9"
64-
minute="25"
65-
maxHour="23"
66-
maxMinute="59"
67-
minuteInterval="5"
68-
(timeChange)="onTimeChanged($event)"
69-
>
70-
</TimePicker>
71-
```
72-
73-
```ts
74-
import { Component } from '@angular/core'
75-
import { TimePicker } from '@nativescript/core'
76-
77-
@Component({
78-
moduleId: module.id,
79-
templateUrl: './usage.component.html'
80-
})
81-
export class UsageComponent {
82-
todayObj: Date = new Date()
83-
84-
onTimeChanged(args) {
85-
const tp = args.object as TimePicker
86-
87-
const time = args.value
88-
console.log(`Chosen time: ${time}`)
89-
}
90-
}
91-
```
92-
93-
///
94-
95-
/// flavor vue
96-
97-
```xml
98-
<TimePicker :hour="selectedHour" :minute="selectedMinute" />
99-
```
100-
101-
`<TimePicker>` provides two-way data binding using `v-model`.
102-
103-
```xml
104-
<TimePicker v-model="selectedTime" />
105-
```
106-
107-
///
108-
109-
/// flavor svelte
110-
111-
```tsx
112-
<timePicker hour="{selectedHour}" minute="{selectedMinute}" />
113-
```
114-
115-
`<timePicker>` provides two-way data binding using `bind`.
116-
117-
```xml
118-
<timePicker bind:time="{selectedTime}" />
119-
```
120-
121-
///
122-
123-
/// flavor react
124-
125-
```tsx
126-
<timePicker hour={selectedHour} minute={selectedMinute} />
127-
```
128-
129-
/// -->
18+
<<< @/../examples/src/ui/TimePicker/template.xml#example
13019

13120
## Props
13221

13322
### hour
13423

135-
```xml
136-
<TimePicker hour="10"/>
137-
```
138-
13924
```ts
140-
timePicker.hour = 10
25+
hour: number
14126
```
14227

14328
Gets or sets the selected hour.
14429

145-
---
30+
Defaults to current hour.
14631

14732
### minute
14833

149-
```xml
150-
<TimePicker minute="10"/>
151-
```
152-
15334
```ts
154-
timePicker.minute = 25
35+
minute: number
15536
```
15637

15738
Gets or sets the selected minute.
15839

159-
---
40+
Defaults to current minute.
16041

16142
### time
16243

16344
```ts
164-
time: Date = timePicker.time
45+
time: Date
16546
```
16647

16748
Gets or sets the selected time.
16849

169-
---
50+
Defaults to current time.
17051

17152
### minHour
17253

173-
```xml
174-
<TimePicker minHour="7"/>
175-
```
176-
17754
```ts
178-
timePicker.minHour = 7
55+
minHour: number
17956
```
18057

18158
Gets or sets the minimum selectable hour.
18259

183-
---
184-
18560
### maxHour
18661

187-
```xml
188-
<TimePicker maxHour="7"/>
189-
```
190-
19162
```ts
192-
timePicker.maxHour = 11
63+
maxHour: number
19364
```
19465

19566
Gets or sets the maximum selectable hour.
19667

197-
---
198-
19968
### minMinute
20069

201-
```xml
202-
<TimePicker minMinute="10"/>
203-
```
204-
20570
```ts
206-
timePicker.minMinute = 10
71+
minMinute: number
20772
```
20873

20974
Gets or sets the minimum selectable minute.
21075

211-
---
212-
21376
### maxMinute
21477

215-
```xml
216-
<TimePicker maxMinute="45"/>
217-
```
218-
21978
```ts
220-
timePicker.maxMinute = 45
79+
maxMinute: number
22180
```
22281

22382
Gets or sets the maximum selectable minute.
22483

225-
---
226-
22784
### minuteInterval
22885

229-
```xml
230-
<TimePicker minuteInterval="45"/>
231-
```
232-
23386
```ts
234-
timePicker.minuteInterval = 45
87+
minuteInterval: number
23588
```
23689

237-
Gets or sets the selectable minute interval. `Default`:`1`.
90+
Gets or sets the selectable minute interval.
23891

239-
---
92+
Defaults to `1`.
24093

24194
### ...Inherited
24295

243-
For additional inherited properties not shown, refer to the [API Reference](https://docs.nativescript.org/api-reference/classes/timepicker) |
96+
For additional inherited properties not shown, refer to the [API Reference](/api/class/TimePicker)
24497

24598
## Events
24699

247100
### timeChange
248101

249102
```ts
250-
timePicker.on('timeChange', (data: PropertyChangeData) => {
251-
console.log('Picked TIME: ', data.value)
252-
console.log('Previous TIME: ', data.oldValue)
103+
on('timeChange', (args: PropertyChangeData) => {
104+
const timePicker = args.object as TimePicker
105+
console.log('Picked time:', data.value)
253106
})
254107
```
255108

256-
Emitted when the selected time changes. See the [PropertyChangeData](https://docs.nativescript.org/api-reference/interfaces/propertychangedata) interface for available event data properties.
257-
258-
---
109+
Emitted when the selected time changes.
259110

260111
## Native component
261112

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<Page>
2+
<GridLayout>
3+
<ContentView verticalAlignment="center" horizontalAlignment="center">
4+
<TimePicker hour="9" minute="41" />
5+
</ContentView>
6+
7+
<ContentView visibility="collapsed">
8+
<!-- #region example -->
9+
<TimePicker />
10+
<!-- #endregion example -->
11+
</ContentView>
12+
</GridLayout>
13+
</Page>

0 commit comments

Comments
 (0)