Radio
Used to select a single state from multiple options.
Importing
To use the radio component, first you need to register the component inside the page. You can register the component manually by importing the register function:
ts
import { register } from "@tapsioss/web-components/radio";
register(); // Now the radio component is ready to use!
ts
import { registerRadio } from "@tapsioss/web-components";
registerRadio(); // Now the radio component is ready to use!
Also you can automatically register the component by importing it with the following approach:
ts
import "@tapsioss/web-components/radio/element";
TIP
If you want to use all the component in your app, you can call registerAll
at the root of your project.
ts
import { registerAll } from "@tapsioss/web-components";
registerAll(); // All the components are now available
In the React package, you can easily add the component using the following code:
ts
import { Radio } from "@tapsioss/react-components";
Component Usage
html
<tapsi-radio></tapsi-radio>
tsx
<Radio />
Properties
Name | Attribute Name | Description | Type | Default Value |
---|---|---|---|---|
checked | checked | Whether or not the radio is selected. | boolean | - |
value | value | The value of the radio that is submitted with a form when selected. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/radio#value | string | "on" |
required | required | Indicates that the user must specify a value for the input before the owning form can be submitted and will render an error state when reportValidity() is invoked when value is empty.https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required | boolean | false |
label | label | Defines a string value that can be used to name input. https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label | string | "" |
labelledBy | labelledby | Identifies the element (or elements) that labels the input. https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby | string | "" |
autofocus | autofocus | Indicates that the element should be focused on page load. https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus | boolean | false |
Events
Name | Description | Type | Bubbles | Cancelable |
---|---|---|---|---|
change | Fires when the user modifies the element's value. Unlike the input event, the change event is not necessarily fired for each alteration to an element's value . | Event | ✅ | ❌ |
input | Fires when the value of an input element has been changed as a direct result of a user action. | Event | ✅ | ❌ |