Class Alertview

Since

0.1

AlertView is an alert box with buttons having custom behaviors. You can use AlertView for informing user or asking for confirmations. AlertView has buttons with callbacks that you can take action for each of them separately.

Example

import AlertView from '@smartface/native/ui/alertview';

    const myAlertView = new AlertView({
        title: "Alert Title",
        message: "Alert Message"
    });
    myAlertView.addButton({
        type: AlertView.Android.ButtonType.NEGATIVE,
        text: "Cancel"
    });
    myAlertView.addButton({
        type: AlertView.Android.ButtonType.POSITIVE,
        text: "Okay",
        onClick: () => {
            console.log("Okay clicked.");
        }
    });

    myAlertView.show();

Hierarchy

NativeMobileComponent<any, MobileOSProps<{}, IAlertViewAndroidProps>>
- Alertview

Implements

IAlertView

Index

Properties

`Protected` _nativeObject

_nativeObject: any

title

title: string

Gets/sets title of AlertView.

Android

Ios

Since

0.1

message

message: string

Gets/sets message of AlertView.

Android

Ios

Since

0.1

onDismiss

onDismiss: ((alertView?: IAlertView) => void)

Type declaration

- (alertView?: IAlertView): void
- Parameters
  - Optional alertView: IAlertView
  Returns void

`Static` Android

Android: { ButtonType: typeof ButtonType }

Type declaration

ButtonType: typeof ButtonType

Accessors

nativeObject

get nativeObject(): any
Returns any
Implementation of IAlertView.nativeObject

Inherited from NativeMobileComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Implementation of IAlertView.nativeObject

Inherited from NativeMobileComponent.nativeObject
- Defined in core/native-component.ts:15

ios

get ios(): TProps["ios"]
Returns TProps["ios"]
Implementation of IAlertView.ios

Inherited from NativeMobileComponent.ios
- Defined in core/native-mobile-component.ts:49

android

get android(): TProps["android"]
Returns TProps["android"]
Implementation of IAlertView.android

Inherited from NativeMobileComponent.android
- Defined in core/native-mobile-component.ts:52

textBoxes

get textBoxes(): { text: string }[]
Returns object which contains text of added TextBox

Android

Ios

Since
4.1.2

Returns { text: string }[]
Implementation of IAlertView.textBoxes
- Defined in ui/alertview/alertview.ts:213

Methods

`Protected` preConstruct

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

`Protected` addAndroidProps

addAndroidProps(props: Partial<IAlertViewAndroidProps>): void
Parameters
- props: Partial<IAlertViewAndroidProps>
Returns void
Inherited from NativeMobileComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: Partial<{}>): void
Parameters
- props: Partial<{}>
Returns void
Inherited from NativeMobileComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

`Protected` createNativeObject

createNativeObject(params?: Partial<Record<string, any>>): any
Parameters
- Optional params: Partial<Record<string, any>>
Returns any
Overrides NativeMobileComponent.createNativeObject
- Defined in ui/alertview/alertview.ts:204

isShowing

isShowing(): void
Gets showing status of AlertView. It is set to true if AlertView is currently displayed on screen, false otherwise.

Property

Android

Ios

Since
0.1

Returns void
Implementation of IAlertView.isShowing
- Defined in ui/alertview/alertview.ts:206

show

show(): void
Shows AlertView on the screen with specified properties, isShowing property set to true after this operation.

Method
show

Android

Ios

Since
0.1

Returns void
Implementation of IAlertView.show
- Defined in ui/alertview/alertview.ts:207

dismiss

dismiss(): void
Dismisses the AlertView, isShowing property set to false after this operation.

Android

Ios

Since
0.1

Returns void
Implementation of IAlertView.dismiss
- Defined in ui/alertview/alertview.ts:208

toString

toString(): string
Returns string
Implementation of IAlertView.toString
- Defined in ui/alertview/alertview.ts:209

addButton

addButton(params: { type: ButtonType; text: string; onClick?: (() => void); index?: number }): void
Allows you to add button to AlertView. You can add maximum 3 buttons on Android platform, on iOS there is no limitation.

Example
```
myAlertView.addButton({
        type: AlertView.Android.ButtonType.POSITIVE,
        text: "Okay",
        onClick: function() {
            console.log("Okay clicked.");
        }
    });
```
Android

Ios

Since
0.1
Parameters
- params: { type: ButtonType; text: string; onClick?: (() => void); index?: number }
  - type: ButtonType
  - text: string
  - Optional onClick?: (() => void)
    - (): void
      
      Returns void
  - Optional index?: number
Returns void
Implementation of IAlertView.addButton
- Defined in ui/alertview/alertview.ts:214

addTextBox

addTextBox(params: { text: string; hint: string; isPassword: boolean; keyboardType?: number; android: Partial<{ width: number; height: number; viewSpacings: { left: number; top: number; right: number; bottom: number } }> }): void
Allows to add TextBox to AlertView. In iOS, maximum two textbox can be added. It is not applied to Android but 2 textboxes recommended.

Example
```
myAlertView.addTextBox({
         text: "Hello!",
         hint: "Hint!",
         isPassword: false,
         android: {
             viewSpacings: { left: 50, right: 50 }
         }
    });
```
Android

Ios

Since
4.1.2
Parameters
- params: { text: string; hint: string; isPassword: boolean; keyboardType?: number; android: Partial<{ width: number; height: number; viewSpacings: { left: number; top: number; right: number; bottom: number } }> }
  - text: string
  - hint: string
  - isPassword: boolean
  - Optional keyboardType?: number
  - android: Partial<{ width: number; height: number; viewSpacings: { left: number; top: number; right: number; bottom: number } }>
Returns void
Implementation of IAlertView.addTextBox
- Defined in ui/alertview/alertview.ts:215

Constructors

constructor

new AbstractAlertView(params?: Partial<IAlertView>): Alertview
Parameters
- Optional params: Partial<IAlertView>
Returns Alertview
Overrides NativeMobileComponent<any, MobileOSProps<{}, IAlertViewAndroidProps>>.constructor
- Defined in ui/alertview/alertview.ts:205

Class Alertview

Since

Example

Hierarchy

Implements

Index

Properties

Accessors

Methods

Constructors

Properties

Protected _nativeObject

title

Android

Ios

Since

message

Android

Ios

Since

onDismiss

Type declaration

Parameters

Optional alertView: IAlertView

Returns void

Static Android

Type declaration

ButtonType: typeof ButtonType

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

ios

Returns TProps["ios"]

android

Returns TProps["android"]

textBoxes

Android

Ios

Since

Returns { text: string }[]

Methods

Protected preConstruct

Parameters

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

Returns void

Protected addAndroidProps

Parameters

props: Partial<IAlertViewAndroidProps>

Returns void

Protected addIOSProps

Parameters

props: Partial<{}>

Returns void

Protected createNativeObject

Parameters

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

Returns any

isShowing

Property

Android

Ios

Since

Returns void

show

Method

Android

Ios

Since

Returns void

dismiss

Android

Ios

Since

Returns void

toString

Returns string

addButton

`Protected` _nativeObject

`Optional` alertView: IAlertView

`Static` Android

`Protected` preConstruct

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

`Protected` addAndroidProps

`Protected` addIOSProps

`Protected` createNativeObject

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

`Optional` onClick?: (() => void)

`Optional` index?: number

`Optional` keyboardType?: number

`Optional` params: Partial<IAlertView>