2014-03-17 03:03:53 +01:00
< div class = "bs-docs-section" >
< h1 id = "buttons" class = "page-header" > Buttons < small > button.js< / small > < / h1 >
< h2 id = "buttons-examples" > Example uses< / h2 >
< p > Do more with buttons. Control button states or create groups of buttons for more components like toolbars.< / p >
< h4 > Stateful< / h4 >
< p > Add < code > data-loading-text="Loading..."< / code > to use a loading state on a button.< / p >
< div class = "bs-example" style = "padding-bottom: 24px;" >
< button type = "button" id = "loading-example-btn" data-loading-text = "Loading..." class = "btn btn-primary" >
Loading state
< / button >
< / div > <!-- /example -->
{% highlight html %}
< button type = "button" id = "loading-example-btn" data-loading-text = "Loading..." class = "btn btn-primary" >
Loading state
< / button >
< script >
$('#loading-example-btn').click(function () {
var btn = $(this)
btn.button('loading')
$.ajax(...).always(function () {
btn.button('reset')
});
});
< / script >
{% endhighlight %}
< h4 > Single toggle< / h4 >
< p > Add < code > data-toggle="button"< / code > to activate toggling on a single button.< / p >
< div class = "bs-example" style = "padding-bottom: 24px;" >
< button type = "button" class = "btn btn-primary" data-toggle = "button" > Single toggle< / button >
< / div > <!-- /example -->
{% highlight html %}
< button type = "button" class = "btn btn-primary" data-toggle = "button" > Single toggle< / button >
{% endhighlight %}
< h4 > Checkbox< / h4 >
< p > Add < code > data-toggle="buttons"< / code > to a group of checkboxes for checkbox style toggling on btn-group.< / p >
2014-04-03 04:55:05 +02:00
< div class = "bs-callout bs-callout-warning" >
< h4 > Pre-checked options need < code > .active< / code > < / h4 >
< p > For pre-checked options, you must add the < code > .active< / code > class to the input's < code > label< / code > yourself.< / p >
< / div >
2014-07-18 20:48:00 +02:00
< div class = "bs-callout bs-callout-warning" >
< h4 > Visual checked state only updated on click< / h4 >
< p > If the checked state of a checkbox button is updated without firing a < code > click< / code > event on the button (e.g. via < code > < input type="reset"> < / code > or via setting the < code > checked< / code > property of the input), you will need to toggle the < code > .active< / code > class on the input's < code > label< / code > yourself.< / p >
< / div >
2014-03-17 03:03:53 +01:00
< div class = "bs-example" style = "padding-bottom: 24px;" >
< div class = "btn-group" data-toggle = "buttons" >
2014-04-03 04:55:05 +02:00
< label class = "btn btn-primary active" >
2014-07-18 22:59:37 +02:00
< input type = "checkbox" autocomplete = "off" checked > Option 1 (pre-checked)
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "checkbox" autocomplete = "off" > Option 2
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "checkbox" autocomplete = "off" > Option 3
2014-03-17 03:03:53 +01:00
< / label >
< / div >
< / div > <!-- /example -->
{% highlight html %}
< div class = "btn-group" data-toggle = "buttons" >
2014-04-03 04:55:05 +02:00
< label class = "btn btn-primary active" >
2014-07-18 22:59:37 +02:00
< input type = "checkbox" autocomplete = "off" checked > Option 1 (pre-checked)
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "checkbox" autocomplete = "off" > Option 2
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "checkbox" autocomplete = "off" > Option 3
2014-03-17 03:03:53 +01:00
< / label >
< / div >
{% endhighlight %}
< h4 > Radio< / h4 >
< p > Add < code > data-toggle="buttons"< / code > to a group of radio inputs for radio style toggling on btn-group.< / p >
2014-04-03 04:55:05 +02:00
< div class = "bs-callout bs-callout-warning" >
< h4 > Preselected options need < code > .active< / code > < / h4 >
< p > For preselected options, you must add the < code > .active< / code > class to the input's < code > label< / code > yourself.< / p >
< / div >
2014-07-18 20:48:00 +02:00
< div class = "bs-callout bs-callout-warning" >
< h4 > Visual checked state only updated on click< / h4 >
< p > If the checked state of a radio button is updated without firing a < code > click< / code > event on the button (e.g. via < code > < input type="reset"> < / code > or via setting the < code > checked< / code > property of the input), you will need to toggle the < code > .active< / code > class on the input's < code > label< / code > yourself.< / p >
< / div >
2014-03-17 03:03:53 +01:00
< div class = "bs-example" style = "padding-bottom: 24px;" >
< div class = "btn-group" data-toggle = "buttons" >
2014-04-03 04:55:05 +02:00
< label class = "btn btn-primary active" >
2014-07-18 22:59:37 +02:00
< input type = "radio" name = "options" id = "option1" autocomplete = "off" checked > Option 1 (preselected)
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "radio" name = "options" id = "option2" autocomplete = "off" > Option 2
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "radio" name = "options" id = "option3" autocomplete = "off" > Option 3
2014-03-17 03:03:53 +01:00
< / label >
< / div >
< / div > <!-- /example -->
{% highlight html %}
< div class = "btn-group" data-toggle = "buttons" >
2014-04-03 04:55:05 +02:00
< label class = "btn btn-primary active" >
2014-07-18 22:59:37 +02:00
< input type = "radio" name = "options" id = "option1" autocomplete = "off" checked > Option 1 (preselected)
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "radio" name = "options" id = "option2" autocomplete = "off" > Option 2
2014-03-17 03:03:53 +01:00
< / label >
< label class = "btn btn-primary" >
2014-07-18 22:59:37 +02:00
< input type = "radio" name = "options" id = "option3" autocomplete = "off" > Option 3
2014-03-17 03:03:53 +01:00
< / label >
< / div >
{% endhighlight %}
< h2 id = "buttons-usage" > Usage< / h2 >
< p > Enable buttons via JavaScript:< / p >
{% highlight js %}
$('.btn').button()
{% endhighlight %}
< h3 > Markup< / h3 >
< p > Data attributes are integral to the button plugin. Check out the example code below for the various markup types.< / p >
< h3 > Options< / h3 >
< p > < em > None< / em > < / p >
< h3 > Methods< / h3 >
< h4 > $().button('toggle')< / h4 >
< p > Toggles push state. Gives the button the appearance that it has been activated.< / p >
< div class = "bs-callout bs-callout-info" >
< h4 > Auto toggling< / h4 >
< p > You can enable auto toggling of a button by using the < code > data-toggle< / code > attribute.< / p >
< / div >
{% highlight html %}
< button type = "button" class = "btn btn-primary" data-toggle = "button" > ...< / button >
{% endhighlight %}
< h4 > $().button('loading')< / h4 >
< p > Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute < code > data-loading-text< / code > .
< / p >
{% highlight html %}
< button id = "loading-example-btn" type = "button" class = "btn btn-primary" data-loading-text = "loading stuff..." > ...< / button >
< script >
$('#loading-example-btn').click(function () {
var btn = $(this)
btn.button('loading')
$.ajax(...).always(function () {
btn.button('reset')
});
});
< / script >
{% endhighlight %}
< div class = "bs-callout bs-callout-danger" >
< h4 > Cross-browser compatibility< / h4 >
2014-07-18 23:01:33 +02:00
< p > < a href = "https://github.com/twbs/bootstrap/issues/793" > Firefox persists form control states (disabledness and checkedness) across page loads< / a > . A workaround for this is to use < code > autocomplete="off"< / code > .< / p >
2014-03-17 03:03:53 +01:00
< / div >
< h4 > $().button('reset')< / h4 >
< p > Resets button state - swaps text to original text.< / p >
< h4 > $().button(string)< / h4 >
< p > Resets button state - swaps text to any data defined text state.< / p >
{% highlight html %}
< button type = "button" class = "btn btn-primary" data-complete-text = "finished!" > ...< / button >
< script >
$('.btn').button('complete')
< / script >
{% endhighlight %}
< / div >