presentation-dialogs

3.1.11 • Public • Published

presentation-dialogs

Augmented.js Next Presentation - Dialog Components

API

Table of Contents

DialogView

Extends DecoratorView

A automatic dialog view - creates a dialog with simple configurations to customize</br/> supports title, body, style, and buttons as options
buttons are defined as an object with key as name, value as function to call

Parameters

  • options Object Options to pass to the class

isOpen

isOpen property (readonly)

Returns boolean true on open

title

title property - the title of the dialog

Parameters

  • title

style

style property - the style (form, alert, bigForm, or whatever class you want)

Parameters

  • style

buttons

buttons object property - the buttons to match to functions

Parameters

  • buttons

Properties

body

Body - sets the body content of the dialog

Parameters

  • body

Properties

  • body String A string value of th body (supports HTML)

render

render - render the dialog

cancel

cancel - standard built-in cancel callback. Calls close method by default

Parameters

  • event Event Event passed in

open

open - standard built-in open callback. Calls render method by default

Parameters

  • event Event Event passed in

close

close - standard built-in close callback. Closes the dialog, triggers the 'close' event

Parameters

  • event Event Event passed in

ConfirmationDialogView

Extends DialogView

A automatic comfirmation dialog view - creates a dialog with yes no buttons

Parameters

  • options

AlertDialogView

Extends DialogView

A automatic alert dialog view - creates a dialog with cancel button and a message

Parameters

  • options

Notification

Extends DialogView

Notification

Parameters

  • options Options to pass

Examples

options passed are: timeOut, name, style

Splash

Extends DecoratorView

Splash Screen View

Parameters

  • options Options to pass

Examples

options passed are: title, subTitle, subSubTitle, name, style, and figureStyle

ErrorDialogView

Extends AlertDialogView

A automatic error dialog view - creates a dialog ok button

Parameters

  • options

MessageDialogView

Extends AlertDialogView

A automatic message dialog view - creates a dialog ok button

Parameters

  • options

AboutDialogView

Extends DialogView

A automatic about dialog view - creates a dialog with cancel button and a message.
Pass the following options for pre-formated dialog:

  • description
  • author
  • version
  • website
* for preformated, do not pass 'body' option

Parameters

  • options

Package Sidebar

Install

npm i presentation-dialogs

Weekly Downloads

23

Version

3.1.11

License

Apache-2.0

Unpacked Size

44.3 kB

Total Files

5

Last publish

Collaborators

  • thedocbwarren