Radio

The Radio input component uses HTML's native radio inputs to allow a user to select one value from a set of options. The component supports the W3C ARIA APG Radio Group Pattern. Use it with the Field component to access all the functionalities.

Examples

Base

A radio component will render one selection at a time. Use the native-value property to specify the value that will be used as the modelValue property when the specific radio is checked.

Show code

HTML

<section>
    <o-field>
        <o-radio
            v-model="radio"
            name="base"
            native-value="Flint"
            label="Flint" />

        <o-radio
            v-model="radio"
            name="base"
            native-value="Silver"
            label="Silver" />

        <o-radio
            v-model="radio"
            name="base"
            native-value="Jack"
            label="Jack" />

        <o-radio
            v-model="radio"
            name="base"
            native-value="Vane"
            label="Vane"
            disabled />
    </o-field>

    <p><b>Selection:</b> {{ radio }}</p>
</section>

JS

import { ref } from "vue";

const radio = ref("Jack");

Variants

Different styles can be achieved with the variant prop.

Show code

HTML

<section>
    <o-field>
        <o-radio
            v-model="radio"
            name="variants"
            native-value="default"
            label="Default" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="variants"
            native-value="primary"
            variant="primary"
            label="Primary" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="variants"
            native-value="success"
            variant="success"
            label="Success" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="variants"
            native-value="info"
            variant="info"
            label="Info" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="variants"
            native-value="warning"
            variant="warning"
            label="Warning" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="variants"
            native-value="danger"
            variant="danger"
            label="Danger" />
    </o-field>

    <p><b>Selection:</b> {{ radio }}</p>
</section>

JS

import { ref } from "vue";

const radio = ref("default");

Sizes

The component can be displayed in different sizes using the size prop.

Show code

HTML

<section>
    <o-field>
        <o-radio
            v-model="radio"
            name="sizes"
            native-value="small"
            size="small"
            label="Small" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="sizes"
            native-value="default"
            label="Default" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="sizes"
            native-value="medium"
            size="medium"
            label="Medium" />
    </o-field>

    <o-field>
        <o-radio
            v-model="radio"
            name="sizes"
            native-value="large"
            size="large"
            label="Large" />
    </o-field>

    <p><b>Selection:</b> {{ radio }}</p>
</section>

JS

import { ref } from "vue";

const radio = ref("small");

Radio component

Select an option from a set of options.

<o-radio></o-radio>

Props

Prop name	Description	Type	Values	Default
autocomplete	Same as native autocomplete options to use in HTML5 validation	string	-	From config: radio: {   autocomplete: "off" }
customValidity	Custom HTML 5 validation error to set on the form control	string | ((currentValue: unknown, state: ValidityState) => string)	-
disabled	Same as native disabled	boolean	-	false
id	Same as native id. Also set the for label for o-field wrapper - default is an uuid.	string	-	useId()
label	Input label, unnecessary when default slot is used	string	-
v-model	The input value state, use v-model to make it two-way binding	unknown	-
name	Same as native name	string	-
nativeValue	Same as native value	unknown	-
override	Override existing theme classes completely	boolean	-
required	Same as native required	boolean	-	false
size	Size of the control	string	small, medium, large	From config: radio: {   size: undefined }
useHtml5Validation	Enable html 5 native validation	boolean	-	From config: {   useHtml5Validation: true }
variant	Color of the control	string	primary, info, success, warning, danger, and any other custom color	From config: radio: {   variant: undefined }

Events

Event name	Properties	Description
update:model-value	value T - updated modelValue prop	modelValue prop two-way binding
input	value T - input value event Event - native event	on input change event
focus	event Event - native event	on input focus event
blur	event Event - native event	on input blur event
invalid	event Event - native event	on input invalid event

Slots

Name	Description	Bindings
default	Override the label, default is label prop

Class Inspector

Classes applied to the element:

How does the Class props inspector work?

Class props inspector is useful to see class props you want to use to customize Oruga components and how they change a component. You can click on Inspect button to find the exact element where a specific class prop acts.

In the Class props inspector there are other columns:

Class prop

This column contains the name of the Class prop you want to inspect.
If you find a name with a link ( ▷ classPropName) this refers to a subitem (e.g. Dropdown Item in Dropdown).

Description

This column contains the description of the Class prop you want to inspect.
👉 This icon indicates some warning, e.g. this Class prop is visible only on mobile.

Props

This column contains a list of props that activate the class, e.g. if a class prop contains disabled prop it means that only when the component has disabled prop.

Suffixes

This column contains all the possible suffixes that you'll receive if you use a function to customize your Class prop.

Class prop	Description	Props	Suffixes
rootClass	Class of the root element.
checkedClass	Class of the root element when checked.	modelValue
sizeClass	Class of the root element with size.	size	small medium large
variantClass	Class of the root element with variant.	variant	primary info warning danger
disabledClass	Class of the root element when disabled.	disabled
inputClass	Class of the native input element.
labelClass	Class of the radio label element.

Sass variables

Current theme ➜ Oruga

SASS Variable	Default
$radio-active-background-color	$primary
$radio-checked-box-shadow-length	0 0 0.5em
$radio-checked-box-shadow-opacity	0.8
$radio-box-shadow	$control-box-shadow
$radio-disabled-opacity	var(--#{$prefix}base-disabled-opacity)
$radio-label-padding	0 0 0 0.5em
$radio-margin-sibiling	0.5em
$radio-size	1rem
$radio-line-height	1.25

See ➜ 📄 Full scss file

Current theme ➜ Bulma

SASS Variable	Default
$radio-size	1.25em
$radio-colors	dv.$colors
$radio-active-background-color	css.getVar("primary")
$radio-border-color	css.getVar("grey")
$radio-shadow	css.getVar("shadow")

See ➜ 📄 Full scss file

Current theme ➜ Bootstrap

The theme does not have any custom variables for this component.