Interface ITimePicker<TEvent>

Since

0.1

TimePicker is a dialog where users are able to select the time.

Example

import TimePicker from '@smartface/native/ui/timepicker';
    const myTimePicker = new TimePicker();
    myTimePicker.onTimeSelected = (time) => {
        console.log('Hour: ' + time.hour + ' Minute: ' + time.minute);
    };
    myTimePicker.android.is24HourFormat = false;
    myTimePicker.show();

Type Parameters

TEvent extends string = TimePickerEvents

Hierarchy

default<TEvent>
- ITimePicker

Index

Properties

`Protected` _nativeObject

_nativeObject: any

is24HourFormat

is24HourFormat: boolean

Sets whether time is 24-hour or AM/PM mode.

Property

Android

Since

0.1

Accessors

nativeObject

get nativeObject(): any
Returns any
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:15

ios

get ios(): TProps["ios"]
Returns TProps["ios"]
Inherited from NativeEventEmitterComponent.ios
- Defined in core/native-mobile-component.ts:49

android

get android(): TProps["android"]
Returns TProps["android"]
Inherited from NativeEventEmitterComponent.android
- Defined in core/native-mobile-component.ts:52

Methods

`Protected` `Abstract` createNativeObject

createNativeObject(params?: Partial<Record<string, any>>): any
Executed before everything. This should return nativeObject since it will be assinged directly to nativeObject.
Parameters
- Optional params: Partial<Record<string, any>>
Returns any
Inherited from NativeEventEmitterComponent.createNativeObject
- Defined in core/native-component.ts:33

`Protected` preConstruct

preConstruct(params?: Partial<Record<string, any>>): void
Parameters
- Optional params: Partial<Record<string, any>>
Returns void
Inherited from NativeEventEmitterComponent.preConstruct
- Defined in core/native-event-emitter-component.ts:27

`Protected` addAndroidProps

addAndroidProps(props: Partial<{ [key: string]: any }>): void
Parameters
- props: Partial<{ [key: string]: any }>
Returns void
Inherited from NativeEventEmitterComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: Partial<{ [key: string]: any }>): void
Parameters
- props: Partial<{ [key: string]: any }>
Returns void
Inherited from NativeEventEmitterComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

setTime

setTime(params: { hour: number; minute: number }): void
Sets the time avaliable on the picker.

Method
setTime

Android

Ios

Since
0.1
Parameters
- params: { hour: number; minute: number }
  - hour: number
  - minute: number
Returns void
- Defined in ui/timepicker/timepicker.ts:32

show

show(): void
Makes the picker appear on the screen.

Method
show

Android

Ios

Since
0.1

Returns void
- Defined in ui/timepicker/timepicker.ts:49

on

on(eventName: "selected", callback: ((e: { hour: number; minute: number }) => void)): (() => void)
Parameters
- eventName: "selected"
- callback: ((e: { hour: number; minute: number }) => void)
  - - (e: { hour: number; minute: number }): void
    - Parameters
      
      e: { hour: number; minute: number }
      
      hour: number
      
      minute: number
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/timepicker/timepicker.ts:72
on(eventName: "selected", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "selected"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/timepicker/timepicker.ts:73
on(eventName: string, callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: string
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/timepicker/timepicker.ts:74

off

off(eventName: "selected", callback: ((e: { hour: number; minute: number }) => void)): void
Parameters
- eventName: "selected"
- callback: ((e: { hour: number; minute: number }) => void)
  - - (e: { hour: number; minute: number }): void
    - Parameters
      
      e: { hour: number; minute: number }
      
      hour: number
      
      minute: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/timepicker/timepicker.ts:76
off(eventName: "selected", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "selected"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/timepicker/timepicker.ts:77
off(eventName: string, callback: ((...args: any[]) => void)): void
Parameters
- eventName: string
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/timepicker/timepicker.ts:78

emit

emit(eventName: "selected", e: { hour: number; minute: number }): void
Parameters
- eventName: "selected"
- e: { hour: number; minute: number }
  - hour: number
  - minute: number
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/timepicker/timepicker.ts:80
emit(eventName: "selected", ...args: any[]): void
Parameters
- eventName: "selected"
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/timepicker/timepicker.ts:81
emit(eventName: string, ...args: any[]): void
Parameters
- eventName: string
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/timepicker/timepicker.ts:82

once

once(eventName: "selected", callback: ((e: { hour: number; minute: number }) => void)): (() => void)
Parameters
- eventName: "selected"
- callback: ((e: { hour: number; minute: number }) => void)
  - - (e: { hour: number; minute: number }): void
    - Parameters
      
      e: { hour: number; minute: number }
      
      hour: number
      
      minute: number
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/timepicker/timepicker.ts:84
once(eventName: "selected", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "selected"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/timepicker/timepicker.ts:85
once(eventName: string, callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: string
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/timepicker/timepicker.ts:86

prependListener

prependListener(eventName: "selected", callback: ((e: { hour: number; minute: number }) => void)): void
Parameters
- eventName: "selected"
- callback: ((e: { hour: number; minute: number }) => void)
  - - (e: { hour: number; minute: number }): void
    - Parameters
      
      e: { hour: number; minute: number }
      
      hour: number
      
      minute: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/timepicker/timepicker.ts:88
prependListener(eventName: "selected", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "selected"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/timepicker/timepicker.ts:89
prependListener(eventName: string, callback: ((...args: any[]) => void)): void
Parameters
- eventName: string
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/timepicker/timepicker.ts:90

prependOnceListener

prependOnceListener(eventName: "selected", callback: ((e: { hour: number; minute: number }) => void)): void
Parameters
- eventName: "selected"
- callback: ((e: { hour: number; minute: number }) => void)
  - - (e: { hour: number; minute: number }): void
    - Parameters
      
      e: { hour: number; minute: number }
      
      hour: number
      
      minute: number
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/timepicker/timepicker.ts:92
prependOnceListener(eventName: "selected", callback: ((...args: any[]) => void)): void
Parameters
- eventName: "selected"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/timepicker/timepicker.ts:93
prependOnceListener(eventName: string, callback: ((...args: any[]) => void)): void
Parameters
- eventName: string
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/timepicker/timepicker.ts:94

Events

onTimeSelected

onTimeSelected: ((e: { hour: number; minute: number }) => void)

Type declaration

- (e: { hour: number; minute: number }): void
- Triggered when a time is selected on the picker.
  
  Since
  0.1
  
  Deprecated
  onTimeSelected
  
  Android
  
  Ios
  
  Example
```
import TimePicker from '@smartface/native/ui/timepicker';

const timePicker = new TimePicker();
timePicker.on(TimePicker.Events.Selected, (params) => {
 console.info('onTimeSelected', params);
});
```
  Parameters
  - e: { hour: number; minute: number }
    - hour: number
    - minute: number
  Returns void

Interface ITimePicker<TEvent>

Since

Example

Type Parameters

TEvent extends string = TimePickerEvents

Hierarchy

Index

Properties

Accessors

Methods

Events

Properties

Protected _nativeObject

is24HourFormat

Property

Android

Since

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

ios

Returns TProps["ios"]

android

Returns TProps["android"]

Methods

Protected Abstract createNativeObject

Parameters

Optional params: Partial<Record<string, any>>

Returns any

Protected preConstruct

Parameters

Optional params: Partial<Record<string, any>>

Returns void

Protected addAndroidProps

Parameters

props: Partial<{ [key: string]: any }>

Returns void

Protected addIOSProps

Parameters

props: Partial<{ [key: string]: any }>

Returns void

setTime

Method

Android

Ios

Since

Parameters

params: { hour: number; minute: number }

hour: number

minute: number

Returns void

show

Method

Android

Ios

Since

Returns void

on

Parameters

eventName: "selected"

callback: ((e: { hour: number; minute: number }) => void)

Parameters

e: { hour: number; minute: number }

hour: number

minute: number

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "selected"

callback: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Returns (() => void)

Returns void

Parameters

`Protected` _nativeObject

`Protected` `Abstract` createNativeObject

`Optional` params: Partial<Record<string, any>>

`Protected` preConstruct

`Optional` params: Partial<Record<string, any>>

`Protected` addAndroidProps

`Protected` addIOSProps

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]