YUI Library Examples: Button Control: Radio Buttons

Creating Radio Buttons

The ButtonGroup class creates a set of Buttons that are mutually exclusive; checking one button in the group will uncheck all others in the group. The ButtonGroup class is defined by YAHOO.widget.ButtonGroup and a ButtonGroup's root HTML element is a <div/>.

A ButtonGroup can be instantiated three different ways:

Using an existing set of <input type="radio"/> elements
Using an existing set of Buttons defined using Button Control HTML
Using no existing HTML

Using an existing set of `<input type="radio"/>` elements

A ButtonGroup can be created from a set of existing <input type="radio"/> elements:


1	<div id="buttongroup1" class="yui-buttongroup">
2	<input id="radio1" type="radio" name="radiofield1" value="Radio 1" checked>
3	<input id="radio2" type="radio" name="radiofield1" value="Radio 2">
4	<input id="radio3" type="radio" name="radiofield1" value="Radio 3">
5	<input id="radio4" type="radio" name="radiofield1" value="Radio 4">
6	</div>
	view plain \| print \| ?

To instantiate a ButtonGroup from existing HTML, pass the id of the ButtonGroup's <div/> element as the first argument to the ButtonGroup constructor and any additional configuration attributes as the second argument via an object literal. The ButtonGroup will automatically search its child nodes for HTML radio buttons (<input type="radio"/>) and use those elements to create instances of YAHOO.widget.Button of type "radio."


1	var oButtonGroup1 = new YAHOO.widget.ButtonGroup("buttongroup1")
	view plain \| print \| ?

Using an existing set of Buttons defined using Button Control HTML

Alternatively, each Button in a ButtonGroup can be defined using the YUI Button HTML: An element with a class of "yui-button" and "yui-radio-button" containing a element with a class of "first-child" containing a <button/> element.


1	<div id="buttongroup2" class="yui-buttongroup">
2	<span id="radio5" class="yui-button yui-radio-button yui-button-checked">
3	<span class="first-child">
4	<button type="button" name="radiofield2" value="Radio 5">
5	Radio 5
6	</button>
7	</span>
8	</span>
9	<span id="radio6" class="yui-button yui-radio-button">
10	<span class="first-child">
11	<button type="button" name="radiofield2" value="Radio 6">
12	Radio 6
13	</button>
14	</span>
15	</span>
16	<span id="radio7" class="yui-button yui-radio-button">
17	<span class="first-child">
18	<button type="button" name="radiofield2" value="Radio 7">
19	Radio 7
20	</button>
21	</span>
22	</span>
23	<span id="radio8" class="yui-button yui-radio-button">
24	<span class="first-child">
25	<button type="button" name="radiofield2" value="Radio 8">
26	Radio 8
27	</button>
28	</span>
29	</span>
30	</div>
	view plain \| print \| ?

<div id="buttongroup2" class="yui-buttongroup">
    <span id="radio5" class="yui-button yui-radio-button yui-button-checked">
        <span class="first-child">
            <button type="button" name="radiofield2" value="Radio 5">
                Radio 5
            </button>
        </span>
    </span>
    <span id="radio6" class="yui-button yui-radio-button">
        <span class="first-child">
            <button type="button" name="radiofield2" value="Radio 6">
                Radio 6
            </button>
        </span>
    </span>
    <span id="radio7" class="yui-button yui-radio-button">
        <span class="first-child">
            <button type="button" name="radiofield2" value="Radio 7">
                Radio 7
            </button>
        </span>
    </span>
    <span id="radio8" class="yui-button yui-radio-button">
        <span class="first-child">
            <button type="button" name="radiofield2" value="Radio 8">
                Radio 8
            </button>
        </span>
    </span>
</div>

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


1	var oButtonGroup2 = new YAHOO.widget.ButtonGroup("buttongroup2");
	view plain \| print \| ?

Using no existing HTML

To build a ButtonGroup with no existing HTML, pass a set of configuration attributes as a single argument to the ButtonGroup constructor using an object literal. Add buttons to the ButtonGroup via the addButton or addButtons methods.


1	var oButtonGroup3 = new YAHOO.widget.ButtonGroup({
2	id: "buttongroup3",
3	name: "radiofield3",
4	container: "radiobuttonsfromjavascript" });
5
6	oButtonGroup3.addButtons([
7
8	{ label: "Radio 9", value: "Radio 9", checked: true },
9	{ label: "Radio 10", value: "Radio 10" },
10	{ label: "Radio 11", value: "Radio 11" },
11	{ label: "Radio 12", value: "Radio 12" }
12
13	]);
	view plain \| print \| ?

In most cases, it is necessary to specify the ButtonGroup's id and container (the HTML element that the ButtonGroup should be appended to once created). If an id is not specified for the ButtonGroup, one will be generated using the generateId method of the Dom utility.

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.

More Button Control Resources:

All YUI 2.x users should review the YUI 2.8.2 security bulletin, which discusses a vulnerability present in YUI 2.4.0-2.8.1.