vueless/ui.form-checkbox/storybook/stories.ts

Vue Styleless UI Component Library, powered by Tailwind CSS.

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

import UCheckbox from "../../ui.form-checkbox/UCheckbox.vue";
import UCheckboxGroup from "../../ui.form-checkbox-group/UCheckboxGroup.vue";
import UCol from "../../ui.container-col/UCol.vue";
import UIcon from "../../ui.image-icon/UIcon.vue";
import ULink from "../../ui.button-link/ULink.vue";
import UText from "../../ui.text-block/UText.vue";
import URow from "../../ui.container-row/URow.vue";
import UChip from "../../ui.other-chip/UChip.vue";

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

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

export default {
  id: "3100",
  title: "Form Inputs & Controls / Checkbox",
  component: UCheckbox,
  args: {
    label: "Subscribe to the newsletter",
  },
  argTypes: {
    ...getArgTypes(UCheckbox.__name),
  },
  parameters: {
    docs: {
      ...getDocsDescription(UCheckbox.__name),
    },
  },
} as Meta;

const DefaultTemplate: StoryFn<UCheckboxArgs> = (args: UCheckboxArgs) => ({
  components: { UCheckbox, UIcon, ULink, UText, URow, UChip },
  setup: () => ({ args, slots: getSlotNames(UCheckbox.__name) }),
  template: `
    <UCheckbox v-bind="args" v-model="args.modelValue">
      ${args.slotTemplate || getSlotsFragment("")}
    </UCheckbox>
  `,
});

const ValueTypesTemplate: StoryFn<UCheckboxArgs> = (args: UCheckboxArgs) => ({
  components: { UCheckbox, UCheckboxGroup, URow },
  setup: () => ({ args }),
  data: () => ({ defaultValue: false, customValue: { vue: "less" } }),
  template: `
    <URow gap="xl">
      <UCheckbox
        v-bind="args"
        v-model="defaultValue"
        label="Default"
        :description="String(defaultValue)"
      />

      <UCheckbox
        v-bind="args"
        v-model="customValue"
        :true-value="{ vue: 'less' }"
        false-value="0"
        :description="JSON.stringify(customValue)"
        label="Custom"
      />
    </URow>
  `,
});

const EnumTemplate: StoryFn<UCheckboxArgs> = (args: UCheckboxArgs, { argTypes }) => ({
  components: { UCheckbox, UCol },
  setup: () => ({ args, argTypes, getArgs }),
  template: `
    <UCol gap="xl">
      <UCheckbox
        v-for="option in argTypes?.[args.enum]?.options"
        v-bind="getArgs(args, option)"
        :key="option"
        v-model="args.modelValue"
      />
    </UCol>
  `,
});

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

export const Description = DefaultTemplate.bind({});
Description.args = { description: "Receive updates and exclusive offers directly to your inbox." };

export const Error: StoryFn<UCheckboxArgs> = (args: UCheckboxArgs) => ({
  components: { UCheckbox },
  setup: () => ({ args }),
  template: `
    <UCheckbox
      v-bind="args"
      v-model="args.modelValue"
      :error="args.modelValue ? '' : 'Please agree to the Terms and Conditions before proceeding.'"
    />
  `,
});

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

export const CustomValues = ValueTypesTemplate.bind({});
CustomValues.args = {};
CustomValues.parameters = {
  docs: {
    description: {
      story:
        // eslint-disable-next-line vue/max-len
        "You can pass custom `trueValue` and `falseValue` props, that can be of different types (see object meta keys table below).",
    },
  },
};

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

export const LabelAlign = EnumTemplate.bind({});
LabelAlign.args = { enum: "labelAlign" };

export const Colors = EnumTemplate.bind({});
Colors.args = { enum: "color", modelValue: true, description: "{enumValue}" };

export const Partial = DefaultTemplate.bind({});
Partial.args = { partial: true };
Partial.parameters = {
  docs: {
    description: {
      story: "Make checkbox partially checked (change the checked tick to a minus).",
    },
  },
};

export const Slots: StoryFn<UCheckboxArgs> = (args) => ({
  components: { UCheckbox, UCol, UText, URow, ULink, UIcon },
  setup: () => ({
    args,
    labelSlotValue: ref(false),
    descriptionSlotValue: ref(false),
    errorSlotValue: ref(false),
  }),
  template: `
    <UCol gap="3xl">
      <UCheckbox v-bind="args" v-model="labelSlotValue">
        <template #label>
          <URow gap="2xs" align="center">
            <UText>I agree to the Privacy Policy</UText>
            <UIcon name="contract" size="xs" />
          </URow>
        </template>
      </UCheckbox>

      <UCheckbox
        v-bind="args"
        v-model="descriptionSlotValue"
        label="Email me product updates"
      >
        <template #description>
          <UText size="sm" variant="lifted">
            Unsubscribe anytime, see our
            <ULink label="privacy policy" underlined size="sm" />.
          </UText>
        </template>
      </UCheckbox>

      <UCheckbox
        v-bind="args"
        v-model="errorSlotValue"
        label="Accept terms"
        :error="true"
      >
        <template #error>
          <UText size="sm" color="error">
            <ul>
              <li>You must accept the terms to continue</li>
              <li>This checkbox is required for registration</li>
              <li>Clear the error by checking the box above</li>
            </ul>
          </UText>
        </template>
      </UCheckbox>
    </UCol>
  `,
});