Interface ISelectablePicker<TEvent>

Type Parameters

TEvent extends string = SelectablePickerEvents

Hierarchy

default<TEvent>
- ISelectablePicker

Properties

`Protected` _nativeObject

_nativeObject: any

items

items: string[]

Gets/sets items of the SelectablePicker.

Property

Android

Since

4.0.5

title

title: string

Gets/sets title of the SelectablePicker. This property only works with show method. Must set before show method.

Property

= Picker]

Android

Since

4.0.5

titleColor

titleColor: IColor

Gets/sets titleColor of the SelectablePicker. This property only works with show method. Must set before show method.

Property

= Color.BLACK]

Android

Since

4.0.5

titleFont

titleFont: IFont

Gets/sets titleFont of the SelectablePicker. This property only works with show method. Must set before show method.

Property

Android

Since

4.0.5

multiSelectEnabled

multiSelectEnabled: boolean

Gets/sets multiSelectEnabled of the SelectablePicker. You must set this property in constructor and can not change this property on run-time. Otherwise SelectablePicker may not work properly. This property only works with show method. Must set before show method.

Property

= false]

Android

Since

4.0.5

cancelable

cancelable: boolean

Gets/sets cancelable of the SelectablePicker. If click outside of dialog, it will be canceled. This property only works with show method. Must set before show method.

Property

= true]

Android

Since

4.0.5

checkedItems

checkedItems: number | number[]

Gets/sets checkedItems of the SelectablePicker. If multiSelectEnabled is false, checkedItems must be a spesific index of the items array or array of index. This property only works with show method. Must set before show method.

Property

= -1]

Android

Since

4.0.5

backgroundColor

backgroundColor: IColor

Gets/sets backgroundColor of the SelectablePicker. This property only works with show method. Must set before show method.

Property

= Color.WHITE]

Android

Since

4.0.5

cancelButtonColor

cancelButtonColor: IColor

Gets/sets cancelButtonColor of the SelectablePicker. This property only works with show method. Must set before show method.

Property

Android

Since

4.0.5

cancelButtonFont

cancelButtonFont: IFont

Gets/sets cancelButtonFont of the SelectablePicker. This property only works with show method. Must set before show method.

Property

Android

Since

4.0.5

cancelButtonText

cancelButtonText: string

Gets/sets cancelButtonText of the SelectablePicker. This property only works with show method. Must set before show method.

Property

= Cancel]

Android

Since

4.0.5

doneButtonColor

doneButtonColor: IColor

Gets/sets doneButtonColor of the SelectablePicker. This property only works with show method. Must set before show method.

Property

Android

Since

4.0.5

doneButtonText

doneButtonText: string

Gets/sets doneButtonText of the SelectablePicker. This property only works with show method. Must set before show method.

Property

= Ok]

Android

Since

4.0.5

doneButtonFont

doneButtonFont: IFont

Gets/sets doneButtonFont of the SelectablePicker. This property only works with show method. Must set before show method.

Property

Android

Since

4.0.5

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

show

show(done: ((param: { items: number | number[] }) => void), cancel: (() => void)): void
This function shows SelectablePicker in a dialog.

Method
show

Android

Since
4.0.5
Parameters
- done: ((param: { items: number | number[] }) => void)
  
  This event is called when user clicks done button.
  - - (param: { items: number | number[] }): void
    - Parameters
      
      param: { items: number | number[] }
      
      items: number | number[]
      
      Returns void
- cancel: (() => void)
  
  This event is called when user clicks cancel button.
  - - (): void
    - Returns void
Returns void
- Defined in ui/selectablepicker/selectablepicker.ts:167

on

on(eventName: "selected", callback: ((index?: number, selected?: boolean) => void)): (() => void)
Parameters
- eventName: "selected"
- callback: ((index?: number, selected?: boolean) => void)
  - - (index?: number, selected?: boolean): void
    - Parameters
      
      Optional index: number
      
      Optional selected: boolean
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/selectablepicker/selectablepicker.ts:168
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/selectablepicker/selectablepicker.ts:169
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/selectablepicker/selectablepicker.ts:170

off

off(eventName: "selected", callback: ((index?: number, selected?: boolean) => void)): void
Parameters
- eventName: "selected"
- callback: ((index?: number, selected?: boolean) => void)
  - - (index?: number, selected?: boolean): void
    - Parameters
      
      Optional index: number
      
      Optional selected: boolean
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/selectablepicker/selectablepicker.ts:172
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/selectablepicker/selectablepicker.ts:173
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/selectablepicker/selectablepicker.ts:174

emit

emit(eventName: "selected", index?: number, selected?: boolean): void
Parameters
- eventName: "selected"
- Optional index: number
- Optional selected: boolean
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/selectablepicker/selectablepicker.ts:176
emit(eventName: "selected", ...args: any[]): void
Parameters
- eventName: "selected"
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/selectablepicker/selectablepicker.ts:177
emit(eventName: string, ...args: any[]): void
Parameters
- eventName: string
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/selectablepicker/selectablepicker.ts:178

once

once(eventName: "selected", callback: ((index?: number, selected?: boolean) => void)): (() => void)
Parameters
- eventName: "selected"
- callback: ((index?: number, selected?: boolean) => void)
  - - (index?: number, selected?: boolean): void
    - Parameters
      
      Optional index: number
      
      Optional selected: boolean
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/selectablepicker/selectablepicker.ts:180
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/selectablepicker/selectablepicker.ts:181
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/selectablepicker/selectablepicker.ts:182

prependListener

prependListener(eventName: "selected", callback: ((index?: number, selected?: boolean) => void)): void
Parameters
- eventName: "selected"
- callback: ((index?: number, selected?: boolean) => void)
  - - (index?: number, selected?: boolean): void
    - Parameters
      
      Optional index: number
      
      Optional selected: boolean
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/selectablepicker/selectablepicker.ts:184
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/selectablepicker/selectablepicker.ts:185
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/selectablepicker/selectablepicker.ts:186

prependOnceListener

prependOnceListener(eventName: "selected", callback: ((index?: number, selected?: boolean) => void)): void
Parameters
- eventName: "selected"
- callback: ((index?: number, selected?: boolean) => void)
  - - (index?: number, selected?: boolean): void
    - Parameters
      
      Optional index: number
      
      Optional selected: boolean
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/selectablepicker/selectablepicker.ts:188
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/selectablepicker/selectablepicker.ts:189
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/selectablepicker/selectablepicker.ts:190

Events

onSelected

onSelected: ((index?: number, selected?: boolean) => void)

Type declaration

- (index?: number, selected?: boolean): void
- This event is called when an item is selected/unselected on the SelectablePicker. If multiSelectEnabled is false, selected will be always true.
  
  Deprecated
  
  Android
  
  Since
  4.0.5
  
  Example
```
import SelectablePicker from '@smartface/native/ui/selectablepicker';

const selectablePicker = new SelectablePicker();
selectablePicker.on(SelectablePicker.Events.Selected, (params) => {
 console.info('onSelected', params);
});
```
  Parameters
  - Optional index: number
  - Optional selected: boolean
    
    onSelected
  Returns void

Interface ISelectablePicker<TEvent>

Type Parameters

TEvent extends string = SelectablePickerEvents

Hierarchy

Index

Properties

Accessors

Methods

Events

Properties

Protected _nativeObject

items

Property

Android

Since

title

Property

Android

Since

titleColor

Property

Android

Since

titleFont

Property

Android

Since

multiSelectEnabled

Property

Android

Since

cancelable

Property

Android

Since

checkedItems

Property

Android

Since

backgroundColor

Property

Android

Since

cancelButtonColor

Property

Android

Since

cancelButtonFont

Property

Android

Since

cancelButtonText

Property

Android

Since

doneButtonColor

Property

Android

Since

doneButtonText

Property

Android

Since

doneButtonFont

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

`Protected` _nativeObject

`Protected` `Abstract` createNativeObject

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

`Protected` preConstruct

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

`Protected` addAndroidProps

`Protected` addIOSProps

`Optional` index: number

`Optional` selected: boolean

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` index: number

`Optional` selected: boolean

`Rest` ...args: any[]