bgaze/bootstrap4-dialogs

A collection of flexible dialogs based on Bootstrap 4 modals

2.0.0 2020-05-01 19:01 UTC

This package is auto-updated.

Last update: 2021-09-29 02:28:41 UTC


README

GitHub license Maintenance GitHub release (latest by date) GitHub stars npm

bootstrap4-dialogs

BSD is a tiny and flexible collection of dialog popups based on Bootstrap 4 modals.
Custom dialogs can be easily defined, in addition to built-in ones (alert, confirm and prompt).

Documentation

Full documentation and examples are available at https://packages.bgaze.fr/bootstrap4-dialogs

Quick start

BSD requires jQuery v1.9+ and Bootstrap 4 modal component.

Several quick start options are available:

  • Install with npm: npm i bgaze-bootstrap4-dialogs
  • Install with yarn: yarn add bgaze-bootstrap4-dialogs
  • Install via CDN: https://cdn.jsdelivr.net/gh/bgaze/bootstrap4-dialogs@2/dist/bootstrap4-dialogs.min.js
  • Install with Composer: composer require bgaze/bootstrap4-dialogs
  • Download the latest release: https://github.com/bgaze/bootstrap4-dialogs/releases
  • Clone the repo: git clone https://github.com/bgaze/bootstrap4-dialogs.git

Just make sure to include required dependencies into your app, then include the library:

  • If installed as a module, import it: const bsd = require("bgaze-bootstrap4-dialogs");
  • Otherwise include the script into your page: <script src="path/to/bootstrap4-dialogs.js"></script>

That's it! Now you can use the globally declared bsd object.

// Alert
bsd.alert('Lorem ipsum dolor sit amet');

// Confirm
bsd.confirm('Lorem ipsum dolor sit amet', function (confirmed) {
    if (confirmed) {
        // ...
    }
});

// Prompt
bsd.prompt('Lorem ipsum dolor sit amet', function (value) {
    if (value !== null) {
        if (value.trim() === '') {
            // Prevent dialog closing, as provided value is empty.
            return false;
        } 

        console.log(value);
    }
});