Skip to content

Radio

A radio button component for single-choice selections with configurable variants, sizes, labels, and validation states.

Basic Usage

blade
<x-basekit-ui::radio
    name="plan"
    value="basic"
    label="Basic"
/>

Props

PropTypeDefaultDescription
valuestringnullSubmitted value
is-checkedboolfalseInitial checked state
variantstring'primary'Visual style: primary, secondary, success, warning, danger, info, ghost
sizestring'md'Control size: sm, md, lg
labelstringnullLabel text
errorstringnullError message shown below the control
hintstringnullHelper text shown below the control

Standard radio attributes such as name, id, and disabled pass through to the underlying <input> element.

Slots

SlotDescription
labelCustom label markup
errorCustom error markup
hintCustom helper text

Variants

Supported variants: primary, secondary, success, warning, danger, info, ghost.

blade
<x-basekit-ui::radio name="variant" value="primary" variant="primary" :is-checked="true" label="Primary" />
<x-basekit-ui::radio name="variant" value="secondary" variant="secondary" label="Secondary" />
<x-basekit-ui::radio name="variant" value="success" variant="success" label="Success" />
<x-basekit-ui::radio name="variant" value="warning" variant="warning" label="Warning" />
<x-basekit-ui::radio name="variant" value="danger" variant="danger" label="Danger" />
<x-basekit-ui::radio name="variant" value="info" variant="info" label="Info" />
<x-basekit-ui::radio name="variant" value="ghost" variant="ghost" label="Ghost" />

Sizes

Supported sizes: sm,md,lg.

blade
<x-basekit-ui::radio name="size" value="sm" size="sm" label="Small" />
<x-basekit-ui::radio name="size" value="md" size="md" label="Medium" />
<x-basekit-ui::radio name="size" value="lg" size="lg" label="Large" />

Custom Label Markup

blade
<x-basekit-ui::radio name="plan" value="enterprise">
    <x-slot:label>
        <strong>Enterprise</strong> - For large teams
    </x-slot:label>
</x-basekit-ui::radio>

Radio Group

blade
<div class="space-y-2">
    <x-basekit-ui::radio name="plan" value="free" label="Free - $0/month" />
    <x-basekit-ui::radio name="plan" value="pro" :is-checked="true" label="Pro - $9/month" />
    <x-basekit-ui::radio name="plan" value="enterprise" label="Enterprise - $99/month" />
</div>

Validation State

blade
<div class="space-y-2">
    <x-basekit-ui::radio name="payment" value="card" error="Please select a payment method" label="Credit Card" />
    <x-basekit-ui::radio name="payment" value="paypal" error="Please select a payment method" label="PayPal" />
</div>

Custom Classes

Override or extend styles with the class attribute:

blade
<x-basekit-ui::radio
    name="custom-plan"
    value="starter"
    label="Starter"
    class="mt-2"
/>

CSS Variables

Customize radio appearance via CSS variables:

css
:root {
  --radio-transition:
    background-color var(--transition-normal),
    border-color var(--transition-normal), box-shadow var(--transition-normal);

  /* Radio - Base */
  --radio-border: var(--color-slate-300);
  --radio-bg: var(--surface-base);
  --radio-text: var(--color-primary-600);
  --radio-checked-bg: var(--color-primary-600);
  --radio-checked-border: var(--color-primary-600);
  --radio-focus-ring: var(--color-primary-100);

  /* Radio - Sizes */
  --radio-size-sm: 1rem;
  --radio-size-md: 1.125rem;
  --radio-size-lg: 1.25rem;

  /* Radio - Variants */
  --radio-primary-checked-bg: var(--color-primary-600);
  --radio-primary-checked-border: var(--color-primary-600);
  --radio-primary-focus-ring: var(--color-primary-100);

  --radio-secondary-checked-bg: var(--color-slate-600);
  --radio-secondary-checked-border: var(--color-slate-600);
  --radio-secondary-focus-ring: var(--color-slate-200);

  --radio-success-checked-bg: var(--color-success-600);
  --radio-success-checked-border: var(--color-success-600);
  --radio-success-focus-ring: var(--color-success-100);

  --radio-warning-checked-bg: var(--color-warning-600);
  --radio-warning-checked-border: var(--color-warning-600);
  --radio-warning-focus-ring: var(--color-warning-100);

  --radio-danger-checked-bg: var(--color-danger-600);
  --radio-danger-checked-border: var(--color-danger-600);
  --radio-danger-focus-ring: var(--color-danger-100);

  --radio-info-checked-bg: var(--color-info-600);
  --radio-info-checked-border: var(--color-info-600);
  --radio-info-focus-ring: var(--color-info-100);

  --radio-ghost-bg: transparent;
  --radio-ghost-border: var(--color-slate-300);
  --radio-ghost-checked-bg: var(--color-slate-700);
  --radio-ghost-checked-border: var(--color-slate-700);
  --radio-ghost-focus-ring: var(--color-slate-200);

  /* Radio - Error State */
  --radio-error-border: var(--color-danger-500);
  --radio-error-ring: var(--color-danger-100);
  --radio-error-checked-bg: var(--color-danger-600);
  --radio-error-checked-border: var(--color-danger-600);
}

Configuration

Configure defaults in config/basekit-laravel-ui.php:

php
'radio' => [
    'enabled' => true,
    'variants' => ['primary', 'secondary', 'success', 'warning', 'danger', 'info', 'ghost'],
    'sizes' => ['sm', 'md', 'lg'],
    'default_variant' => 'primary',
    'default_size' => 'md',
],

Released under the MIT License.