Skip to content

Latest commit

 

History

History
66 lines (48 loc) · 3.65 KB

README.md

File metadata and controls

66 lines (48 loc) · 3.65 KB
Raw

js-snackbar

What is a SnackBar?

According to Material Design a Snackbar or Toast provides "brief messages about app processes at the bottom of the screen."

Generally, they should not have an icon associated with it and should be only one line on most devices.

While this version of a SnackBar follows the Material Design semantics closely, it strays in several major ways.

  1. You can send multiple snackbars to a user at a time, as opposed to a single snackbar at a time.
  2. The SnackBar appears in the bottom right corner, as opposed to the bottom left or bottom center.

Basic Usage

Simply call SnackBar() to create the a notification message with default options, or pass an options object that includes some of the properties below in Options.

Options

To customize a SnackBar, pass the function a JS object with any of the following properties. All properties are optional.

Property typeof Default Value Notes
message string "Operation performed successfully."
dismissible boolean true
timeout number or boolean 5000 Integer represents milliseconds. To specify no timeout, set the value to false or any number less than or equal to 0
status string Possible statuses include "success", "green", "warning", "alert", "orange", "danger", "error", "red." All other values will default to the blue "info" status
actions array [] See Actions
fixed boolean false true indicates a positioning:fixed; be added to the container
position string "br" Possible values are "br", "tr", "tc", "tm", "bc", "bm", "tl", or "bl"
container DOMNode or string document.body If a string is provided, the string is passed to querySelector to find the container
width string Any valid CSS value for width
speed string or number Any valid CSS value for transition-duration or a duration in milliseconds
icon string "" See Icons

Actions

Actions should be an array of objects matching the format

{
    text: string;
    function?: () => void;
    dismiss?: boolean;
}

At minimum, an action must have a text field, which will simply create a dismiss button with custom text. Alternatively, you can specify a function property which defines a custom function to be run once the action is clicked. This can be anything and is passed no parameters. If function is defined but you still want the action click to dismiss the SnackBar, then you can specify dismiss = true to indicate that, once your method has run to completion, then the action will be automatically dismissed.

Icons

In order for icons to be visible, status must be set to a non-empty value. The icon property accepts any string value. This values will be truncated to a single character (e.g., "alert" will be shortened to "a") and displayed within the status indicator. There are several pre-defined values you can use with friendly names to make them easier to remember:

  • ! -> "exclamation", "warn", or "danger"
  • ? -> "info", "question", or "question-mark"
  • + -> "plus" or "add"

Since these are just conveniences, you may also simply put provide the value directly (e.g. icon: "?") to have the same result.