toggle_bool.md

Toggleable Bool Column

This addon features switches to toggle boolean attributes values directly at the index, avoiding the need of going the long way through the edit view to update a record.

Usage

Simply use toggle_bool_column at the index like this:

index do
  toggle_bool_column :paid
end

The column label can be customized the same way as most column types:

toggle_bool_column 'Payment OK', :paid

Important

The value update is done through the default update route, so you must check you have:

• The update action enabled for the resource in its admin
• The attribute listed among permit_params

Here is described how both things go

Conditionally show switch

In some cases we want the switch to be present not in every row, but only for certain records.

For this use the options if or unless.

Records that don't match the condition will just show nothing in this column:

toggle_bool_column :paid, if: proc { |item| item.price.present? }

toggle_bool_column :paid, unless: proc { |item| item.is_free? }

Confirmation message

Optionally, you can provide a confirmation message to the user before updating the value.

This is disabled by default, but can be enabled by adding the confirm_message option. Optionally, you can add the confirm_message_trigger option to choose when to toggle the confirm message, possible values are:

• both (default),
• on
• off

toggle_bool_column :paid, confirm_message: 'Are you sure you want to toggle this switch?', confirm_message_trigger: 'on'

If the user cancels the confirmation, the update action will be aborted.

Success message

Optionally a js alert dialog can be prompted to the user upon update success.

This is disabled by default, but can be enabled by adding the option success_message

toggle_bool_column :paid, success_message: 'Item Updated Successfully!'

If the update fails for any reason, an "Error: Update Failed" alert will be prompted (this can't be disabled nor customized)