@ids-group-ltd/ids-design-system 0.10.3 → 0.11.0
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.
- package/CHANGELOG.md +359 -40
- package/components.md +14 -6
- package/fesm2022/ids-group-ltd-ids-design-system.mjs +559 -464
- package/fesm2022/ids-group-ltd-ids-design-system.mjs.map +1 -1
- package/migrations/0.1.0.json +2 -1
- package/migrations/0.10.0.json +209 -32
- package/migrations/0.10.1.json +33 -9
- package/migrations/0.10.2.json +88 -22
- package/migrations/0.10.3.json +21 -4
- package/migrations/0.11.0.json +216 -0
- package/migrations/0.2.0.json +22 -9
- package/migrations/0.2.1.json +2 -1
- package/migrations/0.2.2.json +2 -1
- package/migrations/0.3.0.json +16 -10
- package/migrations/0.4.0.json +38 -14
- package/migrations/0.5.0.json +49 -25
- package/migrations/0.5.1.json +75 -33
- package/migrations/0.6.0.json +6 -2
- package/migrations/0.6.1.json +19 -1
- package/migrations/0.6.2.json +3 -1
- package/migrations/0.6.3.json +13 -4
- package/migrations/0.7.0.json +45 -26
- package/migrations/0.7.1.json +57 -19
- package/migrations/0.8.0.json +50 -12
- package/migrations/0.9.0.json +142 -23
- package/migrations/0.9.1.json +2 -1
- package/package.json +2 -1
- package/styles/_link.scss +1 -2
- package/styles/_overlay-motion.scss +0 -1
- package/types/ids-group-ltd-ids-design-system.d.ts +129 -59
- package/migrations/AUTHORING.md +0 -273
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "0.11.0",
|
|
3
|
+
"items": [
|
|
4
|
+
{
|
|
5
|
+
"id": "exported-class-members-grew",
|
|
6
|
+
"kind": "behavior",
|
|
7
|
+
"old": "class MyTable extends TableComponent, class MyButton extends ButtonComponent, class MyField extends DsFieldBase (or any DS component/base you subclass)",
|
|
8
|
+
"new": null,
|
|
9
|
+
"action": "Only if you extend one of these and already declare one of the GAINED names: rename yours, or add `override` if you meant to replace ours. Build after upgrading — the compiler enumerates every collision.",
|
|
10
|
+
"appliesWhen": "Subclassing a DS component is unsupported, but consumers do it. Template users of the `<ds-…>` elements need nothing.",
|
|
11
|
+
"pitfall": "`protected` is no protection: a redeclared protected member collides exactly as a public one does. And read the report carefully — `hint`, `error`, `warning`, `messageIcon`, `reserveMessage` and `reserveMessageResolved` MOVED from DsFieldBase to a new DsMessageBase that DsFieldBase extends, so class-surface reports them as LOST from one and GAINED on the other. They still resolve through DsFieldBase with the same names, types and defaults, and `override` still works because it accepts a member from any ancestor. Nothing to do for those.",
|
|
12
|
+
"note": "Measured with `npm run class-surface` against 0.10.3. Gained: TableComponent `cellLink`; ButtonComponent `disabledReason`, `ariaDescribedBy`, `softDisabled`, `message`, `fieldMessage`, `hasMessageRow`, `describedBy`, `hintId`, `reasonId`, `uid`; IconButtonComponent `ariaDescribedBy`; SidenavComponent `brandRoute`, `brandLinkLabel` and the protected `brandAriaLabel`; CheckboxComponent and RadioGroupComponent each the protected `controlState`. TS4114 asks for an `override` modifier, TS2415 fires where the signature differs.",
|
|
13
|
+
"surface": "typescript",
|
|
14
|
+
"verify": "Build your app: no TS4114 or TS2415 is raised against a class that extends a DS component or DsFieldBase.",
|
|
15
|
+
"searchHints": [
|
|
16
|
+
"extends TableComponent",
|
|
17
|
+
"extends ButtonComponent",
|
|
18
|
+
"extends IconButtonComponent",
|
|
19
|
+
"extends DsFieldBase",
|
|
20
|
+
"cellLink",
|
|
21
|
+
"disabledReason",
|
|
22
|
+
"ariaDescribedBy",
|
|
23
|
+
"softDisabled",
|
|
24
|
+
"hasMessageRow",
|
|
25
|
+
"TS4114",
|
|
26
|
+
"TS2415",
|
|
27
|
+
"extends SidenavComponent",
|
|
28
|
+
"brandRoute",
|
|
29
|
+
"brandLinkLabel",
|
|
30
|
+
"brandAriaLabel",
|
|
31
|
+
"controlState"
|
|
32
|
+
],
|
|
33
|
+
"detect": [
|
|
34
|
+
"extends TableComponent",
|
|
35
|
+
"extends ButtonComponent",
|
|
36
|
+
"extends IconButtonComponent",
|
|
37
|
+
"extends DsFieldBase",
|
|
38
|
+
"cellLink",
|
|
39
|
+
"disabledReason",
|
|
40
|
+
"ariaDescribedBy",
|
|
41
|
+
"softDisabled",
|
|
42
|
+
"hasMessageRow",
|
|
43
|
+
"TS4114",
|
|
44
|
+
"TS2415",
|
|
45
|
+
"extends SidenavComponent",
|
|
46
|
+
"brandRoute",
|
|
47
|
+
"brandLinkLabel",
|
|
48
|
+
"brandAriaLabel",
|
|
49
|
+
"controlState"
|
|
50
|
+
]
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"id": "menu-divider-now-flush",
|
|
54
|
+
"kind": "behavior",
|
|
55
|
+
"old": "ds-menu-divider",
|
|
56
|
+
"new": null,
|
|
57
|
+
"surface": "style",
|
|
58
|
+
"note": "A divider is a boundary, not a row, so it no longer takes space of its own: it cancels ds-menu's row gap and the items sit flush against the line. Measured 0px above and 0px below, where it was one row gap (2px at the default --ds-menu-gap) on each side. Its own padding already defaulted to 0 in 0.8.0; this removes the gap that was landing on top of it. The --ds-menu-divider-spacing token is unchanged and still gives the boundary air.",
|
|
59
|
+
"action": "Nothing unless you set --ds-menu-divider-spacing. If you do, your boundary now measures your value alone instead of your value plus the row gap, so add one --ds-menu-gap back into it to keep the previous measurement.",
|
|
60
|
+
"appliesWhen": "Only menus that use ds-menu-divider.",
|
|
61
|
+
"pitfall": "0.8.0's restore recipe (`ds-menu { --ds-menu-divider-spacing: var(--space-1) }`) counts as setting it, so a menu that followed that advice tightens without anyone editing it.",
|
|
62
|
+
"verify": "Open a menu with a divider: the items touch the line. If you set the spacing token, the air either side equals your value exactly.",
|
|
63
|
+
"searchHints": [
|
|
64
|
+
"ds-menu-divider",
|
|
65
|
+
"--ds-menu-divider-spacing",
|
|
66
|
+
"--ds-menu-gap",
|
|
67
|
+
"menu-divider"
|
|
68
|
+
],
|
|
69
|
+
"detect": [
|
|
70
|
+
"ds-menu-divider",
|
|
71
|
+
"--ds-menu-divider-spacing"
|
|
72
|
+
]
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"id": "published-manifests-corrected",
|
|
76
|
+
"kind": "behavior",
|
|
77
|
+
"old": "A repo whose last @ids-group-ltd/ids-design-system upgrade ran before this release and crossed 0.2.0, 0.5.1, 0.7.1, 0.8.0, 0.9.0 or 0.10.0",
|
|
78
|
+
"new": null,
|
|
79
|
+
"action": "Re-run these items, now corrected in migrations/<version>.json: 0.2.0#surface-subtle-token-rename, 0.5.1#progress-variant-remap, 0.5.1#badge-variant-to-status-rename, 0.7.1#surface-motion-partial-a-la-carte, 0.7.1#modal-title-flex-moved-to-heading, 0.8.0#table-client-sort-replaced-by-sort-mode, 0.9.0#input-signal-types-widened-by-transforms, 0.10.0#input-floating-removed, 0.10.0#modal-confirm-error-tone-paints-a-badge. Nothing else in those files changed meaning.",
|
|
80
|
+
"appliesWhen": "Only for a repo that already stepped through one of those six versions. A first-time consumer, or one whose upgrade runs from here on, reads the corrected files and needs none of this. The six defects are independent - crossing 0.7.1 says nothing about 0.9.0.",
|
|
81
|
+
"pitfall": "Two of these UNDO work rather than adding it. 0.7.1 filed the modal `.title` as a rename to `.heading`; no rename ever happened, so a repo that renamed it on our word must put it back - `.title` still paints the heading text. And 0.7.1 handed out bare `styles/…` @use specifiers that resolve only inside the design-system repo: the line looks right and fails at build from an app. The 0.8.0 one is the silent case - an unset sortMode was documented as resolving to server when it resolves to client, so a server-paged table passes every check while sorting only the rows already on screen.",
|
|
82
|
+
"note": "Nine data defects found by auditing each published manifest against the code of its own release: three changes that had no item, two wrong instructions, one verify that certified a bug, and three items whose surface named too few file types.",
|
|
83
|
+
"surface": [
|
|
84
|
+
"style",
|
|
85
|
+
"template",
|
|
86
|
+
"typescript"
|
|
87
|
+
],
|
|
88
|
+
"verify": "No `--surface-subtle` remains in any stylesheet. No bare `@use 'styles/…'` of a design-system partial remains - each is package-qualified. Every ds-table that binds [total] declares sortMode=\"server\" explicitly. No `variant` remains on ds-badge or ds-progress in any file type. No stylesheet sets --field-h-floating, --field-floating-label-fs, --field-floating-label-lh, --field-floating-label-top or --field-floating-pad-t. The app builds with no TS2322 naming InputSignal and no TS2416 on a class extending a DS field.",
|
|
89
|
+
"searchHints": [
|
|
90
|
+
"--surface-subtle",
|
|
91
|
+
"@use 'styles/surface-motion'",
|
|
92
|
+
"@use 'styles/overlay-motion'",
|
|
93
|
+
".heading",
|
|
94
|
+
"sortMode",
|
|
95
|
+
"[total]",
|
|
96
|
+
"variant",
|
|
97
|
+
"--field-h-floating",
|
|
98
|
+
"--field-floating-label-fs",
|
|
99
|
+
"--field-floating-pad-t",
|
|
100
|
+
"InputSignal<",
|
|
101
|
+
"ds-badge",
|
|
102
|
+
"ds-progress",
|
|
103
|
+
"ds-modal-card",
|
|
104
|
+
"floating"
|
|
105
|
+
],
|
|
106
|
+
"detect": [
|
|
107
|
+
"--surface-subtle",
|
|
108
|
+
"@use 'styles/surface-motion'",
|
|
109
|
+
"@use 'styles/overlay-motion'",
|
|
110
|
+
"--field-h-floating",
|
|
111
|
+
"--field-floating-label-fs",
|
|
112
|
+
"--field-floating-label-lh",
|
|
113
|
+
"--field-floating-label-top",
|
|
114
|
+
"--field-floating-pad-t",
|
|
115
|
+
"InputSignal<",
|
|
116
|
+
"ds-modal-card ::ng-deep .heading"
|
|
117
|
+
]
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"id": "sidenav-item-without-destination-is-a-button",
|
|
121
|
+
"kind": "behavior",
|
|
122
|
+
"old": "ds-sidenav-item",
|
|
123
|
+
"new": null,
|
|
124
|
+
"surface": "template",
|
|
125
|
+
"note": "A ds-sidenav-item with neither routerLink nor href used to render <a href=\"#\">, which navigates: it rewrites the URL and discards the scroll position on click. It renders <button type=\"button\"> now. Styling is unchanged - the rules are class-based and the button's UA chrome is reset - and both anchor variants behave exactly as before.",
|
|
126
|
+
"action": "Nothing for an item that already sets href or routerLink. An item you INTENDED as a link needs one of those; an empty href no longer becomes \"#\". If any CSS or test selects the item by tag, widen it to the class: `.item` covers all three variants.",
|
|
127
|
+
"appliesWhen": "Only items with no href and no routerLink.",
|
|
128
|
+
"pitfall": "A querySelector('ds-sidenav-item a') or an `a` type selector silently matches nothing for those items now.",
|
|
129
|
+
"verify": "Click a destination-less item: the URL and the scroll position stay put, and `activate` still fires.",
|
|
130
|
+
"searchHints": [
|
|
131
|
+
"ds-sidenav-item",
|
|
132
|
+
"href=\"#\"",
|
|
133
|
+
"sidenav-item a",
|
|
134
|
+
"activate"
|
|
135
|
+
],
|
|
136
|
+
"detect": [
|
|
137
|
+
"ds-sidenav-item",
|
|
138
|
+
"sidenav-item a"
|
|
139
|
+
]
|
|
140
|
+
}
|
|
141
|
+
],
|
|
142
|
+
"informational": [
|
|
143
|
+
"`--ds-field-message-icon-offset` and `--ds-time-picker-focus-shadow` are public, overridable, and listed in the token reference - the supported way to retune either. Nothing changed in the components - if you hand-rolled around either because it looked unsupported, the override is supported and is the way to do it. They belong with the twelve named under 0.10.3.",
|
|
144
|
+
"If you applied 0.10.2 before its manifest was completed, two of its notes were reachable only from the CHANGELOG; this is one of them. components.md, the digest dist/ds carries for your own agent, had named --primary, --text-on-primary and --secondary as the active ds-sidenav-item defaults - the wash replaced them, so an override written against those three does not do what it looks like.",
|
|
145
|
+
"The second note 0.10.2 kept only in its CHANGELOG: `data-focus=\"inset\"` (shipped in that release) draws the focus ring INSIDE the border box, for a subtree under an overflow:hidden ancestor that would otherwise clip it away entirely. It is the only focus style not pinned to :root - set it on the clipping element.",
|
|
146
|
+
"ds-table columns take a new optional `link: (row) => string | readonly unknown[] | null`. Nothing changes on a column that does not set it; see the class-surface entry if you SUBCLASS TableComponent. Where you compensated for an invisible row click by repeating the destination as a 'View Details' item in the row overflow menu, that item can go: give the name column `link` instead and the destination becomes a real <a> - tabbable as a link, Ctrl/Cmd-clickable, and announced as a link rather than as a table row. If you also set `rowInteractive`, note the pair costs two tab stops per row; the link alone is usually the better trade on a long list. (delete list: row-menu-view-details-duplicate)",
|
|
147
|
+
"ds-card gains --ds-card-overflow, default visible. Opt-in on purpose: clipping a card also cuts the focus ring off any child at its edge, so where a clipped card holds focusable content pair it with data-focus=\"inset\".",
|
|
148
|
+
"ds-button gains --ds-button-shadow and --ds-button-shadow-hover, both default none. Purely additive; -shadow-hover falls back to -shadow, and the focus/pressed hooks still win in their own states.",
|
|
149
|
+
"ds-button gains disabledReason, hint, warning, error, messageIcon, reserveMessage and ariaDescribedBy; ds-icon-button gains ariaDescribedBy. All additive - a button that sets none of them is byte-identical in behaviour and layout. Two things worth knowing before you use them. (1) disabledReason CHANGES HOW THE BUTTON IS DISABLED: with a reason set the button carries aria-disabled=\"true\" instead of the native disabled attribute, so it stays focusable and the reason is announced as its accessible description; the click is swallowed in the handler, so (pressed) still never fires. If you have CSS keyed on `ds-button button[disabled]` or `:disabled`, add `[aria-disabled=\"true\"]` - the library's own disabled paint already covers both. (2) hint/warning/error are for the OTHER kind of refusal: a temporary one the user lifts by filling the form in. Do not disable the button for those - leave it live, judge validity in the submit handler, and let the message line explain. A message-bearing button becomes a column, and since the host shrinks to fit, a message longer than the label widens the pair, button included. (delete list: button-disabled-reason-tooltip)",
|
|
150
|
+
"Every item in every published manifest now carries `action` (the imperative alone, the only field to execute), `appliesWhen` (the boundary, including what is NOT affected) and `pitfall` (the way to apply it correctly and still break the app); `note` keeps the reasoning. If you read these files with your own tooling, read `action` first and `pitfall` before reporting an item done. Nothing was removed - every field that was there is still there with the same name and meaning.",
|
|
151
|
+
"ds-w3w renders `///word.word.word` flush now. It previously showed a space after the `///` prefix (7.8px wider than the format allows, measured), which also disagreed with its own aria-label. Purely a rendering fix - no API change and nothing to edit. Worth a look only if you compensated for the space: a negative margin or a letter-spacing tweak aimed at ds-w3w's mark, or a hand-built pill you wrote because the DS one looked wrong, would now over-correct.",
|
|
152
|
+
"ds-banner now sets `text-align: start` on its own box instead of inheriting. Nothing to do unless you were centring a banner by centring its container - that no longer reaches the banner, and the fix is to say so rather than to work around it. The reported symptom (a centred title over a start-aligned body) does not come from the DS: measured across every banner and both layouts, title and body both compute `start`, and a centred ancestor moves BOTH - it cannot split them. If you still see the split, something on your side targets `.title` or `.body` directly; those are generic class names and a global rule reaches them.",
|
|
153
|
+
"ds-sidenav-footer's account menu uses ds-menu-divider now instead of a hand-rolled div, so --ds-menu-divider-color and --ds-menu-divider-spacing finally reach it. Its line also moves CLOSER - it sat 6px from its neighbours and is flush now, along with every other divider; see the menu-divider-now-flush item for what that means if you set the spacing token.",
|
|
154
|
+
"A compact ds-banner with a title longer than its container used to overflow that container and cut the title mid-word with no ellipsis; it now ellipsises and the banner shrinks to fit. Nothing to edit. Worth a look only if you compensated for it - a width, a min-width or a font-size override on a compact banner, or a title you shortened to stop it blowing out a narrow column, can go back to the wording you wanted.",
|
|
155
|
+
"ds-table's pagination footer is now inset like the cells (horizontally by --ds-table-cell-pad-x, and the same at the bottom as the top). It previously had padding-top only, so the summary line sat 16px left of the column text and on the container's border. Nothing to edit - and if you carried a TODO(ds-table-footer-padding) or a local rule padding .pagination-footer, it can go. A local rule will now DOUBLE the inset, so check for one. (delete list: table-footer-padding-workaround)",
|
|
156
|
+
"ds-banner's projected body takes --font-size-s now, overridable via the new --ds-banner-body-font-size, instead of inheriting the page size - a 16px context used to render the body larger than the banner's own 14px title. The title/body gap also moved onto the body, so it appears only when a body exists: a compact banner with BOTH a title and a body no longer runs them together, and a title-only banner gains no trailing space. If you set a font-size on a banner's content from outside to compensate, drop it or move it to the token.",
|
|
157
|
+
"ds-sidenav gains brandRoute and brandLinkLabel: set brandRoute and the brand row becomes a link (typically to home), announced as \"<brand>, home\" unless brandLinkLabel says otherwise. Unset, the row is the plain block it always was, so nothing changes without an explicit opt-in. Router targets only, and RouterLink is instantiated only once the input is set. If you hand-rolled a link around the brand slot, this replaces it.",
|
|
158
|
+
"ds-checkbox and ds-radio-group paint a validation state on the control now: the checkbox reddens its border (border only - a fill at 16px reads as checked), the radio group reddens its label (not the rings - an unanswered group is not five wrong radios). Both also handle warning. Purely additive, and only visible where you already bind error/errors/invalid. ds-radio, ds-switch and ds-slider deliberately do NOT paint: a lone radio's choice belongs to its group, a switch applies on flip rather than on submit, and a slider always holds an in-range value. If you hand-rolled a red outline on a checkbox or a red group label, drop it - it will now double up."
|
|
159
|
+
],
|
|
160
|
+
"deleteList": [
|
|
161
|
+
{
|
|
162
|
+
"id": "card-overflow-ng-deep-workaround",
|
|
163
|
+
"surface": "style",
|
|
164
|
+
"find": [
|
|
165
|
+
"ds-card .card",
|
|
166
|
+
"overflow: hidden",
|
|
167
|
+
"::ng-deep"
|
|
168
|
+
],
|
|
169
|
+
"why": "A ::ng-deep reach into ds-card's inner .card to clip a full-bleed child (an image or footer strip) inside the card radius, because no token exposed it.",
|
|
170
|
+
"replaceWith": "--ds-card-overflow: clip on the card (clip, not hidden — it keeps the card from becoming a scroll container)"
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"id": "row-menu-view-details-duplicate",
|
|
174
|
+
"surface": "template",
|
|
175
|
+
"find": [
|
|
176
|
+
"View Details",
|
|
177
|
+
"ds-menu-item",
|
|
178
|
+
"rowActions"
|
|
179
|
+
],
|
|
180
|
+
"why": "A \"View Details\" entry in a row overflow menu that only repeats where the row already leads. It existed because the row click was the sole, invisible way in; a naming column with `link` makes the destination a real anchor, so the menu entry is a second control for the same navigation.",
|
|
181
|
+
"replaceWith": "set `link` on the column that names the record, and delete the menu item"
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
"id": "button-resting-shadow-ng-deep",
|
|
185
|
+
"surface": "style",
|
|
186
|
+
"find": [
|
|
187
|
+
"::ng-deep ds-button button",
|
|
188
|
+
"ds-button button",
|
|
189
|
+
"box-shadow"
|
|
190
|
+
],
|
|
191
|
+
"why": "A deep selector into ds-button's inner <button> kept alive only by a resting box-shadow — background, colour, weight and border already had tokens.",
|
|
192
|
+
"replaceWith": "--ds-button-shadow (and --ds-button-shadow-hover) on the ds-button host"
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"id": "button-disabled-reason-tooltip",
|
|
196
|
+
"surface": "template",
|
|
197
|
+
"find": [
|
|
198
|
+
"dsTooltip",
|
|
199
|
+
"ds-button",
|
|
200
|
+
"disabled"
|
|
201
|
+
],
|
|
202
|
+
"why": "A tooltip on a disabled ds-button used to carry the reason it is refused. It reaches a mouse only: a natively disabled button never takes focus, so a keyboard user gets nothing and a screen reader gets no description. Applies to the tooltip that EXPLAINS the refusal, not to one that merely names the action - leave the latter alone.",
|
|
203
|
+
"replaceWith": "[disabledReason]=\"'...'\" on the ds-button for a standing refusal (no permission, no integration); for a refusal the user can lift by filling the form in, drop `disabled` altogether and use [error]/[warning]/[hint] with validity judged in the submit handler"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"id": "table-footer-padding-workaround",
|
|
207
|
+
"surface": "style",
|
|
208
|
+
"find": [
|
|
209
|
+
"pagination-footer",
|
|
210
|
+
"TODO(ds-table-footer-padding)"
|
|
211
|
+
],
|
|
212
|
+
"why": "A local rule padding ds-table's `.pagination-footer`, added because the component gave it a top inset only — so the summary line sat left of the column text and on the container's border. The footer is inset by the cells' own padding now, and a local rule DOUBLES it.",
|
|
213
|
+
"replaceWith": "nothing — and retune both together through --ds-table-cell-pad-x if the inset is wrong for you"
|
|
214
|
+
}
|
|
215
|
+
]
|
|
216
|
+
}
|
package/migrations/0.2.0.json
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"kind": "token-rename",
|
|
7
7
|
"old": "--border-subtle",
|
|
8
8
|
"new": "--border-subtitle",
|
|
9
|
-
"
|
|
9
|
+
"action": "Replace `--border-subtle` with `--border-subtitle`.",
|
|
10
10
|
"searchHints": [
|
|
11
11
|
"--border-subtle"
|
|
12
12
|
],
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"kind": "token-rename",
|
|
18
18
|
"old": "--primary-subtle",
|
|
19
19
|
"new": "--primary-subtitle",
|
|
20
|
-
"
|
|
20
|
+
"action": "Replace `--primary-subtle` with `--primary-subtitle`.",
|
|
21
21
|
"searchHints": [
|
|
22
22
|
"--primary-subtle"
|
|
23
23
|
],
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"kind": "token-rename",
|
|
29
29
|
"old": "--secondary-subtle",
|
|
30
30
|
"new": "--secondary-subtitle",
|
|
31
|
-
"
|
|
31
|
+
"action": "Replace `--secondary-subtle` with `--secondary-subtitle`.",
|
|
32
32
|
"searchHints": [
|
|
33
33
|
"--secondary-subtle"
|
|
34
34
|
],
|
|
@@ -39,18 +39,29 @@
|
|
|
39
39
|
"kind": "token-rename",
|
|
40
40
|
"old": "--tertiary-subtle",
|
|
41
41
|
"new": "--tertiary-subtitle",
|
|
42
|
-
"
|
|
42
|
+
"action": "Replace `--tertiary-subtle` with `--tertiary-subtitle`.",
|
|
43
43
|
"searchHints": [
|
|
44
44
|
"--tertiary-subtle"
|
|
45
45
|
],
|
|
46
46
|
"surface": "style"
|
|
47
47
|
},
|
|
48
|
+
{
|
|
49
|
+
"id": "surface-subtle-token-rename",
|
|
50
|
+
"kind": "token-rename",
|
|
51
|
+
"old": "--surface-subtle",
|
|
52
|
+
"new": "--surface-subtitle",
|
|
53
|
+
"action": "Replace `--surface-subtle` with `--surface-subtitle`.",
|
|
54
|
+
"searchHints": [
|
|
55
|
+
"--surface-subtle"
|
|
56
|
+
],
|
|
57
|
+
"surface": "style"
|
|
58
|
+
},
|
|
48
59
|
{
|
|
49
60
|
"id": "success-subtle-token-rename",
|
|
50
61
|
"kind": "token-rename",
|
|
51
62
|
"old": "--success-subtle",
|
|
52
63
|
"new": "--success-subtitle",
|
|
53
|
-
"
|
|
64
|
+
"action": "Replace `--success-subtle` with `--success-subtitle`.",
|
|
54
65
|
"searchHints": [
|
|
55
66
|
"--success-subtle"
|
|
56
67
|
],
|
|
@@ -61,7 +72,7 @@
|
|
|
61
72
|
"kind": "token-rename",
|
|
62
73
|
"old": "--warning-subtle",
|
|
63
74
|
"new": "--warning-subtitle",
|
|
64
|
-
"
|
|
75
|
+
"action": "Replace `--warning-subtle` with `--warning-subtitle`.",
|
|
65
76
|
"searchHints": [
|
|
66
77
|
"--warning-subtle"
|
|
67
78
|
],
|
|
@@ -72,7 +83,7 @@
|
|
|
72
83
|
"kind": "token-rename",
|
|
73
84
|
"old": "--error-subtle",
|
|
74
85
|
"new": "--error-subtitle",
|
|
75
|
-
"
|
|
86
|
+
"action": "Replace `--error-subtle` with `--error-subtitle`.",
|
|
76
87
|
"searchHints": [
|
|
77
88
|
"--error-subtle"
|
|
78
89
|
],
|
|
@@ -83,7 +94,7 @@
|
|
|
83
94
|
"kind": "token-rename",
|
|
84
95
|
"old": "--info-subtle",
|
|
85
96
|
"new": "--info-subtitle",
|
|
86
|
-
"
|
|
97
|
+
"action": "Replace `--info-subtle` with `--info-subtitle`.",
|
|
87
98
|
"searchHints": [
|
|
88
99
|
"--info-subtle"
|
|
89
100
|
],
|
|
@@ -91,7 +102,9 @@
|
|
|
91
102
|
}
|
|
92
103
|
],
|
|
93
104
|
"informational": [
|
|
105
|
+
"All nine `--*-subtle` semantic tokens became `--*-subtitle` in this release - border, primary, secondary, tertiary, surface, success, warning, error and info. Each has its own item above; no token keeps the old spelling, and no longer token is built on one of these names, so the nine renames are independent and can be applied in any order.",
|
|
94
106
|
"Theme re-skin guidance clarified in the shipped themes/README (brand roles retint from the --blue ramp; a fully calibrated brand may set --primary-* roles directly).",
|
|
95
107
|
"Relicensed from proprietary (UNLICENSED) to MIT."
|
|
96
|
-
]
|
|
108
|
+
],
|
|
109
|
+
"deleteList": []
|
|
97
110
|
}
|
package/migrations/0.2.1.json
CHANGED
package/migrations/0.2.2.json
CHANGED
|
@@ -4,5 +4,6 @@
|
|
|
4
4
|
"informational": [
|
|
5
5
|
"New .t-mono-inline typography utility (inline code chip), completing the mono family alongside .t-mono and .t-mono-block — additive.",
|
|
6
6
|
"npm package hygiene: repository field dropped from package.json, maintainer docs moved to repo-only CONTRIBUTING.md, README license entry made plain text (fixes the npm 404). No consumer action."
|
|
7
|
-
]
|
|
7
|
+
],
|
|
8
|
+
"deleteList": []
|
|
8
9
|
}
|
package/migrations/0.3.0.json
CHANGED
|
@@ -6,7 +6,10 @@
|
|
|
6
6
|
"kind": "token-rename",
|
|
7
7
|
"old": "--ds-*-bg",
|
|
8
8
|
"new": "--ds-*-bg-color",
|
|
9
|
-
"
|
|
9
|
+
"action": "Append `-color` to every DS token whose name ends in `-bg`. Covers the public `--ds-<component>-…-bg` hooks on avatar, badge, banner, button, card, date-picker, dropzone, empty-state, icon-button, input, modal, pagination, search, sidenav, stat, table, tabs, tag, toast and topbar, plus the globals `--select-bg`, `--chart-hover-bg`, `--chart-tooltip-bg` and the `--status-<x>-bg` set.",
|
|
10
|
+
"appliesWhen": "Only to DS-owned tokens. Your own variables ending in `-bg` are untouched, and the private `--_*` internals renamed in lockstep have no public hook, so they need nothing.",
|
|
11
|
+
"pitfall": "A blind search-and-replace on `-bg` renames YOUR variables too, and the result still compiles — a custom property resolves to nothing and the element silently loses its background. Before replacing a name, confirm the `-color` spelling exists in the installed 0.3.0 package under `themes/` or `styles/`; if it does not, the token was yours.",
|
|
12
|
+
"note": "The tokens held only a colour and now feed `background-color`, so the name says which property it reaches.",
|
|
10
13
|
"searchHints": [
|
|
11
14
|
"-bg:",
|
|
12
15
|
"-bg)",
|
|
@@ -22,17 +25,16 @@
|
|
|
22
25
|
"kind": "behavior",
|
|
23
26
|
"old": "--ds-*-fg",
|
|
24
27
|
"new": null,
|
|
25
|
-
"
|
|
28
|
+
"action": "For each `-fg` token you override, look the replacement up in the installed 0.3.0 package (`themes/`, `styles/`, and the component SCSS) and use the exact name you find. Three suffixes are in play and the split is real: at 0.3.0 the sources carry 23 `-text-color`, 49 `-label-color` and 21 `-icon-color`.",
|
|
29
|
+
"appliesWhen": "Only to DS-owned tokens. A variable of your own ending in `-fg` is untouched.",
|
|
30
|
+
"pitfall": "The suffix is NOT derivable from the old name, so guessing produces a name nothing reads and a silently unstyled element. Same shape, three answers: `--ds-modal-title-fg` became `-text-color`, `--ds-sidenav-group-fg` became `-label-color`, `--ds-icon-button-fg` became `-icon-color`.",
|
|
31
|
+
"note": "The `fg` abbreviation was dropped for a suffix that says what the token paints — text, a control or nav label, or a glyph. It covers the public `--ds-<component>-…-fg` hooks on avatar, badge, banner, breadcrumbs, button, date-picker, dropzone, empty-state, icon-button, input, menu, modal, page-header, pagination, search, sidenav, table, tabs, tag and topbar, plus the `--status-*` and chart-tooltip globals.",
|
|
26
32
|
"searchHints": [
|
|
27
33
|
"-fg:",
|
|
28
34
|
"-fg)",
|
|
29
35
|
"--status-"
|
|
30
36
|
],
|
|
31
37
|
"surface": "style",
|
|
32
|
-
"detect": [
|
|
33
|
-
"-fg",
|
|
34
|
-
"--ds-"
|
|
35
|
-
],
|
|
36
38
|
"verify": "No stylesheet declares or reads a --ds-*-fg token; each one names the semantic replacement its component reads (-text-color / -label-color / -icon-color)."
|
|
37
39
|
},
|
|
38
40
|
{
|
|
@@ -40,7 +42,9 @@
|
|
|
40
42
|
"kind": "behavior",
|
|
41
43
|
"old": "ds-stepper",
|
|
42
44
|
"new": null,
|
|
43
|
-
"
|
|
45
|
+
"action": "Read every caption you pass in `[steps]` as on-screen text and reword the ones written to be heard rather than seen. `labelPosition` (`bottom` | `inline`, default `bottom`) sets where they sit.",
|
|
46
|
+
"pitfall": "Nothing breaks and no build fails, so this ships unless somebody looks. Captions authored for a screen reader tend to carry the context the screen already gives — \"Step 2 of 5: enter your details\" reads fine when announced and badly when printed under a numbered dot.",
|
|
47
|
+
"note": "`[steps]` takes a `readonly string[]`, and those strings used to be screen-reader-only: on screen a step showed only its number. They render as visible labels now.",
|
|
44
48
|
"searchHints": [
|
|
45
49
|
"<ds-stepper",
|
|
46
50
|
"[steps]"
|
|
@@ -50,8 +54,9 @@
|
|
|
50
54
|
"typescript"
|
|
51
55
|
],
|
|
52
56
|
"detect": [
|
|
53
|
-
"
|
|
54
|
-
"steps"
|
|
57
|
+
"[steps]=",
|
|
58
|
+
"steps: string[]",
|
|
59
|
+
"readonly string[]"
|
|
55
60
|
],
|
|
56
61
|
"verify": "Every caption passed in [steps] is written to be READ on screen, not only announced - they render visibly now."
|
|
57
62
|
}
|
|
@@ -61,5 +66,6 @@
|
|
|
61
66
|
"ng add support (wires the global styles import idempotently); ds-combobox size input (+ComboboxSize); overridable focus-ring token system (--ds-field-focus-shadow / --ds-control-focus-shadow groups + per-component --ds-<comp>-focus-shadow hooks, default appearance unchanged); ds-tag hover tokens; --opacity-state-active overlay token — all additive.",
|
|
62
67
|
"Visual-only: tag close button gains a pressed state; accordion & sidenav-group animate open/close (collapsed content now stays in the DOM marked inert instead of being removed); ds-combobox focus uses the soft field halo; repo-wide value-preserving CSS modernization (background-color precision, modern hsl()/clip-path/range media syntax).",
|
|
63
68
|
"Fixes: ds-drawer closes on Escape when focus left the panel; ds-combobox 'No matches' row no longer selectable."
|
|
64
|
-
]
|
|
69
|
+
],
|
|
70
|
+
"deleteList": []
|
|
65
71
|
}
|
package/migrations/0.4.0.json
CHANGED
|
@@ -6,7 +6,10 @@
|
|
|
6
6
|
"kind": "value-remap",
|
|
7
7
|
"old": "ds-button[variant]",
|
|
8
8
|
"new": null,
|
|
9
|
-
"
|
|
9
|
+
"action": "Apply the map to every static `variant=\"…\"`. For a dynamic `[variant]=\"expr\"`: if the expression only ever yields hues (primary/error/success/warning), rebind it to `[color]=\"expr\"` verbatim; if it yields a mix of hues and fills, retype it and split it across the two inputs.",
|
|
10
|
+
"appliesWhen": "`variant=\"text\"` keeps working and its map entry is an identity, so leave it. It warns in dev builds (prefer the global `.link` class) but needs no migration.",
|
|
11
|
+
"pitfall": "A dynamic `[variant]` left bound to a hue does not fail — the value is simply not a variant any more, so it falls back to `solid` and the button quietly renders in the default colour. Nothing throws and nothing logs in production; only looking at the screen finds it.",
|
|
12
|
+
"note": "One conflated input became two orthogonal axes: `color` (primary|secondary|tertiary|neutral|error|success|warning, default primary) and `variant` (solid|tonal|ghost|outline|text, default solid).",
|
|
10
13
|
"searchHints": [
|
|
11
14
|
"<ds-button",
|
|
12
15
|
"variant=\"",
|
|
@@ -22,14 +25,18 @@
|
|
|
22
25
|
"warning": "color=\"warning\"",
|
|
23
26
|
"text": "variant=\"text\""
|
|
24
27
|
},
|
|
25
|
-
"surface": "template"
|
|
28
|
+
"surface": "template",
|
|
29
|
+
"verify": "No ds-button carries a variant value outside the shipped set, and every button that used to name a colour through `variant` now names it through the colour input. Buttons render in the colour they did before the upgrade, not all in the default."
|
|
26
30
|
},
|
|
27
31
|
{
|
|
28
32
|
"id": "ds-button-size-legacy-tier",
|
|
29
33
|
"kind": "value-remap",
|
|
30
34
|
"old": "ds-button[size]",
|
|
31
35
|
"new": null,
|
|
32
|
-
"
|
|
36
|
+
"action": "Apply the map in templates, and remap the same literals in TypeScript: the exported `ButtonSize` narrowed from `s|m|l|sm|md|lg` to `sm|md|lg`, so a field or input typed with it and assigned `'s'`, `'m'` or `'l'` stops compiling.",
|
|
37
|
+
"appliesWhen": "`sm`, `md` and `lg` are unchanged and absent from the map — leave them. A button with no `size` keeps the 40px it had as the old default `l`.",
|
|
38
|
+
"pitfall": "`m`→`sm` and `l`→`md` are pure renames, but `s`→`sm` is not: the 24px tier is gone and `sm` is 32px, so those buttons get **8px taller** and the row around them reflows. It compiles, it looks deliberate, and only a screen shows it.",
|
|
39
|
+
"note": "ButtonSize collapsed to sm|md|lg (32/40/48px at default density) and the duplicate one-letter tier was dropped.",
|
|
33
40
|
"searchHints": [
|
|
34
41
|
"<ds-button",
|
|
35
42
|
"size=\"",
|
|
@@ -41,14 +48,17 @@
|
|
|
41
48
|
"l": "size=\"md\""
|
|
42
49
|
},
|
|
43
50
|
"surface": "template",
|
|
44
|
-
"restore": "nothing to restore - the 24px tier is gone; its callers take sm (32px), and an attribute-less button keeps the same 40px it had as `l`"
|
|
51
|
+
"restore": "nothing to restore - the 24px tier is gone; its callers take sm (32px), and an attribute-less button keeps the same 40px it had as `l`",
|
|
52
|
+
"verify": "No ds-button binds size=\"s\", \"m\" or \"l\". A button left without size renders at the md height (40px), and every button that previously said \"l\" now says \"md\" and is unchanged on screen."
|
|
45
53
|
},
|
|
46
54
|
{
|
|
47
55
|
"id": "ds-button-ts-types-retyped",
|
|
48
56
|
"kind": "behavior",
|
|
49
57
|
"old": "ButtonVariant",
|
|
50
58
|
"new": null,
|
|
51
|
-
"
|
|
59
|
+
"action": "Retype per axis. A union of only hues becomes `ButtonColor` and its bindings move to `[color]`; a union of only fills keeps `ButtonVariant` and remaps its values (secondary→tonal, tertiary→ghost, outline stays); a union carrying both must be split into two.",
|
|
60
|
+
"pitfall": "A mixed union is the one that does not announce itself: it still satisfies neither type cleanly, and the tempting fix — widening it back to `string` — compiles everywhere and moves the failure to runtime, where an unknown value silently falls back to the default.",
|
|
61
|
+
"note": "`ButtonVariant` now holds the fill vocabulary (solid|tonal|ghost|outline|text); the hues moved to a new exported `ButtonColor` (primary|secondary|tertiary|neutral|error|success|warning).",
|
|
52
62
|
"searchHints": [
|
|
53
63
|
"ButtonVariant",
|
|
54
64
|
"ButtonColor"
|
|
@@ -65,7 +75,9 @@
|
|
|
65
75
|
"kind": "behavior",
|
|
66
76
|
"old": "ds-radio",
|
|
67
77
|
"new": null,
|
|
68
|
-
"
|
|
78
|
+
"action": "Wrap every group of `<ds-radio value>` that is bound into a reactive or template-driven form in `<ds-radio-group>`, and move `formControlName` / `[formControl]` / `[(ngModel)]` onto the group.",
|
|
79
|
+
"appliesWhen": "A standalone `<ds-radio [(checked)]>` outside a form is unaffected.",
|
|
80
|
+
"note": "`ds-radio-group` is the container and the form control now: it owns the ControlValueAccessor, the roving tabindex, the `name`, and the group label, invalid and hint.",
|
|
69
81
|
"searchHints": [
|
|
70
82
|
"<ds-radio",
|
|
71
83
|
"formControlName",
|
|
@@ -84,7 +96,8 @@
|
|
|
84
96
|
"kind": "token-rename",
|
|
85
97
|
"old": "--ds-input-hint-color",
|
|
86
98
|
"new": "--ds-field-message-color",
|
|
87
|
-
"
|
|
99
|
+
"action": "Replace `--ds-input-hint-color` with `--ds-field-message-color`.",
|
|
100
|
+
"note": "Helper and error text is rendered by the shared `ds-field-message` now, so the hook reaches every field's message line rather than only the input's.",
|
|
88
101
|
"searchHints": [
|
|
89
102
|
"--ds-input-hint-color"
|
|
90
103
|
],
|
|
@@ -95,7 +108,7 @@
|
|
|
95
108
|
"kind": "token-rename",
|
|
96
109
|
"old": "--ds-input-hint-fs",
|
|
97
110
|
"new": "--ds-field-message-font-size",
|
|
98
|
-
"
|
|
111
|
+
"action": "Replace `--ds-input-hint-fs` with `--ds-field-message-font-size`.",
|
|
99
112
|
"searchHints": [
|
|
100
113
|
"--ds-input-hint-fs"
|
|
101
114
|
],
|
|
@@ -106,7 +119,9 @@
|
|
|
106
119
|
"kind": "behavior",
|
|
107
120
|
"old": "ds-bottom-sheet",
|
|
108
121
|
"new": null,
|
|
109
|
-
"
|
|
122
|
+
"action": "Read every `(closed)` handler and check it does not depend on running in the same tick as the click.",
|
|
123
|
+
"pitfall": "The handlers that break are the ones that look harmless: re-opening the sheet immediately now races the leave animation, and a focus move made in the handler lands while the panel is still on screen and gets taken back.",
|
|
124
|
+
"note": "The close animates, so `(closed)` emits at the END of the leave animation instead of on the click.",
|
|
110
125
|
"searchHints": [
|
|
111
126
|
"<ds-bottom-sheet",
|
|
112
127
|
"(closed)"
|
|
@@ -123,7 +138,9 @@
|
|
|
123
138
|
"kind": "behavior",
|
|
124
139
|
"old": "--ds-button-pressed-shadow",
|
|
125
140
|
"new": null,
|
|
126
|
-
"
|
|
141
|
+
"action": "None, unless you relied on the pressed halo. To keep it, declare `--ds-button-pressed-shadow` explicitly.",
|
|
142
|
+
"appliesWhen": "Only where the token was being read. No usage, no action.",
|
|
143
|
+
"note": "The faint pressed halo now defaults to `none`; press feedback is a darken plus a micro scale-down.",
|
|
127
144
|
"searchHints": [
|
|
128
145
|
"--ds-button-pressed-shadow"
|
|
129
146
|
],
|
|
@@ -136,7 +153,9 @@
|
|
|
136
153
|
"kind": "behavior",
|
|
137
154
|
"old": "ds-button",
|
|
138
155
|
"new": null,
|
|
139
|
-
"
|
|
156
|
+
"action": "Look at the disabled state of every button variant you actually use. To go back to the flat grey, pin the per-variant `--ds-button-*-disabled` / `--ds-icon-button-*-disabled` hooks.",
|
|
157
|
+
"pitfall": "The tint is derived from each variant's own colour, so a brand that recoloured one variant gets a disabled state it never chose — and because nothing in the API moved, no build or type check points at it.",
|
|
158
|
+
"note": "Disabled is a per-variant muted tint now rather than one flat grey: solid and text take a flat pale oklch tint, while tonal, ghost, outline and the icon-button tonal and outlined variants use `color-mix` with `--surface-disabled`.",
|
|
140
159
|
"searchHints": [
|
|
141
160
|
"<ds-button",
|
|
142
161
|
"<ds-icon-button"
|
|
@@ -150,7 +169,9 @@
|
|
|
150
169
|
"kind": "behavior",
|
|
151
170
|
"old": "ds-modal",
|
|
152
171
|
"new": null,
|
|
153
|
-
"
|
|
172
|
+
"action": "Read every close-related handler on `ds-modal` and `ds-drawer` and check it does not depend on running in the same tick as the dismiss.",
|
|
173
|
+
"pitfall": "Same shape as the bottom sheet: an immediate re-open races the leave animation, and a focus hand-off made in the handler lands while the panel is still visible.",
|
|
174
|
+
"note": "Both animate their close now — animate-then-remove, like ds-bottom-sheet — and honour `prefers-reduced-motion`, so close-related outputs fire at the end of the leave animation.",
|
|
154
175
|
"searchHints": [
|
|
155
176
|
"<ds-modal",
|
|
156
177
|
"<ds-drawer"
|
|
@@ -169,7 +190,9 @@
|
|
|
169
190
|
"kind": "code-add",
|
|
170
191
|
"old": null,
|
|
171
192
|
"new": "@use '@ids-group-ltd/ids-design-system/styles/breakpoints';",
|
|
172
|
-
"
|
|
193
|
+
"action": "Add the `@use` beside your existing `styles/tokens` import.",
|
|
194
|
+
"appliesWhen": "Only if you import `styles/tokens` a la carte. The `styles/ds` entry forwards both, so its users need nothing.",
|
|
195
|
+
"note": "The `--bp-*` custom properties moved into a new `styles/breakpoints` partial, so a tokens-only importer no longer gets them.",
|
|
173
196
|
"searchHints": [
|
|
174
197
|
"styles/tokens",
|
|
175
198
|
"@use '@ids-group-ltd/ids-design-system/styles/tokens'"
|
|
@@ -184,5 +207,6 @@
|
|
|
184
207
|
"ds-button overlay-trigger inputs (ariaHasPopup/ariaExpanded/buttonRef); date-picker month/year grid pickers; table pagination/clientSort/stickyFirstColumn; ModalService.confirm(); dropzone per-file message + queued state — additive.",
|
|
185
208
|
"$bp-* Sass breakpoint aliases + up()/down() mixins; new disabled-state and press-scale override tokens — additive (a-la-carte styles/tokens importers also need styles/breakpoints now).",
|
|
186
209
|
"Visual-only: button/icon-button press is darken + micro scale-down; [disabled] is a per-variant muted tint (override --ds-*-disabled tokens to restore flat grey); smooth motion pass across components; reduced-motion no longer freezes spinners; overlay scroll-lock release fix."
|
|
187
|
-
]
|
|
210
|
+
],
|
|
211
|
+
"deleteList": []
|
|
188
212
|
}
|