Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface to define the states of the Dialog component

interface

IDialogState

Hierarchy

Index

Properties

Optional animation

Define the animation to show the Dialog

type

{TypeDialogAnimation}

memberof

IDialogState

default

fade

Optional animationDuration

animationDuration: undefined | number

A number millisecond to set the time animation

type

{number}

memberof

IDialogState

Optional children

children: TypeComponent | TypeComponent[]

Define the content or children for the dialog

type

{(TypeComponent | TypeComponent[])}

memberof

IDialogState

Optional containerStyle

containerStyle: TypeStyle

Apply a custom style to the content of the dialog

type

{TypeStyle}

memberof

IDialogState

Optional dismissOnHardwareBackPress

dismissOnHardwareBackPress: undefined | false | true

Set true to enable the dismiss when pressed the button back

type

{boolean}

memberof

IDialogState

default

true

Optional dismissOnTouchOutside

dismissOnTouchOutside: undefined | false | true

Set true to enable the dismiss when pressed outside of dialog

type

{boolean}

memberof

IDialogState

default

true

Optional footer

footer: TypeComponent | TypeComponent[]

List of the buttons for the actions

type

{(TypeComponent | TypeComponent[])}

memberof

IDialogState

Optional hasOverlay

hasOverlay: undefined | false | true

Set true if the dialog has overlay

type

{boolean}

memberof

IDialogState

default

true

Optional height

height: number | null

A number to define the height of the dialog

type

{(number | null)}

memberof

IDialogState

Optional onDismiss

onDismiss: undefined | function

Method that fire when the dialog is dismissed

memberof

IDialogState

Optional onShow

onShow: undefined | function

Method that fire when the dialog is showed

memberof

IDialogState

Optional overlayBackgroundColor

overlayBackgroundColor: undefined | string

Set a custom background color for the overlay

type

{string}

memberof

IDialogState

Optional overlayOpacity

overlayOpacity: undefined | number

Set a custom opacity for the overlay

type

{number}

memberof

IDialogState

Optional overlayPointerEvents

overlayPointerEvents: "auto" | "none"

Define a custom overlay pointer events

type

{('auto' | 'none')}

memberof

IDialogState

default

auto

Optional rounded

rounded: undefined | false | true

Set true if the dialog is rounded style

type

{boolean}

memberof

IDialogState

Optional slideFrom

Define a custom animation for the animation slide

type

{TypeDialogSlideFrom}

memberof

IDialogState

Optional style

style: TypeStyle

Apply a custom style to the dialog

type

{TypeStyle}

memberof

IDialogState

Optional title

title: string | TypeComponent

A string to define the title of the dialog

type

{(string | TypeComponent)}

memberof

IDialogState

Optional titleStyle

titleStyle: TypeStyle

Apply a custom style to the title dialog

type

{TypeStyle}

memberof

IDialogState

Optional useNativeDriver

useNativeDriver: undefined | false | true

Set true to use a native driver

type

{boolean}

memberof

IDialogState

default

true

Optional visible

visible: undefined | false | true

Set true to make visible the dialog

type

{boolean}

memberof

IDialogState

Optional width

width: number | null

A number to define the height of the dialog

type

{(number | null)}

memberof

IDialogState

Generated using TypeDoc