Back to Tooljet

Button Group

docs/versioned_docs/version-2.50.0-LTS/widgets/button-group.md

3.20.154-lts5.1 KB
Original Source

Button Group

The Button Group component is used to group a series of buttons together in a single line. It is used to group related buttons.

<div style={{textAlign: 'left'}}> </div> <div style={{paddingTop:'24px'}}>

Properties

<div style={{ width:"100px"}}> Properties </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
labelSets the title of the button-group.Any String value: Select the options or {{queries.queryname.data.text}}.
valuesSets the values of the Button Group items.Array of strings and numbers: {{[1,2,3]}}.
LabelsSets the labels of the Button Group items.Array of strings and numbers: {{['A','B','C']}}.
Default selectedSets the initial selected values.Array of strings and numbers: {{[1]}} will select the first button by default.
Enable multiple selectionToggle on or off to enable multiple selection.Boolean value: {{true}} or {{false}}.
</div> <div style={{paddingTop:'24px'}}>

Events

<div style={{ width:"100px"}}> Events </div><div style={{ width:"100px"}}> Description </div>
On clickTriggers whenever the user clicks on the button in the Button Group.

:::info Check Action Reference docs to get the detailed information about all the Actions. :::

</div> <div style={{paddingTop:'24px'}}>

Component Specific Actions (CSA)

There are currently no CSA (Component-Specific Actions) implemented to regulate or control the button-group component.

</div> <div style={{paddingTop:'24px'}}>

Exposed Variables

<div style={{ width:"100px"}}> Variable </div><div style={{ width:"200px"}}> Description </div><div style={{ width:"135px"}}> How To Access </div>
selectedHolds the currently selected button value as an array of objects.Accessible dynamically with JS (for e.g., {{components.buttongroup1.selected[0]}} or {{components.buttongroup1.selected}}).
</div> <div style={{paddingTop:'24px'}}>

General

Tooltip

A Tooltip is often used to display additional information when the user hovers the mouse pointer over the component. Once a value is set for Tooltip, hovering over the element will display the specified string as the tooltip text.

<div style={{textAlign: 'center'}}> </div> </div> <div style={{paddingTop:'24px'}}>

Devices

<div style={{ width:"100px"}}> Property </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
Show on desktopMakes the component visible in desktop view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
Show on mobileMakes the component visible in mobile view.You can set it with the toggle button or dynamically configure the value by clicking on fx and entering a logical expression.
</div>
<div style={{paddingTop:'24px'}}>

Styles

<div style={{ width:"135px"}}> Style </div><div style={{ width:"100px"}}> Description </div><div style={{ width:"135px"}}> Expected Value </div>
Background colorSet a background color for the buttons in buttons group.Choose a color from the picker or enter the Hex color code. ex: #000000.
Text colorSet a text color for the buttons in buttons group.Choose a color from the picker or enter the Hex color code. ex: #000000.
VisibilityMake the component visible or hidden.{{true}} or {{false}}, By default, its value is set to {{true}}.
DisableDisable the component.{{true}} or {{false}}, By default, its value is set to {{false}}.
Border radius.Add a border radius to the buttons in the component using this property.Any numerical value from 0 to 100.
Selected text colorUse this property to modify the text color of selected button.Choose a color from the picker or enter the Hex color code. ex: #000000.
Selected background colorUse this property to modify the background color of selected button.Choose a color from the picker or enter the Hex color code. ex: #000000.
Box shadowSets the add shadow effects around a component's frame. You can specify the horizontal and vertical offsets(through X and Y sliders), blur and spread radius, and color of the shadow.Values that represent X, Y, blur, spread, and color. Example: 9px 11px 5px 5px #00000040.
</div>