Radio

KRadio is a wrapper for native input type radio elements.

Selected: string

Boolean

String

Object A

Object B

<template>
  <div>Selected: {{ radioValue }}</div>
  <KRadio name="test" :selected-value="true" v-model="radioValue">Boolean</KRadio>
  <KRadio name="test" selected-value="string" v-model="radioValue">String</KRadio>
  <KRadio name="test" :selected-value="objA" v-model="radioValue">Object A</KRadio>
  <KRadio name="test" :selected-value="objB" v-model="radioValue">Object B</KRadio>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const radioValue = ref<boolean | string | object>('string')

const objA = { name: 'a' }
const objB = { name: 'b' }
</script>

Props

v-model

Use v-model to bind the checked state of the underlying <input> element. The v-model binds to the modelValue prop of the component and sets the current checked state of the input. You can read more about passing values via v-model here.

selectedValue

The value of the KRadio option that will be emitted by the change and update:modelValue events.

label

Will place label text to the right of the radio. Can also be slotted.

Label example

<KRadio v-model="checked" label="Label example" :selected-value="true" />

labelAttributes

KRadio has an instance of KLabel for supporting tooltip text. Use the labelAttributes prop to configure the KLabel's props. This example shows using the labelAttributes to set up a tooltip. Tooltip content can also be slotted.

Tooltip

I use the KLabel `help` prop

<KRadio
  v-model="checked"
  label="Tooltip"
  :label-attributes="{ info: 'I use the KLabel `help` prop' }"
  :selected-value="true"
/>

description

Will place description text under the radio label. Can also be slotted.

Label example

Some description text

<KRadio
  v-model="radio"
  label="Label example"
  description="Some description text"
  :selected-value="true"
/>

error

Use this prop to apply error styling to the component.

Input error

Some description text

<KRadio
  v-model="radio"
  label="Input error"
  error
  description="Some description text"
  :selected-value="true"
/>

HTML attributes

Any valid attribute will be added to the input. You can read more about $attrs here.

Disabled radio

<KRadio
  v-model="checked"
  :selected-value="true"
  disabled
>
  Disabled radio
</KRadio>

card

Set this prop to true to change the appearance of the KRadio component to a card-style design. When card is set to true, the KRadio component will be displayed with a card-like layout, providing a visually distinct and appealing presentation.

PublicChoose this option if you want your APIs to be publicly accessible by anyone on the internet.

PrivateChoose this option if you want your APIs to only be accessible from within your private network.

Selected: none

<template>
  <KRadio
    v-model="cardRadio"
    description="Choose this option if you want your APIs to be publicly accessible by anyone on the internet."
    card
    label="Public"
    selected-value="public"
  >
    <WorldIcon />
  </KRadio>
  <KRadio
    v-model="cardRadio"
    description="Choose this option if you want your APIs to only be accessible from within your private network."
    card
    label="Private"
    selected-value="private"
  >
    <WorldPrivateIcon />
  </KRadio>
  <div>Selected: {{ cardRadio || 'none' }}</div>
</template>

<script setup lang="ts">
import { ref } from 'vue'

const cardRadio = ref<string>('')
</script>

Slots

default

Content passed in to the default slot will be shown as the label content. The slot content takes precedence over the label prop.

Label goes here. The radio is not selected

<KRadio
  v-model="checked"
  label="This will be replaced with a slot"
  :selected-value="true"
>
  Label goes here. The radio is {{ checked ? "selected" : "not selected" }}
</KRadio>

NOTE

To preserve a valid HTML structure, avoid slotting in block-level elements such as a div into the default slot as it will be rendered inside a label element. This also applies to card-style radio.

TIP

When card prop is true, the content passed to the default slot will render directly above the label. Should you want to customize the layout inside the card you can omit using the label and description props and style content passed through the default slot yourself.

description

Content passed in to the description slot will be shown as the description content. The slot content takes precedence over the description prop.

Some label

Description goes here

<KRadio
  v-model="checked"
  label="Some label"
  description="This will be replaced with a slot"
  :selected-value="true"
>
  <template #description>Description goes here</template>
</KRadio>

tooltip

Provides a slot for tooltip content displayed after the radio label.

My tooltip

Roses are #FF0000, violets are #0000FF

<KRadio v-model="checked" :selected-value="true">
  My tooltip
  <template #tooltip>Roses are <code>#FF0000</code>, violets are <code>#0000FF</code></template>
</KRadio>

Events

KRadio emits two events with same payload.

change

Fired on change, returns radio selectedValue.

update:modelValue

Fired on change, returns radio selectedValue.