|
| 1 | +--- |
| 2 | +title: ButtonGroup |
| 3 | +page_title: Configuration, methods and events of Kendo UI ButtonGroup |
| 4 | +description: Learn how to define the initially selected button, select a button and get the currently selected button. |
| 5 | +res_type: api |
| 6 | +--- |
| 7 | + |
| 8 | +# kendo.ui.ButtonGroup |
| 9 | + |
| 10 | +## Configuration |
| 11 | + |
| 12 | +### enable `Boolean` *(default: true)* |
| 13 | + |
| 14 | +Defines if the widget is initially enabled or disabled. By default, it is enabled. |
| 15 | + |
| 16 | +#### Example |
| 17 | + |
| 18 | + <ul id="buttongroup"> |
| 19 | + <li>Option 1</li> |
| 20 | + <li>Option 2</li> |
| 21 | + <li>Option 3</li> |
| 22 | + </ul> |
| 23 | + |
| 24 | + <script> |
| 25 | + $("#buttongroup").kendoButtonGroup({ |
| 26 | + enable: false |
| 27 | + }); |
| 28 | + </script> |
| 29 | + |
| 30 | +### index `Number` |
| 31 | + |
| 32 | +Defines the initially selected Button (zero based index). |
| 33 | + |
| 34 | +#### Example |
| 35 | + |
| 36 | + <ul id="buttongroup"> |
| 37 | + <li>Option 1</li> |
| 38 | + <li>Option 2</li> |
| 39 | + <li>Option 3</li> |
| 40 | + </ul> |
| 41 | + |
| 42 | + <script> |
| 43 | + $("#buttongroup").kendoButtonGroup({ |
| 44 | + index: 1 |
| 45 | + }); |
| 46 | + </script> |
| 47 | + |
| 48 | +### selection `String` *(default "single")* |
| 49 | + |
| 50 | +Defines the selection type. |
| 51 | + |
| 52 | +#### Example |
| 53 | + |
| 54 | + <ul id="buttongroup"> |
| 55 | + <li>Option 1</li> |
| 56 | + <li>Option 2</li> |
| 57 | + <li>Option 3</li> |
| 58 | + </ul> |
| 59 | + |
| 60 | + <script> |
| 61 | + $("#buttongroup").kendoButtonGroup({ |
| 62 | + selection: "multiple" |
| 63 | + }); |
| 64 | + </script> |
| 65 | + |
| 66 | +## Methods |
| 67 | + |
| 68 | +### badge |
| 69 | + |
| 70 | +#### Parameters |
| 71 | + |
| 72 | +##### button `Selector|Number` |
| 73 | + |
| 74 | +The target button specified either as a jQuery selector/object or as an button index. |
| 75 | + |
| 76 | +##### value `String|Boolean` |
| 77 | + |
| 78 | +The target value to be set or false to be removed. |
| 79 | + |
| 80 | +#### Returns |
| 81 | + |
| 82 | +`String|kendo.ui.Button` the badge value if invoked without parameters, otherwise the ButtonGroup object. |
| 83 | + |
| 84 | +#### Example |
| 85 | + |
| 86 | + <ul id="buttongroup"> |
| 87 | + <li>Option 1</li> |
| 88 | + <li>Option 2</li> |
| 89 | + <li>Option 3</li> |
| 90 | + </ul> |
| 91 | + |
| 92 | + <script> |
| 93 | + var buttonGroup = $("#buttongroup").kendoButtonGroup({ |
| 94 | + select: function(e) { |
| 95 | + console.log("selected index:" + e.index); |
| 96 | + }, |
| 97 | + enable: false, |
| 98 | + index: 0 |
| 99 | + }).data("kendoButtonGroup"); |
| 100 | + |
| 101 | + buttonGroup.badge(0,5); |
| 102 | + </script> |
| 103 | + |
| 104 | +### current |
| 105 | + |
| 106 | +Get the currently selected Button. |
| 107 | + |
| 108 | +#### Returns |
| 109 | + |
| 110 | +`jQuery` the jQuery object representing the currently selected button. |
| 111 | + |
| 112 | +#### Example - get the index of the currently selected Button |
| 113 | + |
| 114 | + <ul id="buttongroup"> |
| 115 | + <li>Option 1</li> |
| 116 | + <li>Option 2</li> |
| 117 | + <li>Option 3</li> |
| 118 | + </ul> |
| 119 | + |
| 120 | + <script> |
| 121 | + $("#buttongroup").kendoButtonGroup({ |
| 122 | + select: function(e) { |
| 123 | + var index = this.current().index(); |
| 124 | + console.log(index); |
| 125 | + } |
| 126 | + }); |
| 127 | + </script> |
| 128 | + |
| 129 | +### destroy |
| 130 | + |
| 131 | +Prepares the **ButtonGroup** for safe removal from DOM. Detaches all event handlers and removes jQuery.data attributes to avoid memory leaks. Calls destroy method of any child Kendo widgets. |
| 132 | + |
| 133 | +> **Important:** This method does not remove the ButtonGroup element from DOM. |
| 134 | +
|
| 135 | +#### Example |
| 136 | + |
| 137 | + <ul id="buttongroup"> |
| 138 | + <li>Option 1</li> |
| 139 | + <li>Option 2</li> |
| 140 | + <li>Option 3</li> |
| 141 | + </ul> |
| 142 | + |
| 143 | + <a onclick="destroy">Destroy the ButtonGroup</a> |
| 144 | + |
| 145 | + <script> |
| 146 | + $("#buttongroup").kendoButtonGroup(); |
| 147 | + |
| 148 | + function destroy() { |
| 149 | + $("#buttongroup").data("kendoButtonGroup").destroy(); //detach events |
| 150 | + $("#buttongroup").remove(); //remove the button group from the DOM |
| 151 | + } |
| 152 | + </script> |
| 153 | + |
| 154 | +### enable |
| 155 | + |
| 156 | +Enables or disables the widget. |
| 157 | + |
| 158 | +#### Parameters |
| 159 | + |
| 160 | +##### enable `Boolean` |
| 161 | + |
| 162 | +A boolean flag that indicates whether the widget should be enabled or disabled. |
| 163 | + |
| 164 | +#### Example |
| 165 | + |
| 166 | + <a onclick="enable">Enable</a> |
| 167 | + <ul id="buttongroup"> |
| 168 | + <li>Option 1</li> |
| 169 | + <li>Option 2</li> |
| 170 | + <li>Option 3</li> |
| 171 | + </ul> |
| 172 | + |
| 173 | + <script> |
| 174 | + $("#buttongroup").kendoButtonGroup({ |
| 175 | + enable: false |
| 176 | + }); |
| 177 | + function enable() { |
| 178 | + $("#btnGroup").data("kendoButtonGroup").enable(true); |
| 179 | + } |
| 180 | + </script> |
| 181 | + |
| 182 | +### select |
| 183 | + |
| 184 | +Select a Button. |
| 185 | + |
| 186 | +#### Parameters |
| 187 | + |
| 188 | +##### li `jQuery | Number` |
| 189 | + |
| 190 | +LI element or index of the Button. |
| 191 | + |
| 192 | +#### Example |
| 193 | + |
| 194 | + <ul id="buttongroup"> |
| 195 | + <li>Option 1</li> |
| 196 | + <li>Option 2</li> |
| 197 | + <li>Option 3</li> |
| 198 | + </ul> |
| 199 | + |
| 200 | + |
| 201 | + <script> |
| 202 | + var buttongroup = $("#buttongroup").kendoButtonGroup().data("kendoButtonGroup"); |
| 203 | + |
| 204 | + // selects by jQuery object |
| 205 | + buttongroup.select(buttongroup.element.children().eq(0)); |
| 206 | + // selects by index |
| 207 | + buttongroup.select(1); |
| 208 | + </script> |
| 209 | + |
| 210 | +## Events |
| 211 | + |
| 212 | +### select |
| 213 | + |
| 214 | +Fires when a Button is selected. |
| 215 | + |
| 216 | +#### Example - get the index of the currently selected Button |
| 217 | + |
| 218 | + <ul id="buttongroup"> |
| 219 | + <li>Option 1</li> |
| 220 | + <li>Option 2</li> |
| 221 | + <li>Option 3</li> |
| 222 | + </ul> |
| 223 | + |
| 224 | + <script> |
| 225 | + $("#buttongroup").kendoButtonGroup({ |
| 226 | + select: function(e) { |
| 227 | + var index = this.current().index(); |
| 228 | + console.log(index); |
| 229 | + } |
| 230 | + }); |
| 231 | + </script> |
| 232 | + |
| 233 | +#### Event Data |
| 234 | + |
| 235 | +##### e.index `Number` |
| 236 | + |
| 237 | +The index of the selected button |
0 commit comments