ToolJet/docs/versioned_docs/version-2.34.0/widgets/radio-button.md
Karan Rathod 11d38325cb
[docs]:App builder 1.6 updates (#9514)
* add app-builder doc updates on Table and themes

* breakdown chart docs in two parts and add custom css for headers

* update chart example images and add more examples

* revamp table component and minor fixes

* fix typos

* fix table formatting for docusarus v3

* fix filepicker table

* create new version

* fix grammar and tables
2024-04-26 15:17:51 +05:30

4.1 KiB

id title
radio-button Radio Button

Radio Button

Radio button widget can be used to select one option from a group of options.

:::tip Radio buttons are preferred when the list of options is less than six, and all the options can be displayed at once. :::

:::info For more than six options, consider using Dropdown widget. :::

Properties

<div style={{ width:"100px"}}> Property <div style={{ width:"150px"}}> Description
Label The text is to be used as the label for the radio button. This field expects a String value.
Default value The value of the default option.
Option values List of values for different items/options. Refer your query data with dynamic variables {{queries.datasource.data.map(item => item.value)}} or populate it with sample values {{[true, false]}}.
Option labels List of labels for different items/options. Refer your query data with dynamic variables {{queries.datasource.data.map(item => item.label)}} or populate it with sample values {{["yes", "no"]}}.

Event

<div style={{ width:"100px"}}> Event <div style={{ width:"100px"}}> Description
On select This event is triggered when an option is clicked.

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

Component Specific Actions (CSA)

The following actions of the component can be controlled using component specific actions(CSA):

<div style={{ width:"100px"}}> Actions <div style={{ width:"135px"}}> Description <div style={{ width:"135px"}}> How To Access
selectOption Select an option from the radio buttons via a component-specific action within any event handler. Employ a RunJS query to execute component-specific actions such as: await components.radiobutton1.selectOption('one')

Exposed Variables

There are currently no exposed variables for the component.

General

Tooltip

A Tooltip is often used to specify extra information about something when the user hovers the mouse pointer over the widget.

Under the General accordion, you can set the value in the string format. Now hovering over the widget will display the string as the tooltip.

Layout

<div style={{ width:"100px"}}> Layout <div style={{ width:"100px"}}> Description <div style={{ width:"135px"}}> Expected Value
Show on desktop Toggle on or off to display desktop view. You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}
Show on mobile Toggle on or off to display mobile view. You can programmatically determining the value by clicking on Fx to set the value {{true}} or {{false}}

Styles

<div style={{ width:"100px"}}> Style <div style={{ width:"100px"}}> Description <div style={{ width:"100px"}}> Default Value
Text color Change the color of the text in the widget by providing the Hex color code or by choosing the color of your choice from the color picker.
Active color Change the color of active radio button by providing the Hex color code or by choosing the color of your choice from the color picker.
Visibility Toggle on or off to control the visibility of the widget. You can programmatically change its value by clicking on the Fx button next to it. If {{false}} the widget will not be visible after the app is deployed. By default, it's set to {{true}}
Disable This is off by default, toggle on the switch to lock the widget and make it non-functional. You can also programmatically set the value by clicking on the Fx button next to it. If set to {{true}}, the widget will be locked and becomes non-functional. By default, its value is set to {{false}}