Menu
©2015
Documentation generator: JsDoc Toolkit 2.4.0
Template: Codeview 1.2
Generated on: 2015-1-16 18:32

Class puredom.Notifier

Class Summary
Constructor Attributes Constructor Name and Description
 
puredom.Notifier(options)
Provides a managed notification/toast display area.

Method Summary

Method Attributes Method Name and Description
 
get (id)
Get a notification by ID
 
show (config)
Show a notification.
Methods borrowed from class puredom.EventEmitter:
emit
on
once
removeListener

Class Detail

puredom.Notifier(options)
Provides a managed notification/toast display area.
Parameters:
{Object} options Optional
Hashmap of options
{puredom.NodeSelection} options.parent Optional
Construct the display area within a given element.

Method Detail

  • get(id)
    Get a notification by ID
    Parameters:
    {Any}id
  • show(config)
    Show a notification.
    Parameters:
    {Object} config
    Describes what to display
    {Object} config.message Optional
    The text to display
    {Object} config.icon Optional
    Icon/image to show next to the text
    {Object} config.image Optional
    Icon/image to show next to the text
    {Object} config.timeout Optional, Default: Notifier.timeout
    How many seconds to wait before auto-dismissing the notification