jQuery UI Button

Button enhances standard form elements like button, input of type submit or reset or anchors to themable buttons with appropiate mouseover and active styles.

In addition to basic push buttons, radio buttons and checkboxes (inputs of type radio and checkbox) can be converted to buttons: Their associated label is styled to appear as the button, while the underlying input is updated on click.

Buttons can be grouped using the buttonSet method, which should be always applied for radio buttons.

Dependencies

UI Core
UI Widget

A simple jQuery UI Button.

$("button").button();

<!DOCTYPE html>
<html>
<head>
  <link type="text/css" href="http://jqueryui.com/latest/themes/base/ui.all.css" rel="stylesheet" />
  <script type="text/javascript" src="http://jqueryui.com/latest/jquery-1.3.2.js"></script>
  <script type="text/javascript" src="http://jqueryui.com/latest/ui/jquery.ui.core.js"></script>
  <script type="text/javascript" src="http://jqueryui.com/latest/ui/jquery.ui.widget.js"></script>
  <script type="text/javascript" src="http://jqueryui.com/latest/ui/jquery.ui.button.js"></script>
  <script type="text/javascript">
  $(document).ready(function(){
    $("button").button();
  });
  </script>
</head>
<body style="font-size:62.5%;">
  
<button>Button label</button>

</body>
</html>

text

Type:

Boolean

Default:

true

Whether to show any text - when set to false (display no text), icons (see icons option) must be enabled, otherwise it'll be ignored.
Code examples
Initialize a button with the text option specified.
```
$('.selector').button({ text: false });
```
Get or set the text option, after init.
```
//getter
var text = $('.selector').button('option', 'text');
//setter
$('.selector').button('option', 'text', false);
```
icons

Type:

Options

Default:

{ primary: null, secondary: null }

Icons to display, with or without text (see text option). The primary icon is displayed on the left of the label text, the secondary on the right. Value for the primary and secondary properties must be a classname (String), eg. "ui-icon-gear". For using only a primary icon: icons: {primary:'ui-icon-locked'}. For using both primary and secondary icon: icons: {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'}
Code examples
Initialize a button with the icons option specified.
```
$('.selector').button({ icons: {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'} });
```
Get or set the icons option, after init.
```
//getter
var icons = $('.selector').button('option', 'icons');
//setter
$('.selector').button('option', 'icons', {primary:'ui-icon-gear',secondary:'ui-icon-triangle-1-s'});
```
label

Type:

String

Default:

HTML content of the button, or value attribute

Text to show on the button. When not specified (null), the element's html content is used, or its value attribute when it's an input element of type submit or reset; or the html content of the associated label element if its an input of type radio or checkbox
Code examples
Initialize a button with the label option specified.
```
$('.selector').button({ label: "custom label" });
```
Get or set the label option, after init.
```
//getter
var label = $('.selector').button('option', 'label');
//setter
$('.selector').button('option', 'label', "custom label");
```

click

Type:

click

Usually the native click event, with the exception of keyboard-triggered click with the space key on anchors and generally on checkboxes and radio buttons.
Code examples
Supply a callback function to handle the click event as an init option.
```
$('.selector').button({
   click: function(event, ui) { ... }
});
```
Bind to the click event by type: click.
```
$('.selector').bind('click', function(event, ui) {
  ...
});
```

destroy

Signature:

.button( 'destroy' )

Remove the button functionality completely. This will return the element back to its pre-init state.
disable

Signature:

.button( 'disable' )

Disable the button.
enable

Signature:

.button( 'enable' )

Enable the button.
option

Signature:

.button( 'option' , optionName , [value] )

Get or set any button option. If no value is specified, will act as a getter.

The jQuery UI Button plugin uses the jQuery UI CSS Framework to style its look and feel, including colors and background textures. We recommend using the ThemeRoller tool to create and download custom themes that are easy to build and maintain.

If a deeper level of customization is needed, there are widget-specific classes referenced within the ui.button.css stylesheet that can be modified. These classes are highlighed in bold below.

Sample markup with jQuery UI CSS Framework classes

<button class="ui-button ui-button-text-only ui-widget ui-state-default ui-corner-all"/><span class="ui-button-text">Button Label</span></button>

Note: This is a sample of markup generated by the button plugin, not markup you should use to create a button. The only markup needed for that is <button>Button Label</button>.

jQuery UI Button

Overview

Dependencies

Example

Options

text

Code examples

icons

Code examples

label

Code examples

Events

click

Code examples

Methods

destroy

disable

enable

option

Theming

Sample markup with jQuery UI CSS Framework classes