@godxjp/ui 32.0.1 → 32.0.3
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/agent/START-HERE.md +1 -1
- package/agent/components/Sheet.json +1 -0
- package/agent/components.json +1 -0
- package/agent/index.json +2 -2
- package/agent/llms.txt +3 -3
- package/dist/contracts/measurement.json +1 -1
- package/dist/email/index.d.ts +13 -6
- package/dist/email/index.js +24 -4
- package/dist/styles/dialog-layout.css +8 -0
- package/dist/styles/layers.json +1 -1
- package/dist/styles.css +1 -1
- package/docs/migrations/v32.md +7 -2
- package/package.json +2 -2
- package/scripts/ui-audit.mjs +117 -36
package/agent/START-HERE.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
You are about to write code against a design system you did not author. This file is the whole
|
|
4
4
|
contract. Read it before you write JSX.
|
|
5
5
|
|
|
6
|
-
**This catalog describes `@godxjp/ui` 32.0.
|
|
6
|
+
**This catalog describes `@godxjp/ui` 32.0.3.** If the project you are editing has a different
|
|
7
7
|
version in its `package.json`, read the pinned catalog for THAT version instead
|
|
8
8
|
(`…/v<their-version>/agent/…`). A catalog newer than the installed package describes props that do
|
|
9
9
|
not exist yet; older, and it hides props that do. Neither failure announces itself.
|
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
"DO use SheetTrigger asChild to wrap a Button or other interactive element — this avoids a nested <button> in the DOM. Never render a raw <button> as a direct child of SheetTrigger.",
|
|
76
76
|
"DO wrap a long/scrolling body in SheetBody (between SheetHeader and a pinned SheetFooter). It is the ring-safe scroll slot: a hand-rolled <div className='overflow-y-auto'> clips the 3px focus ring of a full-width Input/Select at the scroll edges — SheetBody insets the content so the ring never clips.",
|
|
77
77
|
"DO use SheetFooter (renders at the bottom via mt-auto, symmetric 16/24 padding, full-bleed top border) for primary/cancel action Buttons. Never float action Buttons inside the body — they will not stick to the panel bottom.",
|
|
78
|
+
"DO put one <form> around SheetBody + SheetFooter when the footer holds the submit button (`<Form asChild errors={…}><form onSubmit={…}><SheetBody>…</SheetBody><SheetFooter><Button type=\"submit\">…</Button></SheetFooter></form></Form>`). Since 32.0.3 a direct <form> child takes over SheetContent's column, so the body still scrolls and the footer stays pinned (gh#1239); never className=\"contents\" on the form.",
|
|
78
79
|
"DON'T set showCloseButton={false} on SheetContent unless you provide your own SheetClose element; omitting both leaves users with no keyboard-accessible close path and breaks a11y.",
|
|
79
80
|
"DO set `modal={false}` on Sheet when the user must keep working on the page behind the open panel (edit a list while a detail panel stays open). Control `open` yourself: an outside press no longer closes it, so keep the ✕ or a footer close action. Escape closes it only while focus is inside the panel.",
|
|
80
81
|
"DON'T put a Sheet inside a Dialog (nested modal overlays conflict). If you need a slide-over triggered from within a modal, close the Dialog first, then open the Sheet."
|
package/agent/components.json
CHANGED
|
@@ -7790,6 +7790,7 @@
|
|
|
7790
7790
|
"DO use SheetTrigger asChild to wrap a Button or other interactive element — this avoids a nested <button> in the DOM. Never render a raw <button> as a direct child of SheetTrigger.",
|
|
7791
7791
|
"DO wrap a long/scrolling body in SheetBody (between SheetHeader and a pinned SheetFooter). It is the ring-safe scroll slot: a hand-rolled <div className='overflow-y-auto'> clips the 3px focus ring of a full-width Input/Select at the scroll edges — SheetBody insets the content so the ring never clips.",
|
|
7792
7792
|
"DO use SheetFooter (renders at the bottom via mt-auto, symmetric 16/24 padding, full-bleed top border) for primary/cancel action Buttons. Never float action Buttons inside the body — they will not stick to the panel bottom.",
|
|
7793
|
+
"DO put one <form> around SheetBody + SheetFooter when the footer holds the submit button (`<Form asChild errors={…}><form onSubmit={…}><SheetBody>…</SheetBody><SheetFooter><Button type=\"submit\">…</Button></SheetFooter></form></Form>`). Since 32.0.3 a direct <form> child takes over SheetContent's column, so the body still scrolls and the footer stays pinned (gh#1239); never className=\"contents\" on the form.",
|
|
7793
7794
|
"DON'T set showCloseButton={false} on SheetContent unless you provide your own SheetClose element; omitting both leaves users with no keyboard-accessible close path and breaks a11y.",
|
|
7794
7795
|
"DO set `modal={false}` on Sheet when the user must keep working on the page behind the open panel (edit a list while a detail panel stays open). Control `open` yourself: an outside press no longer closes it, so keep the ✕ or a footer close action. Escape closes it only while focus is inside the panel.",
|
|
7795
7796
|
"DON'T put a Sheet inside a Dialog (nested modal overlays conflict). If you need a slide-over triggered from within a modal, close the Dialog first, then open the Sheet."
|
package/agent/index.json
CHANGED
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"note": "Pin to the tag that matches the @godxjp/ui version you installed. A catalog newer than your package describes props you do not have; older, and it hides props you do.",
|
|
49
49
|
"read": {
|
|
50
50
|
"live": "https://raw.githubusercontent.com/godx-jp/godxjp-ui/main/agent/index.json",
|
|
51
|
-
"pinned": "https://raw.githubusercontent.com/godx-jp/godxjp-ui/v32.0.
|
|
51
|
+
"pinned": "https://raw.githubusercontent.com/godx-jp/godxjp-ui/v32.0.3/agent/index.json"
|
|
52
52
|
},
|
|
53
53
|
"source": "mcp/src/data — the same data @godxjp/ui-mcp serves — plus the foundation and semantic token tiers, read from src/tokens/*.css",
|
|
54
54
|
"start": "https://raw.githubusercontent.com/godx-jp/godxjp-ui/main/agent/START-HERE.md",
|
|
@@ -62,5 +62,5 @@
|
|
|
62
62
|
"foundation": "the seeds a consumer is invited to set — --primary, --background, --radius",
|
|
63
63
|
"semantic": "named roles that follow the seeds — --ring, --text-link, --overlay-background"
|
|
64
64
|
},
|
|
65
|
-
"version": "32.0.
|
|
65
|
+
"version": "32.0.3"
|
|
66
66
|
}
|
package/agent/llms.txt
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# @godxjp/ui
|
|
2
2
|
|
|
3
3
|
> A Japanese-enterprise React design system: 161 components, 2183 design tokens,
|
|
4
|
-
> 43 cardinal rules. This file is the entry point for AI agents. Catalog version 32.0.
|
|
4
|
+
> 43 cardinal rules. This file is the entry point for AI agents. Catalog version 32.0.3.
|
|
5
5
|
|
|
6
6
|
If your client can run a process, do not read these files — run the MCP server instead
|
|
7
|
-
(`npx @godxjp/ui-mcp@32.0.
|
|
7
|
+
(`npx @godxjp/ui-mcp@32.0.3`). It is searchable and version-locked. These files exist for agents
|
|
8
8
|
that can only fetch URLs.
|
|
9
9
|
|
|
10
10
|
## Start
|
|
@@ -26,7 +26,7 @@ that can only fetch URLs.
|
|
|
26
26
|
## Pinning
|
|
27
27
|
|
|
28
28
|
Every URL above tracks `main`. To pin to the release a project actually installed, swap `main` for
|
|
29
|
-
the tag: `.../godx-jp/godxjp-ui/v32.0.
|
|
29
|
+
the tag: `.../godx-jp/godxjp-ui/v32.0.3/agent/...`. A catalog that does not match the installed
|
|
30
30
|
package describes props that are absent, or hides props that are present, and says nothing either way.
|
|
31
31
|
|
|
32
32
|
Pinned catalogs only exist for releases whose tag actually contains `agent/`. If `…/v<version>/agent/index.json` returns 404, that release predates this catalog: read `…/main/…` instead and compare `index.json` → `version` against the package you have, so you at least know which way it drifted.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$comment": "AUTO-GENERATED by scripts/gen-measurement-contract.mjs — do not edit. Read this instead of guessing: docs/MEASUREMENT-CONTRACT.md.",
|
|
3
|
-
"version": "32.0.
|
|
3
|
+
"version": "32.0.3",
|
|
4
4
|
"targetSize": {
|
|
5
5
|
"standard": "WCAG 2.2 SC 2.5.8 Target Size (Minimum), level AA — 24×24 CSS px",
|
|
6
6
|
"min": 24,
|
package/dist/email/index.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ export { EMAIL_URGENCY, EMAIL_URGENCY_DARK, type EmailUrgencyTokens } from "./ur
|
|
|
13
13
|
export { EMAIL_COLOR_SOURCE, EMAIL_COLOR_SOURCE_DARK, EMAIL_COLOR_SOURCE_GODX, EMAIL_COLOR_SOURCE_GODX_DARK, EMAIL_GEOMETRY_SOURCE, type EmailColorSource, } from "./tokens.generated.js";
|
|
14
14
|
import { EMAIL_COLORS, EMAIL_COLORS_DARK } from "./color.js";
|
|
15
15
|
import { EMAIL_SHELL, EMAIL_TYPOGRAPHY, EMAIL_CTA, EMAIL_FOOTER, EMAIL_FOCUS, EMAIL_MOBILE } from "./geometry.js";
|
|
16
|
-
import { EMAIL_BRAND_MARK } from "./brand-mark.js";
|
|
16
|
+
import { EMAIL_BRAND_MARK, type EmailBrandMark } from "./brand-mark.js";
|
|
17
17
|
import { EMAIL_URGENCY, EMAIL_URGENCY_DARK } from "./urgency.js";
|
|
18
18
|
/** The whole contract in one object — the shape `EMAIL_TOKENS_JSON` serialises. */
|
|
19
19
|
export interface EmailTokens {
|
|
@@ -36,12 +36,19 @@ export declare const EMAIL_TOKENS: EmailTokens;
|
|
|
36
36
|
* cannot import ES modules (Blade, Twig, Liquid, Handlebars on another runtime). Write it to a
|
|
37
37
|
* file in the build step and read it from the template layer.
|
|
38
38
|
*/
|
|
39
|
+
export declare const EMAIL_TOKENS_JSON: string;
|
|
40
|
+
/** The GoDX mark's accessible name, the email counterpart of `godxPreset.emailBrandLabel`. */
|
|
41
|
+
export declare const EMAIL_BRAND_LABEL_GODX = "GoDX";
|
|
42
|
+
/**
|
|
43
|
+
* The prebuilt GoDX mark (gh#1228): same geometry as {@link EMAIL_BRAND_MARK}, the GoDX colours and
|
|
44
|
+
* the "GoDX" accessible name — byte-identical to the mark 31.31.8 shipped as the default.
|
|
45
|
+
*/
|
|
46
|
+
export declare const EMAIL_BRAND_MARK_GODX: EmailBrandMark;
|
|
39
47
|
/**
|
|
40
48
|
* The GoDX preset for email (v32.0.1, gh#1228): the email counterpart of `godxPreset` +
|
|
41
|
-
* `themes/godx.css`. Same geometry; colours from {@link EMAIL_COLORS_GODX}
|
|
42
|
-
*
|
|
49
|
+
* `themes/godx.css`. Same geometry; colours from {@link EMAIL_COLORS_GODX}, mark from
|
|
50
|
+
* {@link EMAIL_BRAND_MARK_GODX}.
|
|
43
51
|
*/
|
|
44
52
|
export declare const EMAIL_TOKENS_GODX: EmailTokens;
|
|
45
|
-
/**
|
|
46
|
-
export declare const
|
|
47
|
-
export declare const EMAIL_TOKENS_JSON: string;
|
|
53
|
+
/** {@link EMAIL_TOKENS_GODX} as pretty-printed JSON, like {@link EMAIL_TOKENS_JSON}. */
|
|
54
|
+
export declare const EMAIL_TOKENS_GODX_JSON: string;
|
package/dist/email/index.js
CHANGED
|
@@ -46,7 +46,12 @@ import {
|
|
|
46
46
|
EMAIL_FOCUS as EMAIL_FOCUS2,
|
|
47
47
|
EMAIL_MOBILE as EMAIL_MOBILE2
|
|
48
48
|
} from "./geometry.js";
|
|
49
|
-
import {
|
|
49
|
+
import {
|
|
50
|
+
EMAIL_BRAND_MARK as EMAIL_BRAND_MARK2,
|
|
51
|
+
emailBrandMarkDataUri as emailBrandMarkDataUri2,
|
|
52
|
+
emailBrandMarkSvg as emailBrandMarkSvg2,
|
|
53
|
+
emailBrandMarkTableHtml as emailBrandMarkTableHtml2
|
|
54
|
+
} from "./brand-mark.js";
|
|
50
55
|
import { EMAIL_URGENCY as EMAIL_URGENCY2, EMAIL_URGENCY_DARK as EMAIL_URGENCY_DARK2 } from "./urgency.js";
|
|
51
56
|
const EMAIL_TOKENS = Object.freeze({
|
|
52
57
|
colors: EMAIL_COLORS2,
|
|
@@ -61,18 +66,32 @@ const EMAIL_TOKENS = Object.freeze({
|
|
|
61
66
|
mobile: EMAIL_MOBILE2,
|
|
62
67
|
brandMark: EMAIL_BRAND_MARK2
|
|
63
68
|
});
|
|
69
|
+
const EMAIL_TOKENS_JSON = JSON.stringify(EMAIL_TOKENS, null, 2);
|
|
70
|
+
const EMAIL_BRAND_LABEL_GODX = "GoDX";
|
|
71
|
+
const GODX_MARK = {
|
|
72
|
+
label: EMAIL_BRAND_LABEL_GODX,
|
|
73
|
+
color: EMAIL_COLORS_GODX2.brand,
|
|
74
|
+
glyphColor: EMAIL_COLORS_GODX2.brandForeground
|
|
75
|
+
};
|
|
76
|
+
const EMAIL_BRAND_MARK_GODX = Object.freeze({
|
|
77
|
+
...EMAIL_BRAND_MARK2,
|
|
78
|
+
svg: emailBrandMarkSvg2(GODX_MARK),
|
|
79
|
+
dataUri: emailBrandMarkDataUri2(GODX_MARK),
|
|
80
|
+
tableHtml: emailBrandMarkTableHtml2(GODX_MARK)
|
|
81
|
+
});
|
|
64
82
|
const EMAIL_TOKENS_GODX = Object.freeze({
|
|
65
83
|
...EMAIL_TOKENS,
|
|
66
84
|
colors: EMAIL_COLORS_GODX2,
|
|
67
|
-
colorsDark: EMAIL_COLORS_GODX_DARK2
|
|
85
|
+
colorsDark: EMAIL_COLORS_GODX_DARK2,
|
|
86
|
+
brandMark: EMAIL_BRAND_MARK_GODX
|
|
68
87
|
});
|
|
69
|
-
const
|
|
70
|
-
const EMAIL_TOKENS_JSON = JSON.stringify(EMAIL_TOKENS, null, 2);
|
|
88
|
+
const EMAIL_TOKENS_GODX_JSON = JSON.stringify(EMAIL_TOKENS_GODX, null, 2);
|
|
71
89
|
export {
|
|
72
90
|
EMAIL_BRAND_LABEL_GODX,
|
|
73
91
|
EMAIL_BRAND_MARK,
|
|
74
92
|
EMAIL_BRAND_MARK_CAPSULE,
|
|
75
93
|
EMAIL_BRAND_MARK_GLYPH,
|
|
94
|
+
EMAIL_BRAND_MARK_GODX,
|
|
76
95
|
EMAIL_BRAND_MARK_VIEWBOX,
|
|
77
96
|
EMAIL_COLORS,
|
|
78
97
|
EMAIL_COLORS_DARK,
|
|
@@ -90,6 +109,7 @@ export {
|
|
|
90
109
|
EMAIL_SHELL,
|
|
91
110
|
EMAIL_TOKENS,
|
|
92
111
|
EMAIL_TOKENS_GODX,
|
|
112
|
+
EMAIL_TOKENS_GODX_JSON,
|
|
93
113
|
EMAIL_TOKENS_JSON,
|
|
94
114
|
EMAIL_TYPOGRAPHY,
|
|
95
115
|
EMAIL_URGENCY,
|
|
@@ -15,6 +15,14 @@
|
|
|
15
15
|
border-top: var(--stroke-hairline) solid hsl(var(--border));
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
+
[data-slot="sheet-content"] > form {
|
|
19
|
+
display: flex;
|
|
20
|
+
flex-direction: column;
|
|
21
|
+
flex: 1 1 auto;
|
|
22
|
+
min-height: 0;
|
|
23
|
+
gap: inherit;
|
|
24
|
+
}
|
|
25
|
+
|
|
18
26
|
.ui-dialog-overlay {
|
|
19
27
|
background-color: var(
|
|
20
28
|
--dialog-overlay-background,
|
package/dist/styles/layers.json
CHANGED