vueless/ui.form-radio-group/storybook/stories.ts

Vue Styleless UI Component Library, powered by Tailwind CSS.

import {
  getArgs,
  getArgTypes,
  getSlotNames,
  getSlotsFragment,
  getDocsDescription,
} from "../../utils/storybook";

import URadioGroup from "../../ui.form-radio-group/URadioGroup.vue";
import URadio from "../../ui.form-radio/URadio.vue";
import UAlert from "../../ui.text-alert/UAlert.vue";
import UCol from "../../ui.container-col/UCol.vue";
import URow from "../../ui.container-row/URow.vue";
import UBadge from "../../ui.text-badge/UBadge.vue";
import UText from "../../ui.text-block/UText.vue";
import ULink from "../../ui.button-link/ULink.vue";
import UIcon from "../../ui.image-icon/UIcon.vue";

import type { Meta, StoryFn } from "@storybook/vue3-vite";
import type { Props } from "../types";
import { ref } from "vue";

interface URadioGroupArgs extends Props {
  slotTemplate?: string;
  enum: "size" | "color";
}

export default {
  id: "3160",
  title: "Form Inputs & Controls / Radio Group",
  component: URadioGroup,
  args: {
    label: "Select your preferred delivery option:",
    options: [
      { value: "standard", label: "Standard Shipping (3-5 business days)" },
      { value: "express", label: "Express Shipping (1-2 business days)" },
      { value: "pickup", label: "In-Store Pickup (Available same day)" },
    ],
  },
  argTypes: {
    ...getArgTypes(URadioGroup.__name),
  },
  parameters: {
    docs: {
      ...getDocsDescription(URadioGroup.__name),
    },
  },
} as Meta;

const DefaultTemplate: StoryFn<URadioGroupArgs> = (args: URadioGroupArgs) => ({
  components: { URadioGroup, URadio, UCol, UBadge, UText, URow },
  setup: () => ({ args, slots: getSlotNames(URadioGroup.__name) }),
  template: `
    <URadioGroup v-bind="args" v-model="args.modelValue">
      ${args.slotTemplate || getSlotsFragment("")}
    </URadioGroup>
  `,
});

const EnumTemplate: StoryFn<URadioGroupArgs> = (args: URadioGroupArgs, { argTypes }) => ({
  components: { URadioGroup, URow },
  setup: () => ({ args, argTypes, getArgs }),
  template: `
    <URow>
      <URadioGroup
        v-for="option in argTypes?.[args.enum]?.options"
        v-bind="getArgs(args, option)"
        :key="option"
        :name="option"
      />
    </URow>
  `,
});

export const Default = DefaultTemplate.bind({});
Default.args = { name: "Default" };

export const Description = DefaultTemplate.bind({});
Description.args = {
  name: "Description",
  label: "Delivery Options",
  description:
    "Select your preferred delivery method. Additional charges may apply for expedited shipping.",
};

export const Error: StoryFn<URadioGroupArgs> = (args: URadioGroupArgs) => ({
  components: { URadioGroup },
  setup: () => ({ args }),
  template: `
    <URadioGroup
      v-bind="args"
      v-model="args.modelValue"
      name="Error"
      :error="args.modelValue ? '' : 'Please, select at least one option to proceed.'"
    />
  `,
});

export const Disabled = DefaultTemplate.bind({});
Disabled.args = { name: "Disabled", disabled: true };

export const Options = DefaultTemplate.bind({});
Options.args = {
  name: "Options",
  options: [
    { label: "String", value: "Subscribed" },
    { label: "Number", value: 42 },
    { label: "Boolean", value: true },
    { label: "Object", value: { value: 101, status: "active" } },
    { label: "Array", value: ["Admin", "Editor"] },
  ],
};
Options.parameters = {
  docs: {
    description: {
      story:
        "Every option you pass via the `options` prop can be of different type (see object meta keys table below).",
    },
  },
};

export const Sizes = EnumTemplate.bind({});
Sizes.args = { enum: "size", name: "Sizes", label: "{enumValue}" };

export const Colors = EnumTemplate.bind({});
Colors.args = { enum: "color", name: "Colors", label: "{enumValue}" };

export const LabelSlot = DefaultTemplate.bind({});
LabelSlot.args = {
  name: "LabelSlot",
  slotTemplate: `
    <template #label="{ label }">
      {{ label }}
      <span class="text-red-500">*</span>
    </template>
  `,
};

export const CustomKeys: StoryFn<URadioGroupArgs> = (args: URadioGroupArgs) => ({
  components: { URadioGroup, UCol, UAlert },
  setup: () => ({ args }),
  template: `
    <UCol>
      <URadioGroup v-bind="args" v-model="args.modelValue" />

      <UAlert
        :description="args.modelValue"
        size="sm"
        variant="soft"
        color="success"
        bordered
      />
    </UCol>
  `,
});
CustomKeys.args = {
  name: "CustomKeys",
  label: "Select your subscription plan:",
  labelKey: "title",
  valueKey: "id",
  options: [
    { id: "basic", title: "Basic Plan - $9.99/month" },
    { id: "pro", title: "Pro Plan - $19.99/month" },
    { id: "enterprise", title: "Enterprise Plan - $49.99/month" },
  ],
};
CustomKeys.parameters = {
  docs: {
    description: {
      story:
        "Use `labelKey` and `valueKey` props to specify custom keys for label and value in option objects. " +
        "This is useful when working with data from APIs that use different property names.",
    },
  },
};

export const Slots: StoryFn<URadioGroupArgs> = (args) => ({
  components: { URadioGroup, UCol, UText, URow, ULink, UIcon },
  setup: () => ({
    args,
    modelValueLabel: ref(null),
    modelValueDescription: ref(null),
    modelValueError: ref(null),
  }),
  template: `
    <UCol gap="3xl">
      <URadioGroup
        v-bind="args"
        v-model="modelValueLabel"
        name="LabelSlot"
      >
        <template #label>
          <URow align="center" gap="2xs">
            <UText>Choose a delivery option</UText>
            <UIcon name="local_shipping" size="xs" color="neutral" />
          </URow>
        </template>
      </URadioGroup>

      <URadioGroup
        v-bind="args"
        v-model="modelValueDescription"
        name="SlotsDescription"
        label="Delivery"
      >
        <template #description>
          <UText size="sm" variant="lifted">
            Shipping times are estimates, see the
            <ULink label="full policy" underlined size="sm" />.
          </UText>
        </template>
      </URadioGroup>

      <URadioGroup
        v-bind="args"
        v-model="modelValueError"
        name="SlotsError"
        label="Delivery"
        :error="true"
      >
        <template #error>
          <UText size="sm" color="error">
            <ul>
              <li>Please choose one option from the group</li>
              <li>At least one selection is required</li>
              <li>Review the labels and pick a valid answer</li>
            </ul>
          </UText>
        </template>
      </URadioGroup>
    </UCol>
  `,
});