Package Exports

@dreamworld/dw-snackbar

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dreamworld/dw-snackbar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

dw-snackbar

A Material design snackbar WebComponent implemented through LitElement

Usage

Add Snackbar to your App Shell.

import '@dreamworld/dw-snackbar';

In app-shell render template add element

<dw-snackbar></dw-snackbar>

To show snackbar, call show or hide method in @dreamworld/dw-snackbar module.

APIs

setDefaults(config)

Used to set default values for config used for the show.

`show(config)`

Used to show a snackbar. config is a plain-JS Object as follows:

 {
   id: '', // (Optional) A Unique identifier for this Toast. Mainly used if you want to prematurely hide it.
   message: '', //Required
   type: 'INFO',  // (Optional) Possible values INFO | WARN | ERROR. Default: INFO
   timeout: 10000,  // (Optional) Time is in milliseconds after which message should be automatically dismissed. Set to `0` to prevent automatic dismiss. Default: 10000
   hideDismissBtn: true,  // (Optional) Set `true` to hide (not show) dismiss button. Default: false
   dismissIcon: '', // (Optional) Name of the Dismiss icon to be used. Default value: 'clear'
   onDismiss: callback, //(Optional), A Callback function when snackbar is dimissed, call in both cases: Either automatically closed or manually. It's first agument will be `id`.
   actionButton: { //(Optional), When actionButton spec is specified, dismiss icon-button isn't shown.
     caption: '',  // Button Text/Caption
     callback: callBack, // callback function to be invoked when user clicks on the action button. Callback method will receive `id` in the argument.
     link: link // Link to be opened when user clicks on the button. Link will be opened in the current window. Actually action button will be rendered as Link button. It's exclusive to `callback`. So, `callback` isn't invoked when this is specified.
     stacked: false, //Optional. Set to `true` when action button is to be shown on the Next Line. Default=false. 
   }
 }

It can show multiple snackbars, if show() method is invoked again before the current snackbar isn't dismissed.

`setPosition(position)`

Mostly, In Desktop mode, you would like to anchor Snackbar to the left, while on Mobile you would like to anchor to the center. So, whenever your app change the layout, call this method to update Layout of this.

{
  horizontal: 'left', //Posible values: 'left', 'center', 'right'. Default: 'left'
  vertical: 'bottom' //Possible values: 'top', 'bottom'. Default: 'bottom'.
}

`hide(id)`

Hides Snackbar. No op, if no snackbar is found with that id. This can happen when Snackbar is auto-dismissed and this method is called later.

CSS Properties

Name	Description
`--dw-toast-color`	Color of the snackbar text and icon
`--dw-toast-bg-color`	Background color of the snackbar
`--dw-toast-bg-color-warn`	Background color of the warn type snackbar
`--mdc-theme-error`	Background color of the error type snackbar
`--dw-toast-margin`	`margin` for a toast
`--dw-toast-min-width`	Min Width for a Toast. Default value `344px`
`--dw-toast-max-width`	Max Width. Default no value. So, limited by the screen size

Road map

Add feature to show stacked action buttons (Action button is on the 2nd row)