140 lines
6.1 KiB
HTML
140 lines
6.1 KiB
HTML
|
<div class="bs-docs-section">
|
||
|
<h1 id="buttons" class="page-header">Buttons <small>button.js</small></h1>
|
||
|
|
||
|
<p class="lead">Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
|
||
|
|
||
|
<div class="bs-callout bs-callout-danger" id="callout-buttons-ff-autocomplete">
|
||
|
<h4>Cross-browser compatibility</h4>
|
||
|
<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>. See <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=654072">Mozilla bug #654072</a>.</p>
|
||
|
</div>
|
||
|
|
||
|
<h2 id="buttons-stateful">Stateful</h2>
|
||
|
<p>Add <code>data-loading-text="Loading..."</code> to use a loading state on a button.</p>
|
||
|
<p><strong class="text-danger">This feature is deprecated since v3.3.5 and has been removed in v4.</strong></p>
|
||
|
<div class="bs-callout bs-callout-info" id="callout-buttons-state-names">
|
||
|
<h4>Use whichever state you like!</h4>
|
||
|
<p>For the sake of this demonstration, we are using <code>data-loading-text</code> and <code>$().button('loading')</code>, but that's not the only state you can use. <a href="#buttons-methods">See more on this below in the <code>$().button(string)</code> documentation</a>.</p>
|
||
|
</div>
|
||
|
<div class="bs-example">
|
||
|
<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="myButton" data-loading-text="Loading..." class="btn btn-primary">
|
||
|
Loading state
|
||
|
</button>
|
||
|
|
||
|
<script>
|
||
|
$('#myButton').on('click', function () {
|
||
|
var $btn = $(this).button('loading')
|
||
|
// business logic...
|
||
|
$btn.button('reset')
|
||
|
})
|
||
|
</script>
|
||
|
{% endhighlight %}
|
||
|
|
||
|
<h2 id="buttons-single-toggle">Single toggle</h2>
|
||
|
<p>Add <code>data-toggle="button"</code> to activate toggling on a single button.</p>
|
||
|
<div class="bs-callout bs-callout-warning" id="callout-buttons-single-pretoggled">
|
||
|
<h4>Pre-toggled buttons need <code>.active</code> and <code>aria-pressed="true"</code></h4>
|
||
|
<p>For pre-toggled buttons, you must add the <code>.active</code> class and the <code>aria-pressed="true"</code> attribute to the <code>button</code> yourself.</p>
|
||
|
</div>
|
||
|
<div class="bs-example">
|
||
|
<button type="button" class="btn btn-primary" data-toggle="button" aria-pressed="false">
|
||
|
Single toggle
|
||
|
</button>
|
||
|
</div><!-- /example -->
|
||
|
{% highlight html %}
|
||
|
<button type="button" class="btn btn-primary" data-toggle="button" aria-pressed="false">
|
||
|
Single toggle
|
||
|
</button>
|
||
|
{% endhighlight %}
|
||
|
|
||
|
<h2 id="buttons-checkbox-radio">Checkbox / Radio</h2>
|
||
|
<p>Add <code>data-toggle="buttons"</code> to a <code>.btn-group</code> containing checkbox or radio inputs to enable toggling in their respective styles.</p>
|
||
|
<div class="bs-callout bs-callout-warning" id="callout-buttons-multi-preselected">
|
||
|
<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>
|
||
|
<div class="bs-callout bs-callout-warning" id="callout-buttons-only-click">
|
||
|
<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>
|
||
|
<div class="bs-example" data-example-id="buttons-checkbox">
|
||
|
<div class="btn-group" data-toggle="buttons">
|
||
|
<label class="btn btn-primary active">
|
||
|
<input type="checkbox" checked> Checkbox 1 (pre-checked)
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="checkbox"> Checkbox 2
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="checkbox"> Checkbox 3
|
||
|
</label>
|
||
|
</div>
|
||
|
</div><!-- /example -->
|
||
|
{% highlight html %}
|
||
|
<div class="btn-group" data-toggle="buttons">
|
||
|
<label class="btn btn-primary active">
|
||
|
<input type="checkbox" checked> Checkbox 1 (pre-checked)
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="checkbox"> Checkbox 2
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="checkbox"> Checkbox 3
|
||
|
</label>
|
||
|
</div>
|
||
|
{% endhighlight %}
|
||
|
|
||
|
<div class="bs-example" data-example-id="buttons-radio">
|
||
|
<div class="btn-group" data-toggle="buttons">
|
||
|
<label class="btn btn-primary active">
|
||
|
<input type="radio" name="options" id="option1" checked> Radio 1 (preselected)
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="radio" name="options" id="option2"> Radio 2
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="radio" name="options" id="option3"> Radio 3
|
||
|
</label>
|
||
|
</div>
|
||
|
</div><!-- /example -->
|
||
|
{% highlight html %}
|
||
|
<div class="btn-group" data-toggle="buttons">
|
||
|
<label class="btn btn-primary active">
|
||
|
<input type="radio" name="options" id="option1" checked> Radio 1 (preselected)
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="radio" name="options" id="option2"> Radio 2
|
||
|
</label>
|
||
|
<label class="btn btn-primary">
|
||
|
<input type="radio" name="options" id="option3"> Radio 3
|
||
|
</label>
|
||
|
</div>
|
||
|
{% endhighlight %}
|
||
|
|
||
|
<h2 id="buttons-methods">Methods</h2>
|
||
|
<h4><code>$().button('toggle')</code></h4>
|
||
|
<p>Toggles push state. Gives the button the appearance that it has been activated.</p>
|
||
|
|
||
|
<h4><code>$().button('reset')</code></h4>
|
||
|
<p>Resets button state - swaps text to original text. <strong>This method is asynchronous and returns before the resetting has actually completed.</strong></p>
|
||
|
|
||
|
<h4><code>$().button(string)</code></h4>
|
||
|
<p>Swaps text to any data defined text state.</p>
|
||
|
|
||
|
{% highlight html %}
|
||
|
<button type="button" id="myStateButton" data-complete-text="finished!" class="btn btn-primary">
|
||
|
...
|
||
|
</button>
|
||
|
|
||
|
<script>
|
||
|
$('#myStateButton').on('click', function () {
|
||
|
$(this).button('complete') // button text will be "finished!"
|
||
|
})
|
||
|
</script>
|
||
|
{% endhighlight %}
|
||
|
</div>
|