srcdev-nuxt-components 9.5.0 → 9.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -100,7 +100,7 @@ full table with defaults.
100
100
  ### ToggleSwitchWithLabel
101
101
 
102
102
  `ToggleSwitchWithLabel` (`ToggleSwitchWithLabel.vue`) composes `ToggleSwitchCore` with
103
- `InputLabel`, an optional `description` slot, and `InputError`.
103
+ `InputLabel`, an optional description (rendered by `InputDescription`, the same as every other labelled form field), and `InputError`.
104
104
 
105
105
  **Additional props over ToggleSwitchCore:**
106
106
 
@@ -113,7 +113,9 @@ Note this wrapper passes `id`/`name`/`required`/`field-has-error`/`true-value`/`
113
113
  `theme`/`round`/`aria-describedby` straight through to `ToggleSwitchCore`; `id` is a self-generated
114
114
  `useId()` value, not a prop — consumers don't set it directly.
115
115
 
116
- **Slots**: `description`, `iconOn`, `iconOff` (the latter two forwarded to `ToggleSwitchCore`).
116
+ **Slots**: `descriptionText` / `descriptionHtml` (help text between the label and the switch, via `InputDescription`), `iconOn`, `iconOff` (the latter two forwarded to `ToggleSwitchCore`).
117
+
118
+ The switch's `aria-describedby` lists the description id when a description slot is present and the error id when `field-has-error` is true, both together when both apply.
117
119
 
118
120
  ```vue
119
121
  <ToggleSwitchWithLabel
@@ -123,10 +125,27 @@ Note this wrapper passes `id`/`name`/`required`/`field-has-error`/`true-value`/`
123
125
  :error-message="errors.notifications"
124
126
  :field-has-error="!!errors.notifications"
125
127
  >
126
- <template #description>Turn this on to receive notifications</template>
128
+ <template #descriptionText>Turn this on to receive notifications</template>
127
129
  </ToggleSwitchWithLabel>
128
130
  ```
129
131
 
132
+ #### Breaking change 2026-09-29: description slot
133
+
134
+ The `description` slot is removed. Use `descriptionText` (plain text, wrapped in a `<p>`) or
135
+ `descriptionHtml` (rich markup) instead. The old slot rendered into a bare `<div>` with no class,
136
+ spacing or tokens, so its content sat flush against the switch; it now goes through
137
+ `InputDescription` like every other labelled form field, styled by the `--input-description-*`
138
+ tokens (see `input-description` CONSUMER-STYLING.md) and targetable as
139
+ `.toggle-switch-description`. `aria-describedby` also used to drop the description id whenever
140
+ the field had an error; it now lists both.
141
+
142
+ ```vue
143
+ <!-- before -->
144
+ <template #description>Sends at most one email a week.</template>
145
+ <!-- after -->
146
+ <template #descriptionText>Sends at most one email a week.</template>
147
+ ```
148
+
130
149
  ### ToggleSwitchWithLabelInline
131
150
 
132
151
  `ToggleSwitchWithLabelInline` (`ToggleSwitchWithLabelInline.vue`) composes
@@ -149,7 +149,7 @@ Each skill is a single markdown file named `<area>-<task>.md`.
149
149
  ├── input-checkbox-radio.md — InputCheckboxRadio (bare control), InputCheckboxRadioField (labelled), InputCheckboxRadioButton (button/pill option): renamed from Core/WithLabel, state classes → data-* hooks, type-switch v-model fix, no aria-checked, icon font-size sizing, button spacing tokens
150
150
  ├── input-checkbox.md — MultipleCheckboxes/SingleCheckbox: fieldset-wrapped checkbox group (data-driven, button or labelled) and single checkbox, per-box native-required/styleClassPassthrough/data-testid bugs fixed, spacing token API
151
151
  ├── input-radio.md — MultipleRadiobuttons: fieldset radiogroup (data-driven, button or labelled), shared-name grouping bug fixed, dead label/placeholder/equalCols props removed, data-options-layout hook, spacing token API
152
- ├── toggle-switch-core.md — ToggleSwitchCore: pill/square checkbox-backed toggle primitive, dead round-prop/data-theme-error functionality and story theme-options bugs fixed, CSS token API; Variants section covers ToggleSwitchWithLabel/ToggleSwitchWithLabelInline
152
+ ├── toggle-switch-core.md — ToggleSwitchCore: pill/square checkbox-backed toggle primitive, dead round-prop/data-theme-error functionality and story theme-options bugs fixed, CSS token API; Variants section covers ToggleSwitchWithLabel (descriptionText/descriptionHtml via InputDescription, `description` slot removed 2026-09-29)/ToggleSwitchWithLabelInline
153
153
  ├── triple-toggle-switch.md — TripleToggleSwitch (renamed from TripleToggleSwitchCore): three-option icon radio pill with sliding marker, radiogroup + ariaLabel, system/light/dark marker-gradient tokens, reduced-motion, CSS token API
154
154
  ├── entry-animation.md — EntryAnimation: scroll-driven entry animation wrapper (slide-in/zoom-reveal/exit-blur utility classes), skipAnimation for above-the-fold loop items, reduced-motion handled at the CSS layer
155
155
  ├── column-flow-grid.md — ColumnFlowGrid (renamed from MasonryGrid): CSS multi-column text-flow layout, named dynamic slots (no count/data prop), itemMinWidth/gap/unit sizing, CSS token API; not a true masonry, see "which one do I want?"
@@ -20,7 +20,9 @@
20
20
  " label=\"$3Field label\"",
21
21
  " :error-message=\"$4errors.fieldName\"",
22
22
  " :field-has-error=\"!!$4errors.fieldName\"",
23
- "/>"
23
+ ">",
24
+ " <template #descriptionText>$5Help text</template>",
25
+ "</ToggleSwitchWithLabel>"
24
26
  ]
25
27
  },
26
28
  "SRCDEV ToggleSwitchWithLabelInline": {
@@ -55,6 +55,21 @@ fixed width independent of symbol size).
55
55
 
56
56
  ---
57
57
 
58
+ ## Description (ToggleSwitchWithLabel)
59
+
60
+ `ToggleSwitchWithLabel`'s `descriptionText` / `descriptionHtml` slots render through
61
+ `InputDescription`, so they're styled by its `--input-description-*` tokens (see
62
+ `input-description/CONSUMER-STYLING.md`), the same as every other labelled form field. The
63
+ spacing between the description and the switch is
64
+ `--input-description-slot-margin-block-end` (default `0.8rem`). Scope an override to toggles only
65
+ with the `.toggle-switch-description` class it adds:
66
+
67
+ ```css
68
+ .toggle-switch-description {
69
+ --input-description-slot-margin-block-end: 1.2rem;
70
+ }
71
+ ```
72
+
58
73
  ## Global theming
59
74
 
60
75
  ```css
@@ -10,9 +10,18 @@
10
10
  <template #textLabel>{{ label }}</template>
11
11
  </InputLabel>
12
12
 
13
- <div v-if="slots.description" :id="descriptionId">
14
- <slot name="description"></slot>
15
- </div>
13
+ <InputDescription
14
+ :description-id
15
+ :field-has-error
16
+ :style-class-passthrough="['toggle-switch-description']"
17
+ >
18
+ <template v-if="slots.descriptionHtml" #descriptionHtml>
19
+ <slot name="descriptionHtml"></slot>
20
+ </template>
21
+ <template v-if="slots.descriptionText" #descriptionText>
22
+ <slot name="descriptionText"></slot>
23
+ </template>
24
+ </InputDescription>
16
25
  <ToggleSwitchCore
17
26
  :id
18
27
  v-model="modelValue"
@@ -77,9 +86,15 @@ const toggleSwitchId = computed(() => `toggle-switch-${id}`);
77
86
  const descriptionId = computed(() => `${id}-description`);
78
87
  const errorId = computed(() => `${id}-error-message`);
79
88
 
89
+ // A plain function rather than useAriaDescribedById's computed: slots aren't reactive, so a
90
+ // computed would keep its first answer if a description slot is added or removed after mount
91
+ // (Claude.md pitfall #25). Lists both ids when there's a description and an error, so the
92
+ // description is still announced while the field is invalid.
80
93
  const ariaDescribedby = () => {
81
- const ariaDescribedbyId = slots.description ? descriptionId.value : undefined;
82
- return props.fieldHasError ? errorId.value : ariaDescribedbyId;
94
+ const ids: string[] = [];
95
+ if (slots.descriptionText || slots.descriptionHtml) ids.push(descriptionId.value);
96
+ if (props.fieldHasError) ids.push(errorId.value);
97
+ return ids.join(" ");
83
98
  };
84
99
 
85
100
  const modelValue = defineModel<string | number | boolean>({ required: true });
@@ -166,9 +166,7 @@ const Template: StoryFn<ToggleSwitchWithLabelStoryArgs> = (_args, { argTypes })
166
166
  :theme="args.theme"
167
167
  :round="args.round"
168
168
  >
169
- <template v-if="args.useDescription" #description>
170
- <div style="color: #666; font-size: 0.875rem;">{{ args.descriptionContent }}</div>
171
- </template>
169
+ <template v-if="args.useDescription" #descriptionText>{{ args.descriptionContent }}</template>
172
170
  <template v-if="args.useCustomIcons" #iconOn>
173
171
  <span v-html="args.iconOnContent"></span>
174
172
  </template>
@@ -49,9 +49,26 @@ describe("ToggleSwitchWithLabel", () => {
49
49
  expect(wrapper.text()).toContain("You must accept");
50
50
  });
51
51
 
52
- it("renders the description slot", async () => {
53
- wrapper = await wrapperFactory({}, { description: () => "Turn this on to receive notifications" });
54
- expect(wrapper.text()).toContain("Turn this on to receive notifications");
52
+ it("renders descriptionText through InputDescription", async () => {
53
+ wrapper = await wrapperFactory({}, { descriptionText: () => "Turn this on to receive notifications" });
54
+ const description = wrapper.find(".input-description.toggle-switch-description");
55
+ expect(description.exists()).toBe(true);
56
+ expect(description.find(".input-description-text").text()).toBe("Turn this on to receive notifications");
57
+ });
58
+
59
+ it("renders descriptionHtml through InputDescription", async () => {
60
+ wrapper = await wrapperFactory({}, { descriptionHtml: () => "Rich description" });
61
+ expect(wrapper.find(".toggle-switch-description .input-description-html").text()).toBe("Rich description");
62
+ });
63
+
64
+ it("renders no description element without a description slot", async () => {
65
+ wrapper = await wrapperFactory();
66
+ expect(wrapper.find(".input-description").exists()).toBe(false);
67
+ });
68
+
69
+ it("no longer renders the removed description slot", async () => {
70
+ wrapper = await wrapperFactory({}, { description: () => "Old slot content" });
71
+ expect(wrapper.text()).not.toContain("Old slot content");
55
72
  });
56
73
 
57
74
  it("forwards required to the underlying input", async () => {
@@ -84,7 +101,7 @@ describe("ToggleSwitchWithLabel", () => {
84
101
  },
85
102
  template: `
86
103
  <ComponentUnderTest v-model="modelValue" name="notifications" label="Enable notifications" error-message="">
87
- <template v-if="showDescription" #description>Sends at most one email a week.</template>
104
+ <template v-if="showDescription" #descriptionText>Sends at most one email a week.</template>
88
105
  </ComponentUnderTest>
89
106
  `,
90
107
  });
@@ -100,4 +117,17 @@ describe("ToggleSwitchWithLabel", () => {
100
117
  wrapper = await wrapperFactory({ fieldHasError: true, errorMessage: "Required" });
101
118
  expect(wrapper.find("input[type='checkbox']").attributes("aria-describedby")).toMatch(/-error-message$/);
102
119
  });
120
+
121
+ it("points aria-describedby at both the description and the error when both are present", async () => {
122
+ wrapper = await wrapperFactory(
123
+ { fieldHasError: true, errorMessage: "Required" },
124
+ { descriptionText: () => "Sends at most one email a week." }
125
+ );
126
+ const describedBy = wrapper.find("input[type='checkbox']").attributes("aria-describedby") ?? "";
127
+ const ids = describedBy.split(" ");
128
+ expect(ids).toHaveLength(2);
129
+ expect(ids[0]).toMatch(/-description$/);
130
+ expect(ids[1]).toMatch(/-error-message$/);
131
+ expect(wrapper.find(`[id="${ids[0]}"]`).exists()).toBe(true);
132
+ });
103
133
  });
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "srcdev-nuxt-components",
3
3
  "type": "module",
4
- "version": "9.5.0",
4
+ "version": "9.5.1",
5
5
  "main": "nuxt.config.ts",
6
6
  "types": "types.d.ts",
7
7
  "license": "MIT",