Code Monkey home page Code Monkey logo

toast's Introduction

Toast - A Bootstrap 4.2+ jQuery plugin

About

As of Bootstrap 4.2, toasts have been introduced and the aim of this plugin is to make them easier to use.

Usage

You can pass to the $.toast function an object with the settings for your toast which are as follows:

Parameter Description Default Values
title Shows in the top left corner of the toast header 'Notice!'
subtitle Shows in the top right corner of the toast header N/A
content Shows in the toast body N/A
type Determines the style of the toast based on Bootstrap styles 'info' 'info', 'success', 'warning', 'error'
delay Determines how long the Toast shoud be shown for. The default, -1, will show the toast until the user clicks close. -1 omit or set to -1 to disable auto close, or timeout value in milliseconds
img Shows an image before the title N/A { src: '', class: '', title: '', alt: '' }
icon Shows an icon before title N/A A complete icon class of your own. Example "fas fa-user-secret", show secret user
pause_on_hover true/false respectively to pause on hover false true/false
container Set the container inside which the toasts will be displayed $("body") A JQuery selector

Note: If content is omitted, the toast will not have a .toast-body and can be used as a small snack which will be shown below in the examples. By default toasts will be positioned in the top right corner and will in the future (hopefully) have other position options.

$.toast({
  title: 'Toast',
  subtitle: '11 mins ago',
  content: 'Hello, world! This is a toast message.',
  type: 'info',
  delay: 5000
});

Example #1

The respective markdown for the above would be:

<div class="toast" role="alert" aria-live="assertive" aria-atomic="true" data-delay="5000">
  <div class="toast-header bg-info text-white">
    <strong class="mr-auto">Toast</strong>
    <small class="text-white">11 mins ago</small>
    <button type="button" class="ml-2 mb-1 close" data-dismiss="toast" aria-label="Close">
      <span aria-hidden="true" class="text-white">&times;</span>
    </button>
  </div>
  <div class="toast-body">Hello, world! This is a toast message.</div>
</div>

To show a "snack" (a small version of the toast), simply omit the content property:

$.toast({
  title: 'A small bitesize snack, not a toast!',
  type: 'info',
  delay: 5000
});

Example Snack

Now, onto the different types:

Example #2

An 'info' toast

Example #3

A 'success' toast

Example #4

A 'warning' toast

Example #5

An 'error' toast

The toasts are stackable:

Example #6

Caveats

  • The toast will remain in the DOM when hidden, I am working on a way to incorperate removing them from the DOM or reusing existing ones if left in, however, for the time being, you can use the following to remove the toast once it is hidden from the DOM: - As of 2019-03-16, the toasts will be removed automatically from the DOM.
$('body').on('hidden.bs.toast', '.toast', function () {
  $(this).remove();
});

Roadmap

  • Allow img in toast as is shown in the Bootstrap 4 documentation - 2019-03-16
  • Allow the option to prevent stacking
  • Autoremove toast from DOM once hidden - 2019-03-16
  • Custom styling (rounded toasts, blocky toasts, custom background colours)
  • Positioning of the actual toast

Contributing

Feel free to contribute in any of the ways outlined:

  • Request features
  • Submit bug reports
  • Submit pull requests
  • Help by answering issues
  • Tell us if you are using the plugin in your project (it helps!)

Just a few guidelines (for now):

toast's People

Contributors

script47 avatar roalvesrj avatar draane avatar tip2tail avatar lolhens avatar lhns avatar

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.