Giter Club home page Giter Club logo

sneakbar's Introduction

Sneakbar is a simple notification toast.

Getting started

Install the package with NPM:

npm install sneakbar

Add the following to a JS file where you want to use a Sneakbar:

import Sneakbar from "sneakbar"; // The class to instantiate
import "sneakbar/sneakbar.scss"; // CSS

Instantiate the Sneakbar class and use the show method:

let sneakbar = new Sneakbar({
    actionText: "OK",
    duration: 6000,
    position: "bottom-end",
    text: "Kept you waiting huh?",
});

sneakbar.show();

Options

You can add the following options to the initialisation object to customize the Sneakbar:

  • actionText: string, the text of the action button (default: "Dismiss")
  • actionTextColor: string, the hexadecimal color of the action button (default: #22c55e)
  • backgroundColor: string, the hexadecimal color of the Sneakbar backgroud (default: #262626)
  • customClasses: array, classes to add to the Sneakbar wrapper element (default: [])
  • duration: integer, milliseconds before the Sneakbar disappears (default: 5000)
  • position: string, where the Sneakbar will appear (default: bottom-start)
    • top-start
    • top-center
    • top-end
    • bottom-start
    • bottom-center
    • bottom-end
  • showAction: boolean, whether to show the action button or not (default: true)
  • text: string, the text content of the Sneakbar (default: Kept you waiting huh?)
  • textColor: string, the hexadecimal color of the Sneakbar text (default: white)
  • theme: string, the theme to apply (default: material-design)
    • material-design
    • twitter

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.