Radio Button

The radio button component is a lightweight extension of the standard HTML input type="radio" element, featuring: variants, sizes, states, etc.

API

Props

NameTypeDefaultDescription
variantString'default'Defines the variant of the theme applied to the radio button. Possible values are: default, primary, secondary, danger, warning, success and info
sizeString'md'Defines the size of the radio button. Possible values are: sm, md, lg
labelString''Defines the text to show inside the radio button
disabledBooleanfalseDefines if the radio button should be disabled or not
model-valueBooleanfalseDefines the status of the radio button (checked or unchecked)
valueAnynullDefines the value of the radio button

Events

NameDescription
update:model-valueEvent emitted whenever the radio button is checked or unchecked

Basic Radio Buttons

<template>
	<Radio-Button v-model="value" value="first" label="First" />
	<Radio-Button v-model="value" value="second" label="Second" />
	<Radio-Button v-model="value" value="third" label="Third" />
</template>

<script>
export default {
	data() {
		return {
			value: null,
		}
	},
}
</script>

Variants

Every radio button can define a variant. The variant defines the colors applied to the radio button.

<template>
	<Radio-Button v-model="value" value="default" label="Default" />
	<Radio-Button v-model="value" value="primary" variant="primary" label="Primary" />
	<Radio-Button v-model="value" value="secondary" variant="secondary" label="Secondary" />
	<Radio-Button v-model="value" value="danger" variant="danger" label="Danger" />
	<Radio-Button v-model="value" value="warning" variant="warning" label="Warning" />
	<Radio-Button v-model="value" value="success" variant="success" label="Success" />
	<Radio-Button v-model="value" value="info" variant="info" label="Info" />
</template>

Sizes

<template>
	<Radio-Button v-model="value" size="sm" value="small" label="Small" />
	<Radio-Button v-model="value" size="md" value="medium" label="Medium" />
	<Radio-Button v-model="value" size="lg" value="large" label="Large" />
</template>

States

Disabled

<template>
	<Radio-Button value="default" label="Default" disabled />
	<Radio-Button value="primary" variant="primary" label="Primary" disabled />
	<Radio-Button value="secondary" variant="secondary" label="Secondary" disabled />
	<Radio-Button value="danger" variant="danger" label="Danger" disabled />
	<Radio-Button value="warning" variant="warning" label="Warning" disabled />
	<Radio-Button value="success" variant="success" label="Success" disabled />
	<Radio-Button value="info" variant="info" label="Info" disabled />
</template>
Last Updated:
Contributors: Carlos Pereira