Skip to content

Latest commit

 

History

History
93 lines (66 loc) · 4.33 KB

README.md

File metadata and controls

93 lines (66 loc) · 4.33 KB
Raw

Bootbox - Bootstrap powered alert, confirm and flexible dialog boxes

Please see http://bootboxjs.com for full usage instructions, or head over to http://paynedigital.com/bootbox for the original writeup about the project.

Contact

Gitter

The easiest thing is to find me on twitter @makeusabrew.

Contributing

Please see the CONTRIBUTING file for guidelines.

Running Tests Build Status

Tests are run using Karma using the Mocha test adapter. To run the tests yourself, simply run npm install within the project followed by npm test. Please note that this will require PhantomJS being installed and in your path - if it is not, you may run the tests and capture browsers manually by running karma start from the root of the project.

The project is also hosted on Travis CI - when submitting pull requests please ensure your tests pass as failing requests will be rejected. See the CONTRIBUTING file for more information.

Building a minified release

The repository no longer contains a minified bootbox.min.js file - this is now only generated for releases. To build your own minified copy for use in development simply run npm install if you haven't already, followed by grunt uglify. This will generate a bootbox.min.js file in your working directory.

A note on Bootstrap dependencies

Bootbox 4.0.0 is the first release to support Bootstrap 3.0.0.

Bootbox 3.3.0 is the last release to support Bootstrap 2.2.x.

Much more dependency information can be found on the Bootbox website.

Roadmap

The latest major release of Bootbox - 4.0.0 - involved a total rewrite of the internal code and introduced an entirely new public API. It has not re-implemented some functionality from the 3.x series as of yet; this will be addressed in the the form of new minor releases. Please feel free to add feedback and requests.

There is no new major (e.g. 5.x) release on the roadmap at present.

Latest Release: 4.4.0

  • Allow backdrop options of true and false to dismiss modals
  • Pass dialog as this value in callbacks
  • Bootstrap 3.3.2 compatibility
  • jQuery 1.11.2 compatibility
  • Add support for maxlength prompt input attribute
  • Gracefully detect lack of Bootstrap library rather than crashing
  • Expose addLocale and removeLocale for custom locale settings
  • Expose setLocale helper to select a locale rather than using setDefaults("locale", ...)
  • Add Hungarian locale
  • Add Croatian locale
  • Add Bulgarian locale
  • Add Thai locale
  • Add Persian locale
  • Add Albanian locale

For a full list of releases and changes please see the changelog.

License

(The MIT License)

Copyright (C) 2011-2015 by Nick Payne nick@kurai.co.uk

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE