Interface IAlertView

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

INativeComponent
MobileOSProps<{}, IAlertViewAndroidProps>
- IAlertView

Implemented by

Alertview

Index

Properties

nativeObject ios android title message onDismiss textBoxes

Methods

isShowing show toString dismiss addButton addTextBox

Properties

nativeObject

nativeObject: { [key: string]: any }

Type declaration

[key: string]: any

ios

ios: Partial<{}>

android

android: Partial<IAlertViewAndroidProps>

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
- Gets/sets dismiss callback function.
  
  Example
```
myAlertView.onDismiss = (alertView) =>  {
        console.log("Dismissed alert view with title: " + alertView.title);
    };
```
  Android
  
  Ios
  
  Since
  0.1
  Parameters
  - Optional alertView: IAlertView
    
    Dismissed AlertView object
  Returns void

`Readonly` textBoxes

textBoxes: { text: string }[]

Returns object which contains text of added TextBox

Android

Ios

Since

4.1.2

Methods

isShowing

isShowing(): void
Readonly
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
- Defined in ui/alertview/alertview.ts:91

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
- Defined in ui/alertview/alertview.ts:101

toString

toString(): string
Returns string
- Defined in ui/alertview/alertview.ts:102

dismiss

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

Android

Ios

Since
0.1

Returns void
- Defined in ui/alertview/alertview.ts:141

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
  - onClick: (() => void)
    - (): void
      
      Returns void
  - Optional index?: number
Returns void
- Defined in ui/alertview/alertview.ts:168

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
- Defined in ui/alertview/alertview.ts:185

Interface IAlertView

Since

Example

Hierarchy

Implemented by

Index

Properties

Methods

Properties

nativeObject

Type declaration

[key: string]: any

ios

android

title

Android

Ios

Since

message

Android

Ios

Since

onDismiss

Type declaration

Example

Android

Ios

Since

Parameters

Optional alertView: IAlertView

Returns void

Readonly textBoxes

Android

Ios

Since

Methods

isShowing

Property

Android

Ios

Since

Returns void

show

Method

Android

Ios

Since

Returns void

toString

Returns string

dismiss

Android

Ios

Since

Returns void

addButton

Example

Android

Ios

Since

Parameters

params: { type: ButtonType; text: string; onClick: (() => void); index?: number }

type: ButtonType

text: string

onClick: (() => void)

Returns void

Optional index?: number

Returns void

addTextBox

Example

Android

Ios

Since

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 } }>

`Optional` alertView: IAlertView

`Readonly` textBoxes

`Optional` index?: number

`Optional` keyboardType?: number