YUI Library Home

Site Search (YDN & YUIBlog):

# YUI Library Examples: Button Control: Checkbox Buttons

# Button Control: Checkbox Buttons

This example demonstrates different ways to create a Button that functions like an HTML checkbox (`<input type="checkbox"/>`).

View example in new window.

Checkbox Buttons
From Markup
From JavaScript

## Creating Checkbox Buttons

A Checkbox Button can be instantiated three different ways:

- Using an existing `<input type="checkbox"/>` element
- Using pre-defined Button Control HTML
- Using no existing HTML

### Using an existing `<input type="checkbox"/>` element

A Checkbox Button can be created using an existing `<input type="checkbox"/>` element as a source element, the attributes of which are captured and used for the creation of a new element that replaces the source element inline.

<input id="checkbutton1" type="checkbox" name="checkboxfield1" value="1" checked>

Pass the id of the source element as the first argument to the Button's constructor. Additional configuration attributes for a Button can be set at instantiation time by specifying them in an object literal that is passed as the second argument to the Button's constructor. Note: the value of configuration attributes passed to the Button constructor will trump those of the corresponding HTML attributes of the original source element.

var oCheckButton1 = new YAHOO.widget.Button("checkbutton1", { label:"One" });

### Using pre-defined Button Control HTML

A Checkbox Button can also be instantiated using pre-defined Button Control HTML: An element with a class of "yui-button" and "yui-checkbox-button" containing a element with a class of "first-child" containing a `<button/>` element:

<span id="checkbutton5" class="yui-button yui-checkbox-button"> <span class="first-child"> <button type="button" name="checkboxfield2">One</button> </span> </span>

To instantiate a Checkbox Button using the Button Control HTML, pass the id of the Button's root element (the element with the classes "yui-button" and "yui-checkbox-button" applied) as the first argument to constructor and any additional configuration attributes as the second argument via an object literal.

var oCheckButton5 = new YAHOO.widget.Button("checkbutton5", { type:"checkbox", value:"1", checked:true });

### Using no existing HTML

To build a Checkbox Button without any existing HTML, pass a set of configuration attributes as a single argument to the constructor using an object literal.

var oCheckButton9 = new YAHOO.widget.Button({ type: "checkbox", label: "One", id: "checkbutton9", name: "checkboxfield3", value: "1", container: "checkboxbuttonsfromjavascript", checked: true });

In most cases, it is necessary to specify the button's id, type, label and container (the HTML element that the button should be appended to once created). If an id is not specified for the button, one will be generated using the `generateId` method of the Dom utility. Similarly, if the "type" attribute is omitted, the default type of "button" will be applied.

## Configuration for This Example

You can load the necessary JavaScript and CSS for this example from Yahoo's servers. Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured.

### YUI Logger Output:

Note: You are viewing this example in debug mode with logging enabled. This can significantly slow performance.

Reload with logging
and debugging disabled.

### Button Control Examples:

### More Button Control Resources:

- User's Guide (external)
- API Documentation
- Cheat Sheet PDF (external)

Copyright © 2009 Yahoo! Inc. All rights reserved.

Privacy Policy - Terms of Service - Copyright Policy - Job Openings