bootstrap-show-toast

A Bootstrap 5 plugin for Bootstrap Toasts, to show them with pure JS, no HTML needed.

References

Installation

npm install bootstrap-show-toast

Usage

// simple example
bootstrap.showToast({body: "Hello Toast!"})

// type danger
bootstrap.showToast({
    header: "Alert",
    body: "Red Alert!",
    toastClass: "text-bg-danger"
})

// more complex toast with header and buttons
const toast = bootstrap.showToast({
    header: "Information",
    headerSmall: "just now",
    body: "<p>This notification has a headline and more text than the previous one.</p><div><button class='btn btn-primary me-1 btn-sm'>Click me</button><button class='btn btn-secondary btn-sm' data-bs-dismiss='toast'>Close</button></div>",
    delay: 20000
})
toast.element.querySelector(".btn-primary").addEventListener("click", () => {
    bootstrap.showToast({
        body: "Thank you for clicking", direction: "append", 
        toastClass: "text-bg-success", closeButtonClass: "btn-close-white"
    })
})

// type secondary and sticky
bootstrap.showToast({
    body: "This notification will stay", 
    toastClass: "text-bg-secondary", closeButtonClass: "btn-close-white", 
    delay: Infinity // delay of `Infinity` to make it sticky
})

Props (defaults)

this.props = {
    header: "", // the header text
    headerSmall: "", // additional text in the header, aligns right
    body: "", // the body text of the toast
    closeButton: true, // show a close button
    closeButtonLabel: "close", // the label of the close button
    closeButtonClass: "", // set to "btn-close-white" for dark backgrounds
    toastClass: "", // the appearance
    animation: true, // apply a CSS fade transition to the toast
    delay: 5000, //	delay in milliseconds before hiding the toast, set delay to `Infinity` to make it sticky
    position: "top-0 end-0", // top right
    direction: "append", // or "prepend", the stack direction
    ariaLive: "assertive"
}

Find more high quality modules from shaack.com on our projects page.

License

shaack/bootstrap-show-toast

ErrorLooks like something went wrong!

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages