README.md

Twitter::Bootstrap::Rails::Confirm

This gem adds some javascript to change the default behaviour of data-confirm processing for both Boostrap 2, 3 and 4.

The normal confirm dialog shows a text with buttons 'ok' and 'cancel'. More information is needed here for a user to make the right decision. This gem therefore also adds:

• data-confirm-fade (default: false)
• data-confirm-title (default: window.top.location.origin)
• data-confirm-cancel (default: 'cancel')
• data-confirm-cancel-class (default: 'btn cancel')
• data-confirm-proceed (default: 'ok')
• data-confirm-proceed-class (default: 'btn-primary')

This behaviour is similar to that of a "regular" confirm box in ways that it uses the same title and button labels. Defaults can be changed in two ways:

Changing all default values:

$.fn.twitter_bootstrap_confirmbox.defaults = {
  fade: false,
  title: null, // if title equals null window.top.location.origin is used
  cancel: "Cancel",
  cancel_class: "btn cancel",
  proceed: "OK",
  proceed_class: "btn proceed btn-primary",
  modal_class: ""
};

Only changing one default value:

$.fn.twitter_bootstrap_confirmbox.defaults.proceed_class = "btn proceed btn-success";

Installation

Add this line to your application's Gemfile:

gem 'twitter-bootstrap-rails-confirm'

And then execute:

$ bundle

Note: jQuery-Rails should be > 2.2.1. The exact required version has not yet been determined.

Usage

Add it to your application.js, anywhere after you require jquery_ujs:

//= require twitter/bootstrap/rails/confirm

Next... nothing. There is nothing you need to do to get this working. A helper could be useful for handling large amount of destroy buttons:

def destroy_link_to(path, options)
  link_to t('.destroy'), path,
    :method => :delete,
    :class => 'btn',
    :confirm => t('.destroy_confirm.body', :item => options[:item]),
    'data-confirm-fade' => true,
    'data-confirm-title' => t('.destroy_confirm.title', :item => options[:item]),
    'data-confirm-cancel' => t('.destroy_confirm.cancel', :item => options[:item]),
    'data-confirm-cancel-class' => 'btn-default'),
    'data-confirm-proceed' => t('.destroy_confirm.proceed', :item => options[:item]),
    'data-confirm-proceed-class' => 'btn-danger'
end

Testing

See Twitter Bootstrap Rails Confirm Test for a simple app that loads Bootstrap and this gem.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Changelog

2.0.2 (January 18, 2022)

• BREAKING: Resolved possible XSS by using .text() over .html()

2.0.1 (January 14, 2018)

• (eirvandelden) Bootstrap 4 version is stored in Tooltip.VERSION

2.0.0 (April 26, 2018)

• (mftaff) Convert CoffeeScript to JavaScript

1.0.7 (November 24, 2017)

• (thiesp) Adding template and setting default cancel class to btn-secondary for bootstrap 4

1.0.6 (June 9, 2016)

• (rvanlieshout) Added proper events for Bootstrap 3

1.0.5 (February 5, 2016)

• (marceuy) Added option for styling dialog
• (joseramonc) Confirm dialog on enter keypress

1.0.4 (November 25, 2014)

• (rvanlieshout) Added bootstrap 3 support

1.0.3 (September 4, 2014)

• (rvanlieshout) Problems with using event constructors
• (stevelacey) Avoid appending custom proceed class to btn-primary, refactored dialog JS
• (zsy056) When message is numerical, the call replace on message will cause a TypeError

1.0.2 (Oktober 11, 2013)

• (kramerc) Prevent the default action on the modal's buttons.
• (taavo) click handler returns false
• (stevelacey) Swap out new lines for br's in message
• (DavyCardinaal) Confirmbox defaults: Cancel button btn-default (Bootstrap 3 only)
• (digitalfrost) Create "click" event using an event constructor

1.0.1 (April 23, 2013)

• (kramerc) Add an option for including the fade class
• (taavo) Load asap

1.0.0 (February 22, 2013)

• First 'official' release
• Many thanks to taavo for his contributions