srcdev-nuxt-components 9.4.12 → 9.5.1

package/app/components/05.forms/input-label/InputLabel.vue

@@ -1,66 +1,127 @@
 <template>
-  <label :for="id" class="input-label" :class="[elementClasses, inputVariant]">
-    <slot v-if="hasHtmlLabelSlot" name="htmlLabel"></slot>
-    <slot v-if="hasTextLabelSlot" name="textLabel"></slot>
+  <label
+    :for="id"
+    class="input-label"
+    :class="elementClasses"
+    :data-input-variant="inputVariant"
+    :data-invalid="fieldHasError ? '' : undefined"
+  >
+    <slot name="htmlLabel"></slot>
+    <slot name="textLabel"></slot>
+    <span
+      v-if="marker"
+      class="input-label-indicator"
+      :data-indicator="marker.type"
+      :aria-hidden="marker.type === 'required' ? 'true' : undefined"
+    >
+      <template v-if="marker.icon">
+        <Icon :name="marker.icon" class="input-label-indicator-icon" aria-hidden="true" />
+        <span v-if="marker.type === 'optional'" class="sr-only">{{ marker.text }}</span>
+      </template>
+      <template v-else>{{ marker.text }}</template>
+    </span>
   </label>
 </template>
 
 <script setup lang="ts">
-import type { InputUiVariant, FormUiTheme } from "~/types/forms/types.forms";
+import type { InputUiVariant, InputLabelIndicator } from "~/types/forms/types.forms";
 
 interface Props {
   id: string;
-  name: string;
+  required?: boolean;
+  indicator?: InputLabelIndicator;
+  requiredText?: string;
+  optionalText?: string;
+  requiredIcon?: string;
+  optionalIcon?: string;
   fieldHasError?: boolean;
-  styleClassPassthrough?: string | string[];
-  theme?: FormUiTheme;
   inputVariant?: InputUiVariant;
+  styleClassPassthrough?: string | string[];
 }
 
 const props = withDefaults(defineProps<Props>(), {
+  required: false,
+  indicator: undefined,
+  requiredText: undefined,
+  optionalText: undefined,
+  requiredIcon: undefined,
+  optionalIcon: undefined,
   fieldHasError: false,
-  styleClassPassthrough: () => [],
-  theme: "default",
   inputVariant: "normal",
+  styleClassPassthrough: () => [],
+});
+
+const appConfig = useAppConfig();
+
+const marker = computed(() => {
+  const config = appConfig.srcdev?.inputLabel;
+  const indicator = props.indicator ?? config?.indicator ?? "none";
+
+  if (indicator === "required" && props.required) {
+    return {
+      type: "required",
+      text: props.requiredText ?? config?.requiredText ?? "*",
+      icon: props.requiredIcon ?? config?.requiredIcon,
+    } as const;
+  }
+  if (indicator === "optional" && !props.required) {
+    return {
+      type: "optional",
+      text: props.optionalText ?? config?.optionalText ?? "(optional)",
+      icon: props.optionalIcon ?? config?.optionalIcon,
+    } as const;
+  }
+  return null;
 });
 
-const slots = useSlots();
-const hasHtmlLabelSlot = computed(() => Boolean(slots.htmlLabel));
-const hasTextLabelSlot = computed(() => Boolean(slots.textLabel));
+const { elementClasses, resetElementClasses } = useStyleClassPassthrough(props.styleClassPassthrough);
 
-const { elementClasses } = useStyleClassPassthrough(props.styleClassPassthrough);
+watch(
+  () => props.styleClassPassthrough,
+  () => {
+    resetElementClasses(props.styleClassPassthrough);
+  }
+);
 </script>
 
 <style lang="css">
 @layer components {
-.input-label {
-  touch-action: manipulation;
-  color: var(--form-label-color);
-  margin-block: 0.8rem;
-  font-size: var(--step-5);
-  font-weight: normal;
-  line-height: 1.5;
-  display: block;
-
-  &.normal {
-    color: var(--form-label-color);
-    margin-block: 0.8rem;
-    font-weight: normal;
-    line-height: 1.5;
+  .input-label {
     display: block;
-  }
+    touch-action: manipulation;
+    color: var(--input-label-color, inherit);
+    font-size: var(--input-label-font-size, var(--step-5));
+    font-weight: var(--input-label-font-weight, normal);
+    line-height: var(--input-label-line-height, 1.5);
+    margin-block: var(--input-label-margin-block, 0.8rem);
+    margin-inline: var(--input-label-margin-inline, 0);
 
-  &.underlined {
-    color: var(--form-label-color);
-    margin-block: 0.8rem;
-    font-weight: normal;
-    line-height: 1.5;
-    display: block;
-  }
+    .input-label-indicator {
+      --_indicator-color: var(--input-label-indicator-color, inherit);
+      --_indicator-font-size: var(--input-label-indicator-font-size, inherit);
 
-  & + .input-description {
-    margin-block-end: 0.2rem;
+      display: inline-flex;
+      align-items: center;
+      vertical-align: baseline;
+      margin-inline-start: var(--input-label-indicator-gap, 0.4rem);
+      color: var(--_indicator-color);
+      font-size: var(--_indicator-font-size);
+      font-weight: var(--input-label-indicator-font-weight, inherit);
+
+      &[data-indicator="required"] {
+        color: var(--input-label-indicator-color-required, var(--_indicator-color));
+        font-size: var(--input-label-indicator-font-size-required, var(--_indicator-font-size));
+      }
+
+      &[data-indicator="optional"] {
+        color: var(--input-label-indicator-color-optional, var(--_indicator-color));
+        font-size: var(--input-label-indicator-font-size-optional, var(--_indicator-font-size));
+      }
+    }
+
+    .input-label-indicator-icon {
+      font-size: var(--input-label-indicator-icon-size, 1em);
+    }
   }
 }
-}
 </style>

package/app/components/05.forms/input-label/stories/InputLabel.stories.ts

@@ -0,0 +1,236 @@
+import type { Meta, StoryFn } from "@nuxtjs/storybook";
+import { computed } from "vue";
+import StorybookComponent from "../InputLabel.vue";
+import type { InputUiVariant, InputLabelIndicator } from "~/types/forms/types.forms";
+
+interface InputLabelStoryArgs {
+  id: string;
+  required: boolean;
+  indicator: InputLabelIndicator;
+  requiredText: string;
+  optionalText: string;
+  requiredIcon: string;
+  optionalIcon: string;
+  indicatorColorRequired: string;
+  indicatorColorOptional: string;
+  fieldHasError: boolean;
+  inputVariant: InputUiVariant;
+  styleClassPassthrough: string;
+  textLabel: string;
+  htmlLabel: string;
+}
+
+export default {
+  title: "Components/Forms/Input Label/InputLabel",
+  component: StorybookComponent,
+  argTypes: {
+    id: {
+      control: "text",
+      description: "Id of the control this label is for, rendered as the label's for attribute",
+      table: { category: "Basic" },
+    },
+    textLabel: {
+      control: "text",
+      description: "textLabel slot: plain label text",
+      table: { category: "Slots" },
+    },
+    htmlLabel: {
+      control: "text",
+      description: "htmlLabel slot: rich markup, rendered before the text slot",
+      table: { category: "Slots" },
+    },
+    required: {
+      control: "boolean",
+      description: "Whether the field is required. Drives which fields the indicator marks",
+      table: { category: "Indicator" },
+    },
+    indicator: {
+      control: { type: "select" },
+      options: ["none", "required", "optional"],
+      description: "Which fields get a marker. Unset falls back to app.config srcdev.inputLabel.indicator, then none",
+      table: { category: "Indicator" },
+    },
+    requiredText: {
+      control: "text",
+      description: "Required marker text (aria-hidden, the control's required attribute is what's announced)",
+      table: { category: "Indicator" },
+    },
+    optionalText: {
+      control: "text",
+      description: "Optional marker text (announced, and kept as screen-reader text when an icon is used)",
+      table: { category: "Indicator" },
+    },
+    requiredIcon: {
+      control: "text",
+      description: "Iconify name that replaces the required text",
+      table: { category: "Indicator" },
+    },
+    optionalIcon: {
+      control: "text",
+      description: "Iconify name that replaces the visible optional text",
+      table: { category: "Indicator" },
+    },
+    indicatorColorRequired: {
+      control: "color",
+      description: "Sets --input-label-indicator-color-required on the story wrapper",
+      table: { category: "Tokens" },
+    },
+    indicatorColorOptional: {
+      control: "color",
+      description: "Sets --input-label-indicator-color-optional on the story wrapper",
+      table: { category: "Tokens" },
+    },
+    fieldHasError: {
+      control: "boolean",
+      description: "Rendered as data-invalid, a styling hook only",
+      table: { category: "State" },
+    },
+    inputVariant: {
+      control: { type: "select" },
+      options: ["normal", "outlined", "underlined"],
+      description: "Rendered as data-input-variant, a styling hook only",
+      table: { category: "Layout" },
+    },
+    styleClassPassthrough: { control: "text", table: { category: "Styling" } },
+  },
+  args: {
+    id: "story-field",
+    required: false,
+    indicator: "none",
+    requiredText: "*",
+    optionalText: "(optional)",
+    requiredIcon: "",
+    optionalIcon: "",
+    indicatorColorRequired: "",
+    indicatorColorOptional: "",
+    fieldHasError: false,
+    inputVariant: "normal",
+    styleClassPassthrough: "",
+    textLabel: "Email address",
+    htmlLabel: "",
+  },
+} as Meta<InputLabelStoryArgs>;
+
+const Template: StoryFn<InputLabelStoryArgs> = (args) => ({
+  components: { StorybookComponent },
+  setup() {
+    const componentArgs = computed(() => {
+      const {
+        textLabel: _text,
+        htmlLabel: _html,
+        indicatorColorRequired: _required,
+        indicatorColorOptional: _optional,
+        requiredIcon,
+        optionalIcon,
+        ...rest
+      } = args;
+      return { ...rest, requiredIcon: requiredIcon || undefined, optionalIcon: optionalIcon || undefined };
+    });
+    const tokenStyles = computed(() => ({
+      ...(args.indicatorColorRequired && { "--input-label-indicator-color-required": args.indicatorColorRequired }),
+      ...(args.indicatorColorOptional && { "--input-label-indicator-color-optional": args.indicatorColorOptional }),
+    }));
+    return { args, componentArgs, tokenStyles };
+  },
+  template: `
+    <div style="max-width: 48rem; margin: 3.6rem; font-size: 1.6rem;" :style="tokenStyles">
+      <StorybookComponent v-bind="componentArgs">
+        <template v-if="args.htmlLabel" #htmlLabel><span v-html="args.htmlLabel"></span></template>
+        <template v-if="args.textLabel" #textLabel>{{ args.textLabel }}</template>
+      </StorybookComponent>
+      <input
+        :id="args.id"
+        type="email"
+        :required="args.required"
+        :aria-invalid="args.fieldHasError || undefined"
+        style="width: 100%; padding: 1.2rem; font-size: 1.6rem;"
+      />
+    </div>
+  `,
+});
+
+export const TextLabel = Template.bind({});
+
+export const HtmlLabel = Template.bind({});
+HtmlLabel.args = {
+  textLabel: "",
+  htmlLabel: 'Email address <small style="font-weight: normal;">(work or personal)</small>',
+};
+
+export const TextAndHtml = Template.bind({});
+TextAndHtml.args = {
+  htmlLabel: "<strong>Work</strong> ",
+};
+
+export const MarkRequired = Template.bind({});
+MarkRequired.args = { indicator: "required", required: true };
+MarkRequired.parameters = {
+  docs: {
+    description: {
+      story:
+        "Required fields get an aria-hidden marker (the control's own required attribute is what screen readers announce). Toggle required off and the marker goes. Set it site-wide with app.config srcdev.inputLabel.indicator.",
+    },
+  },
+};
+
+export const MarkOptional = Template.bind({});
+MarkOptional.args = { indicator: "optional", required: false };
+MarkOptional.parameters = {
+  docs: {
+    description: {
+      story: "The opposite convention: optional fields are marked instead, and the text is announced. Toggle required on and the marker goes.",
+    },
+  },
+};
+
+export const IndicatorIcon = Template.bind({});
+IndicatorIcon.args = {
+  indicator: "required",
+  required: true,
+  requiredIcon: "mdi:asterisk",
+  indicatorColorRequired: "#c0392b",
+  styleClassPassthrough: "input-label-story-indicator",
+};
+IndicatorIcon.parameters = {
+  docs: { description: { story: "An icon in place of the text, coloured through the per-state indicator token (the colour picker under Tokens)." } },
+};
+IndicatorIcon.decorators = [
+  () => ({
+    template: `
+      <div>
+        <component is="style">
+          .input-label-story-indicator {
+            --input-label-indicator-icon-size: 0.8em;
+          }
+        </component>
+        <story />
+      </div>
+    `,
+  }),
+];
+
+export const CustomTokens = Template.bind({});
+CustomTokens.args = { styleClassPassthrough: "input-label-story-tokens", fieldHasError: true };
+CustomTokens.parameters = {
+  docs: { description: { story: "Tokens set via a passthrough class, plus a colour swap on `[data-invalid]`." } },
+};
+CustomTokens.decorators = [
+  () => ({
+    template: `
+      <div>
+        <component is="style">
+          .input-label-story-tokens {
+            --input-label-font-size: 1.4rem;
+            --input-label-font-weight: 700;
+            --input-label-line-height: 1.3;
+            --input-label-margin-block: 0 0.4rem;
+          }
+          .input-label-story-tokens[data-invalid] {
+            --input-label-color: var(--theme-error-border);
+          }
+        </component>
+        <story />
+      </div>
+    `,
+  }),
+];