@krizaka/ui 3.78.1 → 3.80.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/README.md +1 -0
- package/dist/app-frame.d.ts +4 -1
- package/dist/chunk-BCD2CRFG.js +349 -0
- package/dist/chunk-BCD2CRFG.js.map +1 -0
- package/dist/{chunk-PGPNYYE2.js → chunk-BHAWCN4I.js} +128 -110
- package/dist/chunk-BHAWCN4I.js.map +1 -0
- package/dist/{chunk-SG3QJJXE.js → chunk-ENFXJUDN.js} +3 -16
- package/dist/chunk-ENFXJUDN.js.map +1 -0
- package/dist/identity-card.d.ts +39 -0
- package/dist/identity-card.js +34 -0
- package/dist/identity-card.js.map +1 -0
- package/dist/index.d.ts +47 -15
- package/dist/index.js +87 -23
- package/dist/index.js.map +1 -1
- package/dist/native.d.ts +4 -1
- package/dist/nav-bar.d.ts +1 -1
- package/dist/nav-bar.js +63 -53
- package/dist/nav-bar.js.map +1 -1
- package/dist/qr-code.d.ts +25 -2
- package/dist/qr-code.js +29 -339
- package/dist/qr-code.js.map +1 -1
- package/dist/rail-nav.d.ts +4 -1
- package/dist/{schema-CL7t7xqb.d.ts → schema-DgjBz7-8.d.ts} +1 -1
- package/dist/shop.d.ts +2 -2
- package/dist/site-cahier.d.ts +32 -19
- package/dist/site-cahier.js +164 -138
- package/dist/site-cahier.js.map +1 -1
- package/dist/site-footer.d.ts +59 -39
- package/dist/site-footer.js +94 -68
- package/dist/site-footer.js.map +1 -1
- package/dist/{sites-CVNSirrg.d.ts → sites-BLqbwmng.d.ts} +14 -0
- package/dist/sites.d.ts +28 -2
- package/dist/sites.js +10 -0
- package/dist/sites.js.map +1 -1
- package/package.json +17 -3
- package/registry/account-menu.json +1 -1
- package/registry/account-settings.json +1 -1
- package/registry/achievement.json +1 -1
- package/registry/action-bar.json +1 -1
- package/registry/activity-feed.json +1 -1
- package/registry/agenda.json +1 -1
- package/registry/alert.json +1 -1
- package/registry/analysis-report.json +1 -1
- package/registry/anatomy-plate.json +1 -1
- package/registry/app-frame.json +8 -4
- package/registry/app-header.json +1 -1
- package/registry/app-shell.json +1 -1
- package/registry/argument-card.json +1 -1
- package/registry/auth-layout.json +1 -1
- package/registry/avatar.json +1 -1
- package/registry/badge.json +1 -1
- package/registry/bird-plate.json +1 -1
- package/registry/button.json +1 -1
- package/registry/captcha.json +1 -1
- package/registry/card-grid.json +1 -1
- package/registry/card.json +1 -1
- package/registry/catalogue-page.json +1 -1
- package/registry/changelog-page.json +1 -1
- package/registry/chapter.json +1 -1
- package/registry/chat.json +1 -1
- package/registry/checkbox.json +1 -1
- package/registry/chip-link.json +1 -1
- package/registry/chip-row.json +1 -1
- package/registry/chip.json +1 -1
- package/registry/choice-grid.json +1 -1
- package/registry/code-block.json +1 -1
- package/registry/collection-switcher.json +1 -1
- package/registry/combobox.json +1 -1
- package/registry/command.json +1 -1
- package/registry/comparison-table.json +1 -1
- package/registry/component-page.json +1 -1
- package/registry/confirm-button.json +1 -1
- package/registry/contact-page.json +1 -1
- package/registry/continue-prompt.json +1 -1
- package/registry/copy-button.json +1 -1
- package/registry/countdown.json +1 -1
- package/registry/cover-hero.json +1 -1
- package/registry/cta-panel.json +1 -1
- package/registry/dashboard-layout.json +1 -1
- package/registry/data-table.json +1 -1
- package/registry/date-picker.json +1 -1
- package/registry/decision-list.json +1 -1
- package/registry/description-list.json +1 -1
- package/registry/desktop-window.json +1 -1
- package/registry/detail-layout.json +1 -1
- package/registry/dialog.json +1 -1
- package/registry/docs-article-page.json +1 -1
- package/registry/docs-hub-page.json +1 -1
- package/registry/docs-layout.json +1 -1
- package/registry/docs-nav.json +1 -1
- package/registry/document-viewer.json +1 -1
- package/registry/doodle.json +1 -1
- package/registry/drop-overlay.json +1 -1
- package/registry/dropdown-menu.json +1 -1
- package/registry/elephant.json +1 -1
- package/registry/embed-facade.json +1 -1
- package/registry/empty-state.json +1 -1
- package/registry/engine-flow.json +1 -1
- package/registry/entity-header.json +1 -1
- package/registry/environment-notice.json +1 -1
- package/registry/error-page.json +1 -1
- package/registry/examples/identity-card/basic.d.ts +4 -0
- package/registry/examples/identity-card/basic.js +33 -0
- package/registry/examples/identity-card/basic.tsx +29 -0
- package/registry/examples/site-footer/company.js +1 -0
- package/registry/examples/site-footer/company.tsx +3 -2
- package/registry/examples/site-footer/docs.tsx +1 -1
- package/registry/examples/site-footer/open-source-fr.js +1 -1
- package/registry/examples/site-footer/open-source-fr.tsx +1 -1
- package/registry/examples/site-footer/product.js +9 -14
- package/registry/examples/site-footer/product.tsx +14 -12
- package/registry/field.json +1 -1
- package/registry/file-upload.json +1 -1
- package/registry/filter-bar.json +1 -1
- package/registry/flock.json +1 -1
- package/registry/footnote.json +1 -1
- package/registry/force-update-screen.json +1 -1
- package/registry/form.json +1 -1
- package/registry/gallery-page.json +1 -1
- package/registry/genui.json +1 -1
- package/registry/glossary-term.json +1 -1
- package/registry/glossary.json +1 -1
- package/registry/glow-card.json +1 -1
- package/registry/goal-gauge.json +1 -1
- package/registry/grade-stamp.json +1 -1
- package/registry/identity-card.json +218 -0
- package/registry/image-cropper.json +1 -1
- package/registry/index.json +40 -9
- package/registry/kanban.json +1 -1
- package/registry/kbd.json +1 -1
- package/registry/kind-config-editor.json +1 -1
- package/registry/kpi-explained.json +1 -1
- package/registry/landing-page.json +1 -1
- package/registry/landscape.json +1 -1
- package/registry/language-switch.json +1 -1
- package/registry/legal-page.json +1 -1
- package/registry/link-card.json +1 -1
- package/registry/list.json +1 -1
- package/registry/loader.json +1 -1
- package/registry/longform-page.json +1 -1
- package/registry/maintenance-screen.json +1 -1
- package/registry/map.json +2 -2
- package/registry/margin-layout.json +1 -1
- package/registry/markdown.json +1 -1
- package/registry/marketing-layout.json +1 -1
- package/registry/mascot-quote.json +1 -1
- package/registry/mascot-state.json +1 -1
- package/registry/mascots.json +1 -1
- package/registry/match-dialog.json +1 -1
- package/registry/media-capture.json +1 -1
- package/registry/media-gallery.json +1 -1
- package/registry/meter.json +1 -1
- package/registry/money-input.json +1 -1
- package/registry/nav-bar.json +8 -4
- package/registry/next-actions.json +1 -1
- package/registry/notification-preferences.json +1 -1
- package/registry/number-ticker.json +1 -1
- package/registry/opening-hours.json +1 -1
- package/registry/page-header.json +1 -1
- package/registry/page-hero.json +1 -1
- package/registry/page-index.json +1 -1
- package/registry/page.json +1 -1
- package/registry/pagination.json +1 -1
- package/registry/pointer-light.json +1 -1
- package/registry/popover.json +1 -1
- package/registry/price-catalogue-editor.json +1 -1
- package/registry/pricing-page.json +1 -1
- package/registry/product-page.json +1 -1
- package/registry/profile-card.json +1 -1
- package/registry/progress.json +1 -1
- package/registry/promise-card.json +1 -1
- package/registry/promo-code-field.json +1 -1
- package/registry/proposal.json +1 -1
- package/registry/qr-code.json +6 -2
- package/registry/quota-meter.json +1 -1
- package/registry/radio-group.json +1 -1
- package/registry/rail-nav.json +8 -4
- package/registry/recipes.json +1 -1
- package/registry/retro-tv.json +1 -1
- package/registry/reviews.json +1 -1
- package/registry/router.json +1 -1
- package/registry/schema-form.json +1 -1
- package/registry/scroll-stage.json +1 -1
- package/registry/search-field.json +1 -1
- package/registry/section-backdrop.json +1 -1
- package/registry/separator.json +1 -1
- package/registry/service-card.json +1 -1
- package/registry/settings-layout.json +1 -1
- package/registry/shop-composer.json +1 -1
- package/registry/shop-gallery.json +1 -1
- package/registry/shop.json +2 -2
- package/registry/showcase.json +1 -1
- package/registry/signature.json +1 -1
- package/registry/site-cahier.json +1 -1
- package/registry/site-footer.json +87 -60
- package/registry/sites.json +7 -3
- package/registry/skeleton.json +1 -1
- package/registry/skip-link.json +1 -1
- package/registry/slider.json +1 -1
- package/registry/slot-picker.json +1 -1
- package/registry/slot.json +1 -1
- package/registry/specimen-tag.json +1 -1
- package/registry/speed-lines.json +1 -1
- package/registry/spinner.json +1 -1
- package/registry/split-view.json +1 -1
- package/registry/stage-banner.json +1 -1
- package/registry/stat.json +1 -1
- package/registry/status-chip.json +1 -1
- package/registry/status-page.json +1 -1
- package/registry/step-progress.json +1 -1
- package/registry/step-showcase.json +1 -1
- package/registry/stepper.json +1 -1
- package/registry/sticky-action.json +1 -1
- package/registry/stuck.json +1 -1
- package/registry/swipe-deck.json +1 -1
- package/registry/switch.json +1 -1
- package/registry/tabs.json +1 -1
- package/registry/tag-input.json +1 -1
- package/registry/tag-selector.json +1 -1
- package/registry/taped-photo.json +1 -1
- package/registry/terminal-replay.json +1 -1
- package/registry/text-style.json +1 -1
- package/registry/theme.json +1 -1
- package/registry/toast.json +1 -1
- package/registry/toc.json +1 -1
- package/registry/tooltip.json +1 -1
- package/registry/tree-view.json +1 -1
- package/registry/update-prompt.json +1 -1
- package/registry/upload-queue.json +1 -1
- package/registry/usage.json +1 -1
- package/registry/verified-badge.json +1 -1
- package/registry/versus-card.json +1 -1
- package/registry/vertical-video.json +1 -1
- package/registry/video-player.json +1 -1
- package/registry/video-trimmer.json +1 -1
- package/registry/virtual.json +1 -1
- package/registry/wall.json +1 -1
- package/registry/waveform.json +1 -1
- package/dist/chunk-PGPNYYE2.js.map +0 -1
- package/dist/chunk-SG3QJJXE.js.map +0 -1
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
"name": "site-footer",
|
|
3
3
|
"type": "primitive",
|
|
4
4
|
"title": "Site footer",
|
|
5
|
-
"summary": "The footer of
|
|
6
|
-
"description": "The footer of
|
|
5
|
+
"summary": "The footer of every Krizaka site and app, compact: at most three lines on a desktop. The site's own links, the family grouped inline (names from `org.family`; shown on krizaka.com, opt-in elsewhere), then the signature, version, legal links and the host's controls.",
|
|
6
|
+
"description": "The footer of every Krizaka site and app, compact: at most three lines on a desktop. The site's own links, the family grouped inline (names from `org.family`; shown on krizaka.com, opt-in elsewhere), then the signature, version, legal links and the host's controls.",
|
|
7
7
|
"status": "beta",
|
|
8
8
|
"deprecated": null,
|
|
9
9
|
"category": "navigation",
|
|
@@ -24,10 +24,9 @@
|
|
|
24
24
|
}
|
|
25
25
|
},
|
|
26
26
|
"whenToUse": [
|
|
27
|
-
"The bottom of every page of
|
|
28
|
-
"
|
|
29
|
-
"`variant=\"app\"` — inside a signed-in product:
|
|
30
|
-
"`variant=\"docs\"` — under documentation pages: the site's columns in a row on the documentation's width, no family.",
|
|
27
|
+
"The bottom of every page of every Krizaka site — www, blog, ui., java., ts., lab. (`tone=\"cahier\"`) and the products' sites (`tone=\"product\"`): pass `org` from `@krizaka/org`, so every name, address, signature and legal link is the org's.",
|
|
28
|
+
"`variant=\"docs\"` — under documentation pages: the same three lines on the documentation's width.",
|
|
29
|
+
"`variant=\"app\"` — inside a signed-in product or an admin console: the last line only (signature, version, legal), rendered once by the layout.",
|
|
31
30
|
"With `MarketingLayout`'s `footer` slot, under a bar of `@krizaka/ui/nav-bar` with `NavBar.Family`."
|
|
32
31
|
],
|
|
33
32
|
"whenNotToUse": [
|
|
@@ -41,16 +40,16 @@
|
|
|
41
40
|
}
|
|
42
41
|
],
|
|
43
42
|
"bestPractices": [
|
|
44
|
-
"
|
|
45
|
-
"One or two own
|
|
46
|
-
"Pass the version the site runs (`version`,
|
|
47
|
-
"Pass the organisation's facts as `org` (`org` of `@krizaka/org`): the signature line is then « Une entreprise de Technologies Krizaka · Fait à Montréal » on every site and, without `legal`, the legal links are the org's — never write these lines by hand.",
|
|
43
|
+
"Pass `org` (`org` of `@krizaka/org`): the family's names come from `org.family` — the company « Krizaka », products by their own name, libraries « Krizaka <X> » — and the signature is `org.footer.line`. Never type a family name or the legal line in a site.",
|
|
44
|
+
"One or two own groups (`SiteFooter.Column` + `SiteFooter.Link`), a handful of links: what a reader looks for at the bottom (docs, pricing, download, source). Never a link the family line already holds — another site, the story, the blog, contact.",
|
|
45
|
+
"Pass the version the site runs (`version`, `env=\"DEV\"` on a dev environment) and the language switch and theme toggle in `controls`.",
|
|
48
46
|
"Pass the words translated: `labels={familyLabels[locale]}` from `@krizaka/ui/sites`."
|
|
49
47
|
],
|
|
50
48
|
"accessibility": {
|
|
51
49
|
"keyboard": [],
|
|
52
50
|
"notes": [
|
|
53
|
-
"A `footer` landmark; the family is a `nav` named by `labels.family`, each
|
|
51
|
+
"A `footer` landmark; the family is a `nav` named by `labels.family`, each group a list named by its heading.",
|
|
52
|
+
"On a phone each family group is a native `<details>` (keyboard and screen readers for free, 44 px targets); on a desktop it stays open as one line.",
|
|
54
53
|
"The current site says `aria-current=\"true\"` and “You are here” to screen readers; a status is written, never only a colour.",
|
|
55
54
|
"The marks are decorative: every site's name is written beside its mark."
|
|
56
55
|
]
|
|
@@ -66,20 +65,27 @@
|
|
|
66
65
|
"props": [
|
|
67
66
|
{
|
|
68
67
|
"component": "SiteFooter",
|
|
69
|
-
"description": "The footer of a Krizaka site
|
|
68
|
+
"description": "The footer of a Krizaka site or app: at most three lines — its links, the family, then signature · version · legal.",
|
|
70
69
|
"props": [
|
|
71
70
|
{
|
|
72
71
|
"name": "current",
|
|
73
72
|
"type": "SiteId",
|
|
74
73
|
"default": null,
|
|
75
|
-
"description": "The site this footer belongs to (`@krizaka/ui/sites`):
|
|
74
|
+
"description": "The site this footer belongs to (`@krizaka/ui/sites`): marked in the family, its address for `path`.",
|
|
76
75
|
"required": true
|
|
77
76
|
},
|
|
78
77
|
{
|
|
79
78
|
"name": "children",
|
|
80
79
|
"type": "ReactNode",
|
|
81
80
|
"default": null,
|
|
82
|
-
"description": "The site's own
|
|
81
|
+
"description": "The site's own link groups (`SiteFooter.Column`), on the first line.",
|
|
82
|
+
"required": false
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "controls",
|
|
86
|
+
"type": "ReactNode",
|
|
87
|
+
"default": null,
|
|
88
|
+
"description": "The host's controls at the end of the last line: the language switch, the theme toggle.",
|
|
83
89
|
"required": false
|
|
84
90
|
},
|
|
85
91
|
{
|
|
@@ -92,8 +98,8 @@
|
|
|
92
98
|
{
|
|
93
99
|
"name": "family",
|
|
94
100
|
"type": "boolean",
|
|
95
|
-
"default": "current === \"krizaka\"",
|
|
96
|
-
"description": "Shows the family
|
|
101
|
+
"default": "current === \"krizaka\" (and never in `variant=\"app\"`)",
|
|
102
|
+
"description": "Shows the family on the second line, folded on a phone. The links to the other sites live on krizaka.com only\n(founder rule, 2026-10-30): every other site and its documentation opts in on purpose, none by default.",
|
|
97
103
|
"required": false
|
|
98
104
|
},
|
|
99
105
|
{
|
|
@@ -107,35 +113,42 @@
|
|
|
107
113
|
"name": "legal",
|
|
108
114
|
"type": "ReactNode",
|
|
109
115
|
"default": null,
|
|
110
|
-
"description": "The
|
|
116
|
+
"description": "The legal links, when not the org's (`SiteFooter.Link`s).",
|
|
111
117
|
"required": false
|
|
112
118
|
},
|
|
113
119
|
{
|
|
114
120
|
"name": "org",
|
|
115
121
|
"type": "OrgFacts",
|
|
116
122
|
"default": null,
|
|
117
|
-
"description": "The organisation's public facts (`org` of `@krizaka/org`). The
|
|
123
|
+
"description": "The organisation's public facts (`org` of `@krizaka/org`) — pass them on every site. The names and addresses of the\nfamily are then `org.family`, the signature is `org.footer.line` (« Une entreprise de Technologies Krizaka · Fait à\nMontréal », the same everywhere) and, without `legal`, the legal links are `org.footer.legal`.",
|
|
118
124
|
"required": false
|
|
119
125
|
},
|
|
120
126
|
{
|
|
121
127
|
"name": "path",
|
|
122
128
|
"type": "string",
|
|
123
129
|
"default": null,
|
|
124
|
-
"description": "The path of the page being read on this site (`/en/story`, `/blog/…`): the company link that points to this very\npage says so (`aria-current=\"page\"
|
|
130
|
+
"description": "The path of the page being read on this site (`/en/story`, `/blog/…`): the company link that points to this very\npage says so (`aria-current=\"page\"`) and a click on it scrolls to the top instead of reloading.",
|
|
125
131
|
"required": false
|
|
126
132
|
},
|
|
127
133
|
{
|
|
128
134
|
"name": "products",
|
|
129
135
|
"type": "readonly SiteId[]",
|
|
130
136
|
"default": null,
|
|
131
|
-
"description": "
|
|
137
|
+
"description": "Only these products in the Products group (the current site always kept). Omit it to list every product.",
|
|
138
|
+
"required": false
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "tone",
|
|
142
|
+
"type": "Tone",
|
|
143
|
+
"default": "product",
|
|
144
|
+
"description": "`cahier` on the Cahier sites (www, blog, ui., java., ts., lab.), `product` in the products.",
|
|
132
145
|
"required": false
|
|
133
146
|
},
|
|
134
147
|
{
|
|
135
148
|
"name": "variant",
|
|
136
149
|
"type": "\"docs\" | \"app\" | \"site\"",
|
|
137
150
|
"default": "site",
|
|
138
|
-
"description": "`site` —
|
|
151
|
+
"description": "`site` — every public site. `docs` — the same under documentation, on its width. `app` — inside a signed-in product:\nthe last line only; render it once, in the layout.",
|
|
139
152
|
"required": false
|
|
140
153
|
},
|
|
141
154
|
{
|
|
@@ -149,13 +162,13 @@
|
|
|
149
162
|
},
|
|
150
163
|
{
|
|
151
164
|
"component": "SiteFooter.Column",
|
|
152
|
-
"description": "One of the site's own
|
|
165
|
+
"description": "One of the site's own link groups, inline on the first line: its heading, then its links.",
|
|
153
166
|
"props": [
|
|
154
167
|
{
|
|
155
168
|
"name": "title",
|
|
156
169
|
"type": "string",
|
|
157
170
|
"default": null,
|
|
158
|
-
"description": "The
|
|
171
|
+
"description": "The group's heading (“Docs”) — passed translated.",
|
|
159
172
|
"required": true
|
|
160
173
|
}
|
|
161
174
|
]
|
|
@@ -182,13 +195,13 @@
|
|
|
182
195
|
},
|
|
183
196
|
{
|
|
184
197
|
"component": "SiteFooterColumn",
|
|
185
|
-
"description": "One of the site's own
|
|
198
|
+
"description": "One of the site's own link groups, inline on the first line: its heading, then its links.",
|
|
186
199
|
"props": [
|
|
187
200
|
{
|
|
188
201
|
"name": "title",
|
|
189
202
|
"type": "string",
|
|
190
203
|
"default": null,
|
|
191
|
-
"description": "The
|
|
204
|
+
"description": "The group's heading (“Docs”) — passed translated.",
|
|
192
205
|
"required": true
|
|
193
206
|
}
|
|
194
207
|
]
|
|
@@ -218,23 +231,23 @@
|
|
|
218
231
|
{
|
|
219
232
|
"name": "product",
|
|
220
233
|
"title": "A product",
|
|
221
|
-
"description": "
|
|
234
|
+
"description": "www.yomizaka.com: its links on one line, the family on the second, then the org's line, `DEV · v1.2.3`, the legal links and the language switch.",
|
|
222
235
|
"path": "examples/site-footer/product.tsx",
|
|
223
236
|
"module": "@krizaka/ui/registry/examples/site-footer/product",
|
|
224
|
-
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// A product's footer (
|
|
237
|
+
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// A product's footer (www.yomizaka.com), three lines: its own links, the family grouped, then the signature, the version,\n// the legal links and the host's controls. In a real site pass `org` from `@krizaka/org`: the names, the signature line\n// and the legal links are then the org's, never typed here.\nexport default function SiteFooterProduct() {\n return (\n <SiteFooter\n current=\"yomizaka\"\n labels={familyLabels.en}\n env=\"DEV\"\n version=\"1.2.3\"\n legal={\n <>\n <SiteFooter.Link href=\"#privacy\">Privacy</SiteFooter.Link>\n <SiteFooter.Link href=\"#terms\">Terms</SiteFooter.Link>\n </>\n }\n controls={\n <SiteFooter.Link href=\"#fr\" lang=\"fr\">\n Français\n </SiteFooter.Link>\n }\n >\n <SiteFooter.Column title=\"Yomizaka\">\n <SiteFooter.Link href=\"#download\">Download</SiteFooter.Link>\n <SiteFooter.Link href=\"#docs\">Documentation</SiteFooter.Link>\n <SiteFooter.Link href=\"#pricing\">Pricing</SiteFooter.Link>\n <SiteFooter.Link href=\"https://github.com/krizaka/yomizaka\">Source code</SiteFooter.Link>\n </SiteFooter.Column>\n </SiteFooter>\n );\n}\n"
|
|
225
238
|
},
|
|
226
239
|
{
|
|
227
240
|
"name": "company",
|
|
228
|
-
"title": "The company",
|
|
229
|
-
"description": "www.krizaka.com
|
|
241
|
+
"title": "The company (Cahier)",
|
|
242
|
+
"description": "www.krizaka.com, `tone=\"cahier\"`: no own links needed, the family and the signature line.",
|
|
230
243
|
"path": "examples/site-footer/company.tsx",
|
|
231
244
|
"module": "@krizaka/ui/registry/examples/site-footer/company",
|
|
232
|
-
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// www.krizaka.com
|
|
245
|
+
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// www.krizaka.com, a Cahier site: the family line already holds the company's pages (story, blog, contact), so www adds\n// no link of its own; two lines — the family, then the signature and the legal links.\nexport default function SiteFooterCompany() {\n return (\n <SiteFooter\n current=\"krizaka\"\n tone=\"cahier\"\n labels={familyLabels.en}\n legal={\n <>\n <SiteFooter.Link href=\"#privacy\">Privacy</SiteFooter.Link>\n <SiteFooter.Link href=\"#terms\">Terms</SiteFooter.Link>\n </>\n }\n />\n );\n}\n"
|
|
233
246
|
},
|
|
234
247
|
{
|
|
235
248
|
"name": "app",
|
|
236
249
|
"title": "In a signed-in app",
|
|
237
|
-
"description": "`variant=\"app\"`: one slim line —
|
|
250
|
+
"description": "`variant=\"app\"`: one slim line — the org's line, `DEV · v1.2.3`, the legal links.",
|
|
238
251
|
"path": "examples/site-footer/app.tsx",
|
|
239
252
|
"module": "@krizaka/ui/registry/examples/site-footer/app",
|
|
240
253
|
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// The footer inside a signed-in product (dev.orazaka.com/dashboard): one slim line — the publisher line, the version it\n// runs and the legal links. Rendered once, in the layout; where the app shell has a sidebar that holds them, none.\nexport default function SiteFooterApp() {\n return (\n <SiteFooter\n variant=\"app\"\n current=\"orazaka\"\n labels={familyLabels.en}\n env=\"DEV\"\n version=\"1.2.3\"\n legal={\n <>\n <SiteFooter.Link href=\"#privacy\">Privacy</SiteFooter.Link>\n <SiteFooter.Link href=\"#terms\">Terms</SiteFooter.Link>\n </>\n }\n />\n );\n}\n"
|
|
@@ -242,27 +255,23 @@
|
|
|
242
255
|
{
|
|
243
256
|
"name": "docs",
|
|
244
257
|
"title": "Under documentation",
|
|
245
|
-
"description": "`variant=\"docs\"`: the
|
|
258
|
+
"description": "`variant=\"docs\"`: the same three lines on the documentation's width.",
|
|
246
259
|
"path": "examples/site-footer/docs.tsx",
|
|
247
260
|
"module": "@krizaka/ui/registry/examples/site-footer/docs",
|
|
248
|
-
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// The footer of a documentation page:
|
|
261
|
+
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// The footer of a documentation page: the same three lines as a site, on the documentation's width.\nexport default function SiteFooterDocs() {\n return (\n <SiteFooter\n variant=\"docs\"\n current=\"ui\"\n labels={familyLabels.en}\n version=\"1.2.3\"\n legal={<SiteFooter.Link href=\"#privacy\">Privacy</SiteFooter.Link>}\n >\n <SiteFooter.Column title=\"Guides\">\n <SiteFooter.Link href=\"#start\">Get started</SiteFooter.Link>\n <SiteFooter.Link href=\"#tokens\">Tokens</SiteFooter.Link>\n </SiteFooter.Column>\n <SiteFooter.Column title=\"Project\">\n <SiteFooter.Link href=\"#changelog\">Changelog</SiteFooter.Link>\n <SiteFooter.Link href=\"#source\">Source</SiteFooter.Link>\n </SiteFooter.Column>\n </SiteFooter>\n );\n}\n"
|
|
249
262
|
},
|
|
250
263
|
{
|
|
251
264
|
"name": "open-source-fr",
|
|
252
265
|
"title": "Open source, in French",
|
|
253
|
-
"description": "ui.krizaka.com in French
|
|
266
|
+
"description": "ui.krizaka.com in French, `tone=\"cahier\"`: « Une entreprise de Technologies Krizaka · Fait à Montréal », the version of the packages.",
|
|
254
267
|
"path": "examples/site-footer/open-source-fr.tsx",
|
|
255
268
|
"module": "@krizaka/ui/registry/examples/site-footer/open-source-fr",
|
|
256
|
-
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// ui.krizaka.com in French: « Un projet open source de Krizaka », the version of the packages, the words of the family\n// from `familyLabels.fr`.\nexport default function SiteFooterOpenSourceFr() {\n return (\n <SiteFooter current=\"ui\" labels={familyLabels.fr} version=\"3.9.0\">\n <SiteFooter.Column title=\"Documentation\">\n <SiteFooter.Link href=\"#start\">Démarrer</SiteFooter.Link>\n <SiteFooter.Link href=\"#foundations\">Fondations</SiteFooter.Link>\n <SiteFooter.Link href=\"#components\">Composants</SiteFooter.Link>\n <SiteFooter.Link href=\"#templates\">Modèles</SiteFooter.Link>\n </SiteFooter.Column>\n </SiteFooter>\n );\n}\n"
|
|
269
|
+
"code": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// ui.krizaka.com in French: « Un projet open source de Krizaka », the version of the packages, the words of the family\n// from `familyLabels.fr`.\nexport default function SiteFooterOpenSourceFr() {\n return (\n <SiteFooter current=\"ui\" tone=\"cahier\" labels={familyLabels.fr} version=\"3.9.0\">\n <SiteFooter.Column title=\"Documentation\">\n <SiteFooter.Link href=\"#start\">Démarrer</SiteFooter.Link>\n <SiteFooter.Link href=\"#foundations\">Fondations</SiteFooter.Link>\n <SiteFooter.Link href=\"#components\">Composants</SiteFooter.Link>\n <SiteFooter.Link href=\"#templates\">Modèles</SiteFooter.Link>\n </SiteFooter.Column>\n </SiteFooter>\n );\n}\n"
|
|
257
270
|
}
|
|
258
271
|
]
|
|
259
272
|
},
|
|
260
273
|
"native": null,
|
|
261
274
|
"files": [
|
|
262
|
-
{
|
|
263
|
-
"path": "family-mark.tsx",
|
|
264
|
-
"content": "// The mark of a site of the family (`@krizaka/ui/sites`): its brand's `ProductLogo`, still (a list of marks never\n// moves), or GitHub's, in the text colour. Shared by `NavBar.Family` and `SiteFooter` — not an entry of its own.\nimport type * as React from \"react\";\n\nimport { ProductLogo } from \"./marks/ProductLogo\";\nimport type { SiteMark } from \"./sites/sites\";\n\n/** GitHub's mark, in the text colour (both themes). */\nexport function GitHubGlyph({ size = 16, className }: { size?: number; className?: string }) {\n return (\n <svg viewBox=\"0 0 16 16\" width={size} height={size} fill=\"currentColor\" aria-hidden className={className}>\n <path d=\"M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8Z\" />\n </svg>\n );\n}\n\n/** A site's mark, decorative (its name is always written beside it). */\nexport function FamilyMark({ mark, size }: { mark: SiteMark; size: number }): React.ReactElement {\n if (mark === \"github\") return <GitHubGlyph size={Math.round(size * 0.8)} />;\n return <ProductLogo id={mark} size={size} animated={false} />;\n}\n"
|
|
265
|
-
},
|
|
266
275
|
{
|
|
267
276
|
"path": "marks/akinaza-geometry.ts",
|
|
268
277
|
"content": "import { marks } from \"@krizaka/tokens/native\";\n\n/**\n * The Akinaza mark's geometry — drawn by the web mark (AkinazaLogo) and the native one (AkinazaMark). The family's\n * grammar (packages/tokens/BRAND.md, \"Marks\"): 400×400 view box, dashed orbit and ring, a bold solid emblem, a lit core;\n * below 48 px the view box crops to the emblem.\n *\n * The emblem is **the cut log** (2026-10-17): a log seen end-on, its year rings in light, cut at 45° by the beaver —\n * the cut is the Krizaka chamfer, its fresh face in copper — and a copper heart that breathes: a shop built ring by\n * ring, year after year. Forest and copper stay **apart** (blended they turn brown): they are the two stops of the\n * brand's mark gradient (`marks.akinaza` of @krizaka/tokens), each ≥ 3:1 on the page surfaces of both themes.\n *\n * Literal geometry (no clip, so web and native draw the same thing): the log is a circle r 96 centred (194, 206) — set\n * off the centre so the cut log sits optically centred — minus the segment beyond the 45° chord at 70 from its centre;\n * the copper face is the band between that chord and a parallel one at 58, bounded by the circle.\n */\nconst forest = marks.akinaza[0]![1];\n/** The copper end: the cut, the heart, the halo and its breath. */\nconst copper = marks.akinaza[marks.akinaza.length - 1]![1];\n\nexport const AKINAZA = {\n viewBox: \"0 0 400 400\",\n croppedViewBox: \"80 80 240 240\",\n center: 200,\n forest,\n copper,\n log: \"M197 110 L290 203 A96 96 0 1 1 197 110 Z\",\n /** The fresh face of the cut: a copper band along the chord. */\n cut: \"M197 110 L290 203 A96 96 0 0 1 289.1 219.1 L180.9 110.9 A96 96 0 0 1 197 110 Z\",\n /** The year rings, in light, inside the band. */\n rings: { cx: 194, cy: 206, r: [52, 28], width: 7, opacity: 0.42 },\n heart: { cx: 194, cy: 206, r: 16, inner: 5.4 },\n highlight: \"#fff7ed\",\n gradient: { x1: 110, y1: 300, x2: 290, y2: 100, stops: marks.akinaza },\n /** A coin: one node on the orbit, that turns with it. */\n node: { r: 9, at: [200, 40] as const },\n glow: { color: copper, opacity: 0.16 },\n pulse: { color: copper, low: 0.3, high: 0.65 },\n motion: { spin: 32, breath: 3.8 },\n orbit: { r: 160, dash: \"8 8\", width: 1.5 },\n ring: { r: 134, width: 1 },\n} as const;\n"
|
|
@@ -271,13 +280,17 @@
|
|
|
271
280
|
"path": "marks/AkinazaLogo.tsx",
|
|
272
281
|
"content": "import { AKINAZA as G } from \"./akinaza-geometry\";\nimport { a11y, familyMotion, type MarkProps, neutral, useIds } from \"./shared\";\n\nconst CSS = familyMotion(\"akm\", { ...G.motion, ...G.pulse });\n\n/**\n * The Akinaza mark, \"the cut log\": a log seen end-on in forest green, its year rings in light, cut at 45° by the beaver\n * (the Krizaka chamfer) with the fresh face in copper, and a copper heart that breathes — a shop built ring by ring.\n * One node, a coin, rides the dashed orbit. Below 48 px it crops to the emblem.\n */\nexport function AkinazaLogo({ size = 32, animated = true, title, className }: MarkProps) {\n const id = useIds(\"akm\", [\"glow\"] as const);\n const m = (cls: string) => (animated ? `akm-${cls}` : undefined);\n return (\n <svg width={size} height={size} viewBox={size < 48 ? G.croppedViewBox : G.viewBox} fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\" className={className} {...a11y(title)}>\n <style>{CSS}</style>\n <defs>\n <radialGradient id={id.glow} cx=\"50%\" cy=\"50%\" r=\"50%\">\n <stop offset=\"0%\" stopColor={G.glow.color} stopOpacity={G.glow.opacity} />\n <stop offset=\"100%\" stopColor={G.glow.color} stopOpacity=\"0\" />\n </radialGradient>\n </defs>\n {size >= 48 ? <circle cx={G.center} cy={G.center} r=\"190\" fill={`url(#${id.glow})`} /> : null /* cropped: the halo would show its square */}\n <circle cx={G.center} cy={G.center} r={G.ring.r} stroke={neutral(\"--kz-border-default\", 30)} strokeWidth={G.ring.width} opacity=\".35\" />\n <g className={m(\"orbit\")}>\n <circle cx={G.center} cy={G.center} r={G.orbit.r} stroke={neutral(\"--kz-border-strong\", 40)} strokeWidth={G.orbit.width} strokeDasharray={G.orbit.dash} opacity=\".6\" />\n <circle cx={G.node.at[0]} cy={G.node.at[1]} r={G.node.r} fill={G.copper} />\n </g>\n <path d={G.log} fill={G.forest} />\n <path d={G.cut} fill={G.copper} />\n {G.rings.r.map((r) => (\n <circle key={r} cx={G.rings.cx} cy={G.rings.cy} r={r} stroke={G.highlight} strokeOpacity={G.rings.opacity} strokeWidth={G.rings.width} />\n ))}\n <g className={m(\"core\")}>\n <circle cx={G.heart.cx} cy={G.heart.cy} r={G.heart.r} fill={G.copper} />\n <circle cx={G.heart.cx} cy={G.heart.cy} r={G.heart.inner} fill={G.highlight} />\n </g>\n </svg>\n );\n}\n"
|
|
273
282
|
},
|
|
283
|
+
{
|
|
284
|
+
"path": "marks/InkMark.tsx",
|
|
285
|
+
"content": "import type { ReactNode } from \"react\";\n\nimport { KRIZAKA } from \"./krizaka-geometry\";\nimport { a11y, type MarkProps, neutral, useIds } from \"./shared\";\n\n/** What an ink mark draws on the family frame: the Krizaka geometry, its node and core moved where its figure opens. */\nexport interface InkGeometry {\n readonly viewBox: string;\n readonly croppedViewBox: string;\n readonly offset: number;\n readonly ink: typeof KRIZAKA.ink;\n readonly blue: typeof KRIZAKA.blue;\n readonly glow: typeof KRIZAKA.glow;\n readonly orbit: typeof KRIZAKA.orbit;\n readonly ring: typeof KRIZAKA.ring;\n readonly highlight: string;\n readonly node: { readonly cx: number; readonly cy: number; readonly r: number; readonly inner: number };\n readonly core: { readonly cx: number; readonly cy: number; readonly r: number; readonly inner: number };\n}\n\ninterface InkMarkProps extends MarkProps {\n /** The class prefix of `css` (`<prefix>-spin` turns the orbit, `<prefix>-pulse` makes the node and core breathe). */\n readonly prefix: string;\n readonly css: string;\n readonly geometry: InkGeometry;\n /** The figure, drawn with the ink gradient `url(#ink)` it is given. */\n readonly figure: (ink: string) => ReactNode;\n}\n\n/** The ink, blue and glow gradients of the marks in Krizaka's colours, under the instance's own ids. */\nexport function InkDefs({ ids: id, geometry: G }: Readonly<{ ids: Record<\"ink\" | \"blue\" | \"glow\", string>; geometry: Pick<InkGeometry, \"ink\" | \"blue\" | \"glow\"> }>) {\n return (\n <defs>\n <linearGradient id={id.ink} gradientUnits=\"userSpaceOnUse\" x1={G.ink.x1} y1={G.ink.y1} x2={G.ink.x2} y2={G.ink.y2}>\n <stop offset=\"0%\" stopColor={neutral(\"--kz-text-secondary\", 60)} />\n <stop offset=\"100%\" stopColor={neutral(\"--kz-text-primary\", 92)} />\n </linearGradient>\n <linearGradient id={id.blue} gradientUnits=\"userSpaceOnUse\" x1={G.blue.x1} y1={G.blue.y1} x2={G.blue.x2} y2={G.blue.y2}>\n {G.blue.stops.map(([offset, color]) => (\n <stop key={offset} offset={offset} stopColor={color} />\n ))}\n </linearGradient>\n <radialGradient id={id.glow} cx=\"50%\" cy=\"50%\" r=\"50%\">\n <stop offset=\"0%\" stopColor={G.glow.color} stopOpacity={G.glow.opacity} />\n <stop offset=\"100%\" stopColor={G.glow.color} stopOpacity=\"0\" />\n </radialGradient>\n </defs>\n );\n}\n\n/**\n * The frame of the marks in Krizaka's colours (the company and its services: Krizaka, Kridoc): halo, dashed orbit, ring,\n * an ink figure, the blue node where it opens and the blue core. Below 48 px it crops to the emblem.\n */\nexport function InkMark({ size = 32, animated = true, title, className, prefix, css, geometry: G, figure }: InkMarkProps) {\n const id = useIds(prefix, [\"ink\", \"blue\", \"glow\"] as const);\n const m = (cls: string) => (animated ? `${prefix}-${cls}` : undefined);\n const dots = [G.node, G.core];\n return (\n <svg width={size} height={size} viewBox={size < 48 ? G.croppedViewBox : G.viewBox} fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\" className={className} {...a11y(title)}>\n <style>{css}</style>\n <InkDefs ids={id} geometry={G} />\n {size >= 48 ? <circle cx=\"200\" cy=\"200\" r=\"190\" fill={`url(#${id.glow})`} /> : null /* cropped: the halo would show its square */}\n <circle className={m(\"spin\")} cx=\"200\" cy=\"200\" r={G.orbit.r} stroke={neutral(\"--kz-border-strong\", 40)} strokeWidth={G.orbit.width} strokeDasharray={G.orbit.dash} opacity=\".6\" />\n <circle cx=\"200\" cy=\"200\" r={G.ring.r} stroke={neutral(\"--kz-border-default\", 30)} strokeWidth={G.ring.width} opacity=\".35\" />\n <g transform={`translate(${G.offset} ${G.offset})`}>\n {figure(`url(#${id.ink})`)}\n {dots.map((d) => (\n <g key={`${d.cx},${d.cy}`} className={m(\"pulse\")}>\n <circle cx={d.cx} cy={d.cy} r={d.r} fill={`url(#${id.blue})`} />\n <circle cx={d.cx} cy={d.cy} r={d.inner} fill={G.highlight} />\n </g>\n ))}\n </g>\n </svg>\n );\n}\n"
|
|
286
|
+
},
|
|
274
287
|
{
|
|
275
288
|
"path": "marks/krizaka-geometry.ts",
|
|
276
289
|
"content": "import { marks } from \"@krizaka/tokens/native\";\n\n/**\n * The Krizaka mark's geometry — the one description drawn by the web mark (KrizakaLogo) and the native one\n * (KrizakaMark). Built on the family's mark grammar (docs: packages/tokens/BRAND.md, \"Marks\"): a 360×360 artwork at\n * (20, 20) in a 400×400 view box, one bold stroke (22) drawn as an open figure, an end that breaks out as a node, a\n * core, a dashed orbit and a ring; below 48 px the view box crops to the emblem.\n *\n * Krizaka is the parent: the hexagonal shield is **ink** (the host's text roles), the node and the core carry the\n * Krizaka blue (`marks.krizaka` of @krizaka/tokens: the brand's accent hsl(208 46% 45%) → its text tint hsl(206 58% 72%)).\n */\nexport const KRIZAKA = {\n viewBox: \"0 0 400 400\",\n croppedViewBox: \"86 82 228 228\",\n offset: 20,\n /** The shield: a pointy-top hexagon (r 92 around 180,180), open at its upper-right edge. */\n shield: \"M259.7,134 L259.7,226 L180,272 L100.3,226 L100.3,134 L180,88 L212,106.5\",\n stroke: 22,\n ink: { x1: 70, y1: 290, x2: 290, y2: 70 },\n blue: { x1: 180, y1: 180, x2: 300, y2: 60, stops: marks.krizaka },\n /** The vertex where the shield opens: a node (the head of the line). */\n node: { cx: 259.7, cy: 134, r: 19, inner: 6 },\n core: { cx: 180, cy: 180, r: 24, inner: 8 },\n highlight: \"#ddeaf4\",\n glow: { color: marks.krizaka[0]![1], opacity: 0.16 },\n orbit: { r: 160, dash: \"8 8\", width: 1.5 },\n ring: { r: 134, width: 1 },\n} as const;\n"
|
|
277
290
|
},
|
|
278
291
|
{
|
|
279
292
|
"path": "marks/KrizakaLogo.tsx",
|
|
280
|
-
"content": "import { KRIZAKA as G } from \"./krizaka-geometry\";\nimport {
|
|
293
|
+
"content": "import { InkMark } from \"./InkMark\";\nimport { KRIZAKA as G } from \"./krizaka-geometry\";\nimport type { MarkProps } from \"./shared\";\n\nconst CSS = `\n.kzm-spin { transform-origin: 200px 200px; animation: kzm-spin 30s linear infinite; }\n.kzm-pulse { transform-box: fill-box; transform-origin: center; animation: kzm-pulse 3.2s ease-in-out infinite; }\n@keyframes kzm-spin { to { transform: rotate(360deg); } }\n@keyframes kzm-pulse {\n 0%, 100% { filter: drop-shadow(0 0 6px hsla(217, 92%, 53%, .25)); opacity: .9; }\n 50% { filter: drop-shadow(0 0 14px hsla(217, 92%, 53%, .55)); opacity: 1; }\n}\n@media (prefers-reduced-motion: reduce) { .kzm-spin, .kzm-pulse { animation: none; } }\n`;\n\n/**\n * The Krizaka mark: an ink hexagonal shield, open at one vertex where a blue node breaks out, around a blue core —\n * the parent of the family (Orazaka's shards). The orbit turns, the node and the core\n * breathe. The shield reads the host's text roles, so it is ink in both themes. Below 48 px it crops to the emblem.\n */\nexport function KrizakaLogo(props: Readonly<MarkProps>) {\n return (\n <InkMark\n {...props}\n prefix=\"kzm\"\n css={CSS}\n geometry={G}\n figure={(ink) => <path d={G.shield} stroke={ink} strokeWidth={G.stroke} strokeLinecap=\"round\" strokeLinejoin=\"round\" />}\n />\n );\n}\n"
|
|
281
294
|
},
|
|
282
295
|
{
|
|
283
296
|
"path": "marks/orazaka-geometry.ts",
|
|
@@ -289,7 +302,7 @@
|
|
|
289
302
|
},
|
|
290
303
|
{
|
|
291
304
|
"path": "marks/ProductLogo.tsx",
|
|
292
|
-
"content": "import { AkinazaLogo } from \"./AkinazaLogo\";\nimport { KrizakaLogo } from \"./KrizakaLogo\";\nimport { OrazakaLogo } from \"./OrazakaLogo\";\nimport type { MarkProps } from \"./shared\";\nimport { YomizakaLogo } from \"./YomizakaLogo\";\n\n
|
|
305
|
+
"content": "import { AkinazaLogo } from \"./AkinazaLogo\";\nimport { KrizakaLogo } from \"./KrizakaLogo\";\nimport { OrazakaLogo } from \"./OrazakaLogo\";\nimport type { MarkProps } from \"./shared\";\nimport { YomizakaLogo } from \"./YomizakaLogo\";\n\n/**\n * A Krizaka brand by its code name: the company and its three products — sold as Verikora (`yomizaka`), Folioviv\n * (`akinaza`) and Sovkora (`orazaka`). It also keys the brand palettes (maps, forms, loaders).\n */\nexport type BrandId = \"krizaka\" | \"orazaka\" | \"yomizaka\" | \"akinaza\";\n\n/** A mark by its code name (the ids of `@krizaka/org`'s `brands`): a brand, or Kridoc — the managed storage (`kachizaka`), which has a mark and no palette of its own. */\nexport type MarkId = BrandId | \"kachizaka\";\n\n/** The mark of a Krizaka brand by id — for navigation, cards and lists driven by data. Kridoc is drawn by `ProductLockup` or `KridocLogo`: keeping it out of here keeps the bar light (krizaka-ui#837). */\nexport function ProductLogo({ id, ...props }: MarkProps & { /** The brand: `krizaka`, `orazaka`, `yomizaka` or `akinaza`. */ id: BrandId }) {\n if (id === \"krizaka\") return <KrizakaLogo {...props} />;\n if (id === \"orazaka\") return <OrazakaLogo {...props} />;\n if (id === \"yomizaka\") return <YomizakaLogo {...props} />;\n return <AkinazaLogo {...props} />;\n}\n"
|
|
293
306
|
},
|
|
294
307
|
{
|
|
295
308
|
"path": "marks/shared.ts",
|
|
@@ -305,7 +318,7 @@
|
|
|
305
318
|
},
|
|
306
319
|
{
|
|
307
320
|
"path": "meta.ts",
|
|
308
|
-
"content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which ui.krizaka.com (apps/site) renders as\n// ui.krizaka.com/components/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n | \"notification-preferences\"\n | \"quota-meter\"\n | \"environment-notice\"\n | \"embed-facade\"\n | \"reviews\"\n | \"margin-layout\"\n | \"analysis-report\"\n | \"status-chip\"\n | \"kind-config-editor\"\n | \"agenda\"\n | \"account-settings\"\n | \"drop-overlay\"\n | \"upload-queue\"\n | \"achievement\"\n | \"anatomy-plate\"\n | \"bird-plate\"\n | \"taped-photo\"\n | \"stuck\"\n | \"doodle\"\n | \"signature\"\n | \"grade-stamp\"\n | \"versus-card\"\n | \"speed-lines\"\n | \"site-cahier\"\n | \"text-style\"\n | \"flock\"\n | \"elephant\"\n | \"footnote\"\n | \"page-index\"\n | \"chapter\"\n | \"specimen-tag\"\n | \"action-bar\"\n | \"action-sheet\"\n | \"activity-feed\"\n | \"alert\"\n | \"app-frame\"\n | \"desktop-window\"\n | \"form-flow\"\n | \"grid\"\n | \"list-detail\"\n | \"state-screen\"\n | \"app-header\"\n | \"app-shell\"\n | \"argument-card\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"captcha\"\n | \"card\"\n | \"card-grid\"\n | \"catalogue-page\"\n | \"changelog-page\"\n | \"chat\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"chip-row\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"comparison-table\"\n | \"command\"\n | \"component-page\"\n | \"confirm-button\"\n | \"copy-button\"\n | \"money-input\"\n | \"price-catalogue-editor\"\n | \"promo-code-field\"\n | \"contact-page\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cover-hero\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"description-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-article-page\"\n | \"docs-hub-page\"\n | \"docs-layout\"\n | \"docs-nav\"\n | \"document-viewer\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"engine-flow\"\n | \"error-page\"\n | \"fab\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"force-update-screen\"\n | \"form\"\n | \"gallery-page\"\n | \"genui\"\n | \"glossary\"\n | \"glossary-term\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"header\"\n | \"image-cropper\"\n | \"image-viewer\"\n | \"kanban\"\n | \"kbd\"\n | \"kpi-explained\"\n | \"landing-page\"\n | \"landscape\"\n | \"legal-page\"\n | \"link-card\"\n | \"list\"\n | \"loader\"\n | \"longform-page\"\n | \"maintenance-screen\"\n | \"map\"\n | \"markdown\"\n | \"waveform\"\n | \"proposal\"\n | \"qr-code\"\n | \"entity-header\"\n | \"collection-switcher\"\n | \"marketing-layout\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"match-dialog\"\n | \"media-capture\"\n | \"language-switch\"\n | \"media-gallery\"\n | \"media-picker\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"onboarding\"\n | \"opening-hours\"\n | \"otp-input\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"permission-prompt\"\n | \"pointer-light\"\n | \"popover\"\n | \"pricing-page\"\n | \"product-page\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"pull-to-refresh\"\n | \"retro-tv\"\n | \"shop-gallery\"\n | \"radio-group\"\n | \"router\"\n | \"rail-nav\"\n | \"recipes\"\n | \"screen\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"service-card\"\n | \"shop\"\n | \"shop-composer\"\n | \"schema-form\"\n | \"settings-layout\"\n | \"account-menu\"\n | \"showcase\"\n | \"step-showcase\"\n | \"site-footer\"\n | \"sites\"\n | \"skeleton\"\n | \"skip-link\"\n | \"slider\"\n | \"slot-picker\"\n | \"slot\"\n | \"spinner\"\n | \"sticky-action\"\n | \"splash-handoff\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"usage\"\n | \"status-page\"\n | \"step-progress\"\n | \"stepper\"\n | \"swipe-deck\"\n | \"swipeable-row\"\n | \"switch\"\n | \"tab-bar\"\n | \"tabs\"\n | \"tag-input\"\n | \"tag-selector\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"tree-view\"\n | \"txt\"\n | \"update-prompt\"\n | \"verified-badge\"\n | \"vertical-video\"\n | \"video-player\"\n | \"video-trimmer\"\n | \"virtual\"\n | \"wall\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/**\n * Why a component is not on a platform — a decision, never a silence (the parity matrix of ui.krizaka.com/platforms):\n * - `gap` (✗): it belongs there and is not built yet; `issue` is the issue that tracks it (`krizaka/krizaka-ui#275`);\n * - `n/a`: it is not meant for that platform (a site's page block on a phone, a swipe on a desktop); `use` names the\n * component that answers there, when one does.\n */\nexport type Absence =\n | { readonly status: \"gap\"; readonly issue: string; readonly reason: string; readonly use?: undefined }\n | { readonly status: \"n/a\"; readonly reason: string; readonly use?: ComponentName; readonly issue?: undefined };\n\n/**\n * Desktop is the Orazaka Mac app (Tauri 2: the system WebView renders the web components — ADR-002). `web`: the web\n * component runs there as it is; `desktop`: it also has a desktop form (a window's title bar, a denser layout…), said in\n * its documentation; otherwise the absence and why.\n */\nexport type DesktopSupport = \"web\" | \"desktop\" | Absence;\n\n/**\n * The three platforms of Krizaka UI — web · native (React Native, Expo) · desktop — for one component. The side a\n * component has is `platforms`; the side it lacks says why here: `native` is required for (and only for) a web-only\n * component, `web` for a native-only one; `desktop` always. `scripts/registry.test.mjs` fails on a missing decision.\n */\nexport interface Parity {\n readonly web?: Absence;\n readonly native?: Absence;\n readonly desktop: DesktopSupport;\n}\n\n/**\n * `experimental`: created for a filed need (ADR-008 §4), it may change or go in any minor until its first consumer imports it; `adoption`\n * names that consumer's issue. `stable`: its API only changes in a major. `beta`: it may still change in a minor. `deprecated`: no product uses it and\n * no work plans to — it still works, says what replaces it, and goes in the major named by `deprecated.removedIn`.\n */\nexport type Status = \"experimental\" | \"stable\" | \"beta\" | \"deprecated\";\n\n/**\n * What a component is for (ADR-008 §3): the twelve domains the documentation, the size budgets and the guards are\n * organised by. The domain is metadata: the entries stay flat (`@krizaka/ui/<name>`). `cahier` is the sites' register\n * (ADR-004): a product never imports it.\n */\nexport type Domain =\n | \"foundations\"\n | \"forms\"\n | \"data-display\"\n | \"navigation-shell\"\n | \"feedback\"\n | \"maps\"\n | \"media\"\n | \"commerce\"\n | \"identity\"\n | \"conversation\"\n | \"page-blocks\"\n | \"cahier\";\n\n/** What a deprecated component says (required when `status` is `deprecated`, absent otherwise). */\nexport interface Deprecation {\n /** The version that deprecated it (`3.6.0`). */\n readonly since: string;\n /** The major that removes it (`4.0.0`). */\n readonly removedIn: string;\n /** What replaces it, when a component does. */\n readonly use?: ComponentName;\n /** Why it goes: no product uses it, no planned work needs it. */\n readonly reason: string;\n}\n\n/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its screens. `templates`: the page templates — whole pages of a\n * site (a landing, a product, a docs hub, a long read, a changelog, pricing, status, an error…), each a distinct\n * composition of the blocks, words and content as props.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"templates\" | \"layout\" | \"foundations\";\n\n/** Why a reader needs a template: the seven intents the templates are grouped by (sidebar sub-headings, catalogue filter). */\nexport type TemplatePurpose = \"convince\" | \"explain\" | \"show\" | \"act\" | \"operate\" | \"converse\" | \"recover\";\n\n/** The groups of templates, in reading order: the title, and the one line that says when to come to that group. */\nexport const templatePurposes = {\n convince: { title: \"Convince\", useWhen: \"You come here when a visitor must decide: a landing, a product, a price, a comparison, a proof.\" },\n explain: { title: \"Explain\", useWhen: \"You come here when a reader must understand: how it works, a documentation hub or article, a changelog, a FAQ, a policy.\" },\n show: { title: \"Show\", useWhen: \"You come here when the work itself is the argument: a gallery, a story, a case study, an object and its details.\" },\n act: { title: \"Act\", useWhen: \"You come here when a person must do something once: reach the team, sign in or up, set up, pay.\" },\n operate: { title: \"Operate\", useWhen: \"You come here when a person works every day: a dashboard, a console with a table, settings, an app shell.\" },\n converse: { title: \"Converse\", useWhen: \"You come here when people talk: an inbox, a chat, comments, a notifications centre.\" },\n recover: { title: \"Recover\", useWhen: \"You come here when the way is blocked: an empty list, an error, a missing page, maintenance, a product still being built.\" },\n} as const satisfies Record<TemplatePurpose, { readonly title: string; readonly useWhen: string }>;\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\ninterface ExampleBase {\n /** The file name, kebab-case (`primary`, `icon-button`). */\n readonly name: string;\n /** A short title (`Primary`, `Icon button`). */\n readonly title: string;\n /** One or two sentences: when this variant is the right one. */\n readonly description: string;\n}\n\n/** A plain example, or a template: a whole screen with its intent (`purpose`) and the user goal its layout serves (`why`). */\nexport type Example =\n | (ExampleBase & { readonly template?: false; readonly purpose?: undefined; readonly why?: undefined })\n | (ExampleBase & {\n /**\n * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its\n * phone version thought out), copied as a starting point — at most 160 lines, listed on ui.krizaka.com/templates.\n */\n readonly template: true;\n /** The intent that groups it: why you need this block. */\n readonly purpose: TemplatePurpose;\n /** Why this layout: the user goal it serves, in one sentence. */\n readonly why: string;\n });\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n readonly imports: readonly string[];\n /** The examples, in reading order; the first one is the component's preview. */\n readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n /**\n * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n */\n readonly entry?: string;\n /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n readonly differences: readonly string[];\n /** The React Native entry alone is deprecated while the web one stays (ADR-006 §7); a deprecated component says it once, above. */\n readonly deprecated?: Deprecation;\n}\n\nexport interface KeyboardInteraction {\n /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n readonly keys: string;\n /** What they do. */\n readonly action: string;\n}\n\nexport interface ComponentMeta {\n /** The display name: `Button`, `Dropdown menu`. */\n readonly title: string;\n /** One sentence: what it is. */\n readonly summary: string;\n readonly status: Status;\n /** Required for, and only for, a `deprecated` component. */\n readonly deprecated?: Deprecation;\n readonly category: Category;\n /** What it is for: one of the twelve domains (ADR-008 §3). */\n readonly domain: Domain;\n /** The `<repo>#<n>` issue of its first consumer: required for, and only for, an `experimental` component. */\n readonly adoption?: string;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\n /** The platforms it is not on, and why; and its desktop form (see `Parity`). */\n readonly parity: Parity;\n /** When to reach for it: concrete situations, one per item. */\n readonly whenToUse: readonly string[];\n /** When not to — and what to use instead (`use`), when another component is the answer. */\n readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n /** How to use it well: wording, placement, composition. */\n readonly bestPractices: readonly string[];\n readonly accessibility: {\n /** The keyboard, when it does more than Tab and Enter. */\n readonly keyboard: readonly KeyboardInteraction[];\n /** Roles, names and announcements: what the component does, what the app must provide. */\n readonly notes: readonly string[];\n };\n /** The components a reader of this page should know about. */\n readonly related: readonly ComponentName[];\n readonly web?: PlatformDocs;\n readonly native?: NativeDocs;\n}\n"
|
|
321
|
+
"content": "// The documentation of a component, carried by its code: each primitive has a `meta.ts` beside its source\n// (`src/<name>/meta.ts`; a component that exists only in React Native: `src/native/meta/<name>.ts`). Never built into\n// the package: `scripts/build-registry.mjs` reads them into `registry/<name>.json`, which ui.krizaka.com (apps/site) renders as\n// ui.krizaka.com/components/<name>, and `scripts/registry.test.mjs` fails when one is missing or incomplete.\n//\n// Why a typed module and not JSDoc tags: the fields are lists and links (`related`, `whenNotToUse[].use`, examples),\n// which a type checks and a comment does not; the file is plain data (erasable TypeScript), so Node reads it without a\n// compiler, and an editor completes it.\n\n/** Every documented component: the web primitives (one entry of the package each) and the native-only ones. */\nexport type ComponentName =\n | \"notification-preferences\"\n | \"quota-meter\"\n | \"environment-notice\"\n | \"embed-facade\"\n | \"reviews\"\n | \"margin-layout\"\n | \"analysis-report\"\n | \"status-chip\"\n | \"kind-config-editor\"\n | \"agenda\"\n | \"account-settings\"\n | \"drop-overlay\"\n | \"upload-queue\"\n | \"achievement\"\n | \"anatomy-plate\"\n | \"bird-plate\"\n | \"taped-photo\"\n | \"stuck\"\n | \"doodle\"\n | \"signature\"\n | \"grade-stamp\"\n | \"versus-card\"\n | \"speed-lines\"\n | \"site-cahier\"\n | \"text-style\"\n | \"flock\"\n | \"elephant\"\n | \"footnote\"\n | \"page-index\"\n | \"chapter\"\n | \"specimen-tag\"\n | \"action-bar\"\n | \"action-sheet\"\n | \"activity-feed\"\n | \"alert\"\n | \"app-frame\"\n | \"desktop-window\"\n | \"form-flow\"\n | \"grid\"\n | \"list-detail\"\n | \"state-screen\"\n | \"app-header\"\n | \"app-shell\"\n | \"argument-card\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"captcha\"\n | \"card\"\n | \"card-grid\"\n | \"catalogue-page\"\n | \"changelog-page\"\n | \"chat\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"chip-row\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"comparison-table\"\n | \"command\"\n | \"component-page\"\n | \"confirm-button\"\n | \"copy-button\"\n | \"money-input\"\n | \"price-catalogue-editor\"\n | \"promo-code-field\"\n | \"contact-page\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cover-hero\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"description-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-article-page\"\n | \"docs-hub-page\"\n | \"docs-layout\"\n | \"docs-nav\"\n | \"document-viewer\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"engine-flow\"\n | \"error-page\"\n | \"fab\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"force-update-screen\"\n | \"form\"\n | \"gallery-page\"\n | \"genui\"\n | \"glossary\"\n | \"glossary-term\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"header\"\n | \"image-cropper\"\n | \"image-viewer\"\n | \"kanban\"\n | \"kbd\"\n | \"kpi-explained\"\n | \"landing-page\"\n | \"landscape\"\n | \"legal-page\"\n | \"link-card\"\n | \"list\"\n | \"loader\"\n | \"longform-page\"\n | \"maintenance-screen\"\n | \"map\"\n | \"markdown\"\n | \"waveform\"\n | \"proposal\"\n | \"qr-code\"\n | \"identity-card\"\n | \"entity-header\"\n | \"collection-switcher\"\n | \"marketing-layout\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"match-dialog\"\n | \"media-capture\"\n | \"language-switch\"\n | \"media-gallery\"\n | \"media-picker\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"onboarding\"\n | \"opening-hours\"\n | \"otp-input\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"permission-prompt\"\n | \"pointer-light\"\n | \"popover\"\n | \"pricing-page\"\n | \"product-page\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"pull-to-refresh\"\n | \"retro-tv\"\n | \"shop-gallery\"\n | \"radio-group\"\n | \"router\"\n | \"rail-nav\"\n | \"recipes\"\n | \"screen\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"service-card\"\n | \"shop\"\n | \"shop-composer\"\n | \"schema-form\"\n | \"settings-layout\"\n | \"account-menu\"\n | \"showcase\"\n | \"step-showcase\"\n | \"site-footer\"\n | \"sites\"\n | \"skeleton\"\n | \"skip-link\"\n | \"slider\"\n | \"slot-picker\"\n | \"slot\"\n | \"spinner\"\n | \"sticky-action\"\n | \"splash-handoff\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"usage\"\n | \"status-page\"\n | \"step-progress\"\n | \"stepper\"\n | \"swipe-deck\"\n | \"swipeable-row\"\n | \"switch\"\n | \"tab-bar\"\n | \"tabs\"\n | \"tag-input\"\n | \"tag-selector\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"tree-view\"\n | \"txt\"\n | \"update-prompt\"\n | \"verified-badge\"\n | \"vertical-video\"\n | \"video-player\"\n | \"video-trimmer\"\n | \"virtual\"\n | \"wall\";\n\n/** Where a component exists: `@krizaka/ui/<name>` (web), `@krizaka/ui/native` (React Native), or both. */\nexport type Platform = \"web\" | \"native\" | \"both\";\n\n/**\n * Why a component is not on a platform — a decision, never a silence (the parity matrix of ui.krizaka.com/platforms):\n * - `gap` (✗): it belongs there and is not built yet; `issue` is the issue that tracks it (`krizaka/krizaka-ui#275`);\n * - `n/a`: it is not meant for that platform (a site's page block on a phone, a swipe on a desktop); `use` names the\n * component that answers there, when one does.\n */\nexport type Absence =\n | { readonly status: \"gap\"; readonly issue: string; readonly reason: string; readonly use?: undefined }\n | { readonly status: \"n/a\"; readonly reason: string; readonly use?: ComponentName; readonly issue?: undefined };\n\n/**\n * Desktop is the Orazaka Mac app (Tauri 2: the system WebView renders the web components — ADR-002). `web`: the web\n * component runs there as it is; `desktop`: it also has a desktop form (a window's title bar, a denser layout…), said in\n * its documentation; otherwise the absence and why.\n */\nexport type DesktopSupport = \"web\" | \"desktop\" | Absence;\n\n/**\n * The three platforms of Krizaka UI — web · native (React Native, Expo) · desktop — for one component. The side a\n * component has is `platforms`; the side it lacks says why here: `native` is required for (and only for) a web-only\n * component, `web` for a native-only one; `desktop` always. `scripts/registry.test.mjs` fails on a missing decision.\n */\nexport interface Parity {\n readonly web?: Absence;\n readonly native?: Absence;\n readonly desktop: DesktopSupport;\n}\n\n/**\n * `experimental`: created for a filed need (ADR-008 §4), it may change or go in any minor until its first consumer imports it; `adoption`\n * names that consumer's issue. `stable`: its API only changes in a major. `beta`: it may still change in a minor. `deprecated`: no product uses it and\n * no work plans to — it still works, says what replaces it, and goes in the major named by `deprecated.removedIn`.\n */\nexport type Status = \"experimental\" | \"stable\" | \"beta\" | \"deprecated\";\n\n/**\n * What a component is for (ADR-008 §3): the twelve domains the documentation, the size budgets and the guards are\n * organised by. The domain is metadata: the entries stay flat (`@krizaka/ui/<name>`). `cahier` is the sites' register\n * (ADR-004): a product never imports it.\n */\nexport type Domain =\n | \"foundations\"\n | \"forms\"\n | \"data-display\"\n | \"navigation-shell\"\n | \"feedback\"\n | \"maps\"\n | \"media\"\n | \"commerce\"\n | \"identity\"\n | \"conversation\"\n | \"page-blocks\"\n | \"cahier\";\n\n/** What a deprecated component says (required when `status` is `deprecated`, absent otherwise). */\nexport interface Deprecation {\n /** The version that deprecated it (`3.6.0`). */\n readonly since: string;\n /** The major that removes it (`4.0.0`). */\n readonly removedIn: string;\n /** What replaces it, when a component does. */\n readonly use?: ComponentName;\n /** Why it goes: no product uses it, no planned work needs it. */\n readonly reason: string;\n}\n\n/**\n * The group of the catalogue. `media`: video, sound, camera, files, cropping. `blocks`: the page blocks — the frame,\n * the hero, sections, cards that lead or argue, decisions, code, calls to act — that every page of a site is made of.\n * `layouts`: the shells of whole screens — an application, a dashboard, settings, sign-in, an object, a list and its\n * item, a site's page, a documentation page — each with its screens. `templates`: the page templates — whole pages of a\n * site (a landing, a product, a docs hub, a long read, a changelog, pricing, status, an error…), each a distinct\n * composition of the blocks, words and content as props.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"templates\" | \"layout\" | \"foundations\";\n\n/** Why a reader needs a template: the seven intents the templates are grouped by (sidebar sub-headings, catalogue filter). */\nexport type TemplatePurpose = \"convince\" | \"explain\" | \"show\" | \"act\" | \"operate\" | \"converse\" | \"recover\";\n\n/** The groups of templates, in reading order: the title, and the one line that says when to come to that group. */\nexport const templatePurposes = {\n convince: { title: \"Convince\", useWhen: \"You come here when a visitor must decide: a landing, a product, a price, a comparison, a proof.\" },\n explain: { title: \"Explain\", useWhen: \"You come here when a reader must understand: how it works, a documentation hub or article, a changelog, a FAQ, a policy.\" },\n show: { title: \"Show\", useWhen: \"You come here when the work itself is the argument: a gallery, a story, a case study, an object and its details.\" },\n act: { title: \"Act\", useWhen: \"You come here when a person must do something once: reach the team, sign in or up, set up, pay.\" },\n operate: { title: \"Operate\", useWhen: \"You come here when a person works every day: a dashboard, a console with a table, settings, an app shell.\" },\n converse: { title: \"Converse\", useWhen: \"You come here when people talk: an inbox, a chat, comments, a notifications centre.\" },\n recover: { title: \"Recover\", useWhen: \"You come here when the way is blocked: an empty list, an error, a missing page, maintenance, a product still being built.\" },\n} as const satisfies Record<TemplatePurpose, { readonly title: string; readonly useWhen: string }>;\n\n/**\n * A named example: the file `registry/examples/<component>/<name>.tsx` (web) or\n * `registry/examples/<component>/native/<name>.tsx` (React Native) — at most 40 lines, imported by the stories and\n * shown (live, with its code) by the documentation.\n */\ninterface ExampleBase {\n /** The file name, kebab-case (`primary`, `icon-button`). */\n readonly name: string;\n /** A short title (`Primary`, `Icon button`). */\n readonly title: string;\n /** One or two sentences: when this variant is the right one. */\n readonly description: string;\n}\n\n/** A plain example, or a template: a whole screen with its intent (`purpose`) and the user goal its layout serves (`why`). */\nexport type Example =\n | (ExampleBase & { readonly template?: false; readonly purpose?: undefined; readonly why?: undefined })\n | (ExampleBase & {\n /**\n * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its\n * phone version thought out), copied as a starting point — at most 160 lines, listed on ui.krizaka.com/templates.\n */\n readonly template: true;\n /** The intent that groups it: why you need this block. */\n readonly purpose: TemplatePurpose;\n /** Why this layout: the user goal it serves, in one sentence. */\n readonly why: string;\n });\n\n/** One platform's side of a component. */\nexport interface PlatformDocs {\n /** The names to import (`[\"Button\", \"IconButton\"]`): from `@krizaka/ui/<name>` on the web, `@krizaka/ui/native` in React Native. */\n readonly imports: readonly string[];\n /** The examples, in reading order; the first one is the component's preview. */\n readonly examples: readonly Example[];\n}\n\n/** The React Native side: the same concept, and what differs from the web API. */\nexport interface NativeDocs extends PlatformDocs {\n /**\n * The entry to import from when it is not `@krizaka/ui/native`: a component that needs an Expo module (an optional\n * peer) has its own, `@krizaka/ui/native/<name>`, so an app that does not use it never installs the module.\n */\n readonly entry?: string;\n /** What differs from the web API (`label` instead of children…); empty for a native-only component. */\n readonly differences: readonly string[];\n /** The React Native entry alone is deprecated while the web one stays (ADR-006 §7); a deprecated component says it once, above. */\n readonly deprecated?: Deprecation;\n}\n\nexport interface KeyboardInteraction {\n /** The keys, as written on a keyboard: `Space`, `Enter`, `Arrow keys`, `Esc`, `Tab`. */\n readonly keys: string;\n /** What they do. */\n readonly action: string;\n}\n\nexport interface ComponentMeta {\n /** The display name: `Button`, `Dropdown menu`. */\n readonly title: string;\n /** One sentence: what it is. */\n readonly summary: string;\n readonly status: Status;\n /** Required for, and only for, a `deprecated` component. */\n readonly deprecated?: Deprecation;\n readonly category: Category;\n /** What it is for: one of the twelve domains (ADR-008 §3). */\n readonly domain: Domain;\n /** The `<repo>#<n>` issue of its first consumer: required for, and only for, an `experimental` component. */\n readonly adoption?: string;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\n /** The platforms it is not on, and why; and its desktop form (see `Parity`). */\n readonly parity: Parity;\n /** When to reach for it: concrete situations, one per item. */\n readonly whenToUse: readonly string[];\n /** When not to — and what to use instead (`use`), when another component is the answer. */\n readonly whenNotToUse: readonly { readonly when: string; readonly use?: ComponentName }[];\n /** How to use it well: wording, placement, composition. */\n readonly bestPractices: readonly string[];\n readonly accessibility: {\n /** The keyboard, when it does more than Tab and Enter. */\n readonly keyboard: readonly KeyboardInteraction[];\n /** Roles, names and announcements: what the component does, what the app must provide. */\n readonly notes: readonly string[];\n };\n /** The components a reader of this page should know about. */\n readonly related: readonly ComponentName[];\n readonly web?: PlatformDocs;\n readonly native?: NativeDocs;\n}\n"
|
|
309
322
|
},
|
|
310
323
|
{
|
|
311
324
|
"path": "site-footer/index.ts",
|
|
@@ -313,15 +326,15 @@
|
|
|
313
326
|
},
|
|
314
327
|
{
|
|
315
328
|
"path": "site-footer/meta.ts",
|
|
316
|
-
"content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n title: \"Site footer\",\n summary:\n \"The footer of
|
|
329
|
+
"content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n title: \"Site footer\",\n summary:\n \"The footer of every Krizaka site and app, compact: at most three lines on a desktop. The site's own links, the family grouped inline (names from `org.family`; shown on krizaka.com, opt-in elsewhere), then the signature, version, legal links and the host's controls.\",\n status: \"beta\",\n category: \"navigation\",\n domain: \"navigation-shell\",\n platforms: \"web\",\n parity: { native: { status: \"n/a\", reason: \"A site's footer; an app has none.\" }, desktop: { status: \"n/a\", reason: \"A public site's page, not a window of the Mac app.\" } },\n whenToUse: [\n \"The bottom of every page of every Krizaka site — www, blog, ui., java., ts., lab. (`tone=\\\"cahier\\\"`) and the products' sites (`tone=\\\"product\\\"`): pass `org` from `@krizaka/org`, so every name, address, signature and legal link is the org's.\",\n \"`variant=\\\"docs\\\"` — under documentation pages: the same three lines on the documentation's width.\",\n \"`variant=\\\"app\\\"` — inside a signed-in product or an admin console: the last line only (signature, version, legal), rendered once by the layout.\",\n \"With `MarketingLayout`'s `footer` slot, under a bar of `@krizaka/ui/nav-bar` with `NavBar.Family`.\",\n ],\n whenNotToUse: [\n { when: \"Twice on one page: a page that already sits under a layout's footer renders none of its own (one `contentinfo` per page).\", use: \"marketing-layout\" },\n { when: \"To list the family in the bar.\", use: \"nav-bar\" },\n ],\n bestPractices: [\n \"Pass `org` (`org` of `@krizaka/org`): the family's names come from `org.family` — the company « Krizaka », products by their own name, libraries « Krizaka <X> » — and the signature is `org.footer.line`. Never type a family name or the legal line in a site.\",\n \"One or two own groups (`SiteFooter.Column` + `SiteFooter.Link`), a handful of links: what a reader looks for at the bottom (docs, pricing, download, source). Never a link the family line already holds — another site, the story, the blog, contact.\",\n \"Pass the version the site runs (`version`, `env=\\\"DEV\\\"` on a dev environment) and the language switch and theme toggle in `controls`.\",\n \"Pass the words translated: `labels={familyLabels[locale]}` from `@krizaka/ui/sites`.\",\n ],\n accessibility: {\n keyboard: [],\n notes: [\n \"A `footer` landmark; the family is a `nav` named by `labels.family`, each group a list named by its heading.\",\n \"On a phone each family group is a native `<details>` (keyboard and screen readers for free, 44 px targets); on a desktop it stays open as one line.\",\n \"The current site says `aria-current=\\\"true\\\"` and “You are here” to screen readers; a status is written, never only a colour.\",\n \"The marks are decorative: every site's name is written beside its mark.\",\n ],\n },\n related: [\"sites\", \"nav-bar\", \"marketing-layout\"],\n web: {\n imports: [\"SiteFooter\", \"SiteFooterColumn\", \"SiteFooterLink\"],\n examples: [\n { name: \"product\", title: \"A product\", description: \"www.yomizaka.com: its links on one line, the family on the second, then the org's line, `DEV · v1.2.3`, the legal links and the language switch.\" },\n { name: \"company\", title: \"The company (Cahier)\", description: \"www.krizaka.com, `tone=\\\"cahier\\\"`: no own links needed, the family and the signature line.\" },\n { name: \"app\", title: \"In a signed-in app\", description: \"`variant=\\\"app\\\"`: one slim line — the org's line, `DEV · v1.2.3`, the legal links.\" },\n { name: \"docs\", title: \"Under documentation\", description: \"`variant=\\\"docs\\\"`: the same three lines on the documentation's width.\" },\n { name: \"open-source-fr\", title: \"Open source, in French\", description: \"ui.krizaka.com in French, `tone=\\\"cahier\\\"`: « Une entreprise de Technologies Krizaka · Fait à Montréal », the version of the packages.\" },\n ],\n },\n} satisfies ComponentMeta;\n"
|
|
317
330
|
},
|
|
318
331
|
{
|
|
319
332
|
"path": "site-footer/site-footer.tsx",
|
|
320
|
-
"content": "// Client (the marks hold an id). The footer shared by every site of the Krizaka family — one calm band (Cahier, ADR-004;\n// peer review krizaka-ui#434: « too much, a double footer »): the site's own columns and the family's columns side by\n// side — Products · Open source (GitHub with them) · Krizaka (our story, the blog, contact) — then one line, with no\n// rule above it (a bottom bar under the columns read as a second footer, 2026-10-21): the signature (“A Krizaka product”, by the kind of the current site, to www), the version, the place, the legal links.\n// No site block (the bar already names the site), no column that lists only Krizaka, no link twice.\nimport { Slot } from \"radix-ui\";\nimport * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\nimport { FamilyMark } from \"../family-mark\";\nimport { KrizakaLogo } from \"../marks/KrizakaLogo\";\nimport { companyLinks, type FamilyLabels, familyLabels, type OrgFacts, siteById, type SiteId, sitesByGroup } from \"../sites/sites\";\n\nexport const siteFooter = tv({\n slots: {\n root: \"w-full border-t border-border-subtle bg-surface-0 text-fg\",\n inner:\n \"mx-auto grid w-full max-w-[calc(var(--kz-page-max,72rem)_+_2*var(--kz-page-gutter,clamp(16px,3.2vw,32px)))] grid-cols-[minmax(0,1fr)] gap-10 px-[var(--kz-page-gutter,clamp(16px,3.2vw,32px))] py-12\",\n band: \"grid grid-cols-[minmax(0,1fr)] gap-8 lg:grid-flow-col lg:auto-cols-[minmax(0,1fr)]\",\n own: \"grid grid-cols-[repeat(auto-fit,minmax(9rem,1fr))] gap-8\",\n family: \"grid grid-cols-2 gap-8 sm:grid-cols-3\",\n column: \"grid min-w-0 content-start gap-3\",\n title: \"text-[11px] font-semibold text-fg-secondary\",\n list: \"grid min-w-0 gap-2\",\n link:\n \"inline-flex min-h-6 min-w-0 flex-wrap items-center gap-x-2 gap-y-0.5 rounded-md text-sm [overflow-wrap:anywhere] text-fg-secondary no-underline transition-colors hover:text-fg \" +\n \"focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring aria-[current=page]:text-fg aria-[current=page]:font-semibold aria-[current=true]:text-fg aria-[current=true]:font-semibold\",\n mark: \"flex h-4 w-4 shrink-0 items-center justify-center text-fg\",\n tag: \"rounded-sm bg-surface-3 px-1.5 py-px text-[10px] font-semibold text-fg-secondary\",\n bottom: \"flex flex-wrap items-center gap-x-5 gap-y-3 text-xs text-fg-secondary\",\n signature:\n \"inline-flex items-center gap-2 rounded-md font-medium text-fg no-underline hover:text-fg-accent focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring\",\n version:\n \"rounded-sm border border-border-subtle bg-surface-2 px-2 py-0.5 font-mono text-[11px] text-fg-secondary\",\n legal: \"flex flex-wrap items-center gap-x-4 gap-y-2 sm:ml-auto\",\n },\n variants: {\n // `site`: the full footer. `docs`: no site block, the columns in one row, on the documentation's width. `app`: one\n // slim line inside a signed-in product — signature, version, legal links.\n variant: {\n site: {},\n docs: {\n inner: \"max-w-[calc(var(--kz-page-max-docs,88rem)_+_2*var(--kz-page-gutter,clamp(16px,3.2vw,32px)))] gap-6 py-8\",\n own: \"sm:grid-cols-4\",\n },\n app: {\n root: \"bg-transparent\",\n inner: \"gap-0 py-3\",\n },\n },\n },\n defaultVariants: { variant: \"site\" },\n});\n\nconst bare = (p: string) => p.replace(/^\\/(en|fr)(?=\\/|$)/, \"\").replace(/\\/+$/, \"\") || \"/\";\n\n/** Is `href` (an absolute family address) the page `path` of the site at `siteUrl`? Locale prefix and trailing slash do not count. */\nfunction isThisPage(href: string, siteUrl: string, path: string): boolean {\n try {\n const target = new URL(href);\n return target.host === new URL(siteUrl).host && bare(target.pathname) === bare(path.split(/[?#]/)[0]!);\n } catch {\n return false;\n }\n}\n\n/** The link to the page you are on: no reload, back to the top (the browser would otherwise keep or restore the scroll). */\nfunction backToTop(event: React.MouseEvent<HTMLAnchorElement>) {\n if (event.metaKey || event.ctrlKey || event.shiftKey || event.button !== 0) return;\n event.preventDefault();\n window.scrollTo({ top: 0, behavior: \"auto\" });\n}\n\nexport type SiteFooterProps = Omit<React.ComponentProps<\"footer\">, \"children\"> & {\n /** The site this footer belongs to (`@krizaka/ui/sites`): its mark and line, its signature, marked in the family. */\n current: SiteId;\n /**\n * The family's words, passed translated: `familyLabels.fr` from `@krizaka/ui/sites`, or your own of the same shape.\n * @default familyLabels.en\n */\n labels?: FamilyLabels;\n /** The site's own columns (`SiteFooter.Column`), before the family. */\n children?: React.ReactNode;\n /** The version the site runs (`1.2.3`, shown `v1.2.3`). */\n version?: string;\n /** The environment, when it is not production (`DEV`). */\n env?: string;\n /**\n * The path of the page being read on this site (`/en/story`, `/blog/…`): the company link that points to this very\n * page says so (`aria-current=\"page\"`, a visible state) and a click on it scrolls to the top instead of reloading.\n */\n path?: string;\n /**\n * Shows the family in columns. Only the hub, krizaka.com, lists the family: every other site (ui., java., the blog, the\n * products) holds its own columns, the legal links, the version and one quiet publisher line — “A Krizaka project” —\n * that links back to www.krizaka.com, the only way back between the sites (2026-10-22).\n * @default current === \"krizaka\"\n */\n family?: boolean;\n /**\n * The hub's product list: only these products appear in the Products column (krizaka.com shows its focus products,\n * and all of them once the reader asks for the whole notebook). Omit it to list every product.\n */\n products?: readonly SiteId[];\n /**\n * The organisation's public facts (`org` of `@krizaka/org`). The signature line is then `org.footer.line` — « Une\n * entreprise de Technologies Krizaka · Fait à Montréal », the same on every site — and, when `legal` is not given, the\n * legal links are `org.footer.legal`, in the language of `labels`. No site writes these lines by hand.\n */\n org?: OrgFacts;\n /** The end of the signature line: legal links, a language switch (`SiteFooter.Link`s or any inline content). */\n legal?: React.ReactNode;\n /**\n * `site` — the full footer of a marketing or company site. `docs` — a compact one for documentation pages (no site\n * block, the columns in a row, the documentation's width; never the family). `app` — one slim line inside a signed-in\n * product: the publisher line, the version and the legal links (no columns, no family); render it once, in the\n * layout, and not at all where the app shell has a sidebar that holds them.\n * @default \"site\"\n */\n variant?: \"site\" | \"docs\" | \"app\";\n};\n\n/** The footer of a Krizaka site, one band: its own columns and the family's, then one line — signature, version, Montréal, legal. */\nexport function SiteFooter({\n current,\n labels = familyLabels.en,\n children,\n version,\n env,\n path,\n legal: legalProp,\n org,\n family: familyProp,\n products,\n variant = \"site\",\n className,\n ...props\n}: SiteFooterProps) {\n const id = React.useId();\n const s = siteFooter({ variant });\n const family = variant === \"site\" && (familyProp ?? current === \"krizaka\");\n const slim = variant === \"app\";\n const site = siteById(current);\n const krizaka = siteById(\"krizaka\");\n const tag = [env, version && `v${version.replace(/^v/, \"\")}`].filter(Boolean).join(\" · \");\n const own = React.Children.toArray(children).length > 0;\n const lang = labels.lang ?? \"en\";\n const company = labels.company ?? familyLabels.en.company!;\n const legal =\n legalProp ??\n (org && (\n <>\n {org.footer.legal.map((l) => (\n <SiteFooterLink key={l.id} href={l.url[lang]}>\n {l.label[lang]}\n </SiteFooterLink>\n ))}\n </>\n ));\n const here = (href: string) => path !== undefined && isThisPage(href, site.url, path);\n // Products · Open source (GitHub, every repository, closes it) · Krizaka (the company's pages): three columns, no\n // column that lists only Krizaka.\n const groups = sitesByGroup();\n const columns = [\n ...groups.filter((g) => g.group === \"products\").map((g) => (products ? { ...g, sites: g.sites.filter((x) => products.includes(x.id) || x.id === current) } : g)),\n { group: \"open-source\" as const, sites: groups.filter((g) => g.group === \"open-source\" || g.group === \"github\").flatMap((g) => g.sites) },\n ];\n return (\n <footer className={s.root({ className })} {...props}>\n <div className={s.inner()}>\n {!slim && (own || family) && (\n <div className={s.band()}>\n {own && <div className={s.own()}>{children}</div>}\n {family && (\n <nav aria-label={labels.family} className={s.family()}>\n {columns.map(({ group, sites }) => (\n <div key={group} className={s.column()}>\n <p id={`${id}-${group}`} className={s.title()}>\n {labels.groups[group]}\n </p>\n <ul aria-labelledby={`${id}-${group}`} className={s.list()}>\n {sites.map((item) => (\n <li key={item.id}>\n <a href={item.url} aria-current={item.id === current ? \"true\" : undefined} className={s.link()}>\n <span className={s.mark()}>\n <FamilyMark mark={item.mark} size={16} />\n </span>\n {item.name}\n {item.status !== \"released\" && <span className={s.tag()}>{labels.status[item.status]}</span>}\n {item.id === current && <span className=\"sr-only\">({labels.current})</span>}\n </a>\n </li>\n ))}\n </ul>\n </div>\n ))}\n <div className={s.column()}>\n <p id={`${id}-krizaka`} className={s.title()}>\n {labels.groups.krizaka}\n </p>\n <ul aria-labelledby={`${id}-krizaka`} className={s.list()}>\n {companyLinks.map((l) => (\n <li key={l.id}>\n <a\n href={l.url[lang]}\n aria-current={here(l.url[lang]) ? \"page\" : undefined}\n onClick={here(l.url[lang]) ? backToTop : undefined}\n className={s.link()}\n >\n {company[l.id]}\n </a>\n </li>\n ))}\n </ul>\n </div>\n </nav>\n )}\n </div>\n )}\n <div className={s.bottom()}>\n <a href={krizaka.url} className={s.signature()}>\n <KrizakaLogo size={18} animated={false} />\n {org ? org.footer.line[lang] : labels.signature[site.kind]}\n </a>\n {tag && (\n <span className={s.version()}>\n <span className=\"sr-only\">{labels.version} </span>\n {tag}\n </span>\n )}\n {!slim && !org && <span>{labels.place}</span>}\n {legal && <div className={s.legal()}>{legal}</div>}\n </div>\n </div>\n </footer>\n );\n}\n\nexport type SiteFooterColumnProps = Omit<React.ComponentProps<\"div\">, \"title\"> & {\n /** The column's heading (“Docs”) — passed translated. */\n title: string;\n /** Its links (`SiteFooter.Link`). */\n children: React.ReactNode;\n};\n\n/** One of the site's own columns: a heading and its links. */\nexport function SiteFooterColumn({ title, children, className, ...props }: SiteFooterColumnProps) {\n const id = React.useId();\n // A group with no link is not a column: only a heading over nothing.\n if (React.Children.toArray(children).length === 0) return null;\n const s = siteFooter();\n return (\n <div className={s.column({ className })} {...props}>\n <p id={id} className={s.title()}>\n {title}\n </p>\n <ul aria-labelledby={id} className={s.list()}>\n {React.Children.toArray(children).map((child, i) => <li key={i}>{child}</li>)}\n </ul>\n </div>\n );\n}\n\nexport type SiteFooterLinkProps = React.ComponentProps<\"a\"> & {\n /** The current page: `aria-current=\"page\"`. */\n active?: boolean;\n /** Renders your router's `<Link>`. */\n asChild?: boolean;\n};\n\n/** A link of the footer. */\nexport function SiteFooterLink({ active, asChild, className, ...props }: SiteFooterLinkProps) {\n const s = siteFooter();\n const Comp = asChild ? Slot.Root : \"a\";\n return <Comp aria-current={active ? \"page\" : undefined} className={s.link({ className })} {...props} />;\n}\n\nSiteFooter.Column = SiteFooterColumn;\nSiteFooter.Link = SiteFooterLink;\n"
|
|
333
|
+
"content": "// Client (the mark holds an id). The footer shared by every site and app of the Krizaka family — compact (founder,\n// 2026-10-30, krizaka/krizaka-internal#754: « des footers de 10 lignes »): at most three lines on a desktop —\n// 1. the site's own links, each group inline (`Docs Get started · Components`);\n// 2. the family, grouped inline (Products · Open source · Krizaka), names read from `org.family` of `@krizaka/org`;\n// 3. one line: the mark and the org's signature, the version, the legal links, the host's controls (language, theme).\n// On a phone the family's groups fold (`<details>`), the rest wraps. `variant=\"app\"` keeps line 3 only. Same structure on\n// the Cahier sites and the products (`tone`). No link twice, no site block, no names typed here when `org` is given.\nimport { Slot } from \"radix-ui\";\nimport * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\n// ProductLogo, not KrizakaLogo: one import path keeps every mark in one shared chunk (KrizakaLogo alone split it: +871 B gzip on the typical page).\nimport { ProductLogo } from \"../marks/ProductLogo\";\nimport { familyGroups, orgIdOf } from \"../sites/family-groups\";\nimport { companyLinks, type FamilyLabels, familyLabels, type OrgFacts, siteById, type SiteId } from \"../sites/sites\";\n\nexport const siteFooter = tv({\n slots: {\n root: \"w-full border-t border-border-subtle bg-surface-0 text-fg\",\n inner:\n \"mx-auto grid w-full max-w-[calc(var(--kz-page-max,72rem)_+_2*var(--kz-page-gutter,clamp(16px,3.2vw,32px)))] grid-cols-[minmax(0,1fr)] gap-3 px-[var(--kz-page-gutter,clamp(16px,3.2vw,32px))] py-6\",\n row: \"flex min-w-0 flex-wrap items-baseline gap-x-6 gap-y-2\",\n family: \"grid min-w-0 grid-cols-[minmax(0,1fr)] gap-1 lg:flex lg:flex-wrap lg:items-baseline lg:gap-x-6 lg:gap-y-2\",\n group:\n \"group/fold min-w-0 lg:[&::details-content]:[content-visibility:visible] lg:[&::details-content]:contents lg:[&>summary]:pointer-events-none lg:inline-flex lg:items-baseline lg:gap-2\",\n summary:\n \"flex min-h-11 cursor-pointer list-none items-center justify-between rounded-md text-xs font-semibold text-fg-secondary [&::-webkit-details-marker]:hidden \" +\n \"focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring lg:inline lg:min-h-0 lg:cursor-default\",\n chevron: \"size-4 shrink-0 transition-transform group-open/fold:rotate-180 motion-reduce:transition-none lg:hidden\",\n column: \"inline-flex min-w-0 flex-wrap items-baseline gap-x-2 gap-y-1\",\n title: \"text-xs font-semibold text-fg-secondary\",\n list: \"flex min-w-0 flex-wrap items-baseline gap-x-3 gap-y-1 pb-2 lg:pb-0\",\n link:\n \"inline-flex min-h-6 min-w-0 items-center rounded-md text-sm [overflow-wrap:anywhere] text-fg-secondary no-underline transition-colors hover:text-fg \" +\n \"focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring aria-[current=page]:text-fg aria-[current=page]:font-semibold aria-[current=true]:text-fg aria-[current=true]:font-semibold\",\n bottom: \"flex flex-wrap items-center gap-x-4 gap-y-2 text-xs text-fg-secondary\",\n signature:\n \"inline-flex items-center gap-2 rounded-md font-medium text-fg no-underline hover:text-fg-accent focus-visible:outline-hidden focus-visible:ring-2 focus-visible:ring-ring\",\n version:\n \"rounded-sm border border-border-subtle bg-surface-2 px-2 py-0.5 font-mono text-[11px] text-fg-secondary\",\n legal: \"flex flex-wrap items-center gap-x-4 gap-y-2\",\n controls: \"flex flex-wrap items-center gap-2 sm:ml-auto\",\n },\n variants: {\n // `site`: the three lines. `docs`: the same on the documentation's width. `app`: line 3 only, inside a signed-in product.\n variant: {\n site: {},\n docs: {\n inner: \"max-w-[calc(var(--kz-page-max-docs,88rem)_+_2*var(--kz-page-gutter,clamp(16px,3.2vw,32px)))]\",\n },\n app: {\n root: \"bg-transparent\",\n inner: \"py-3\",\n },\n },\n // `product`: the products' plain Krizaka UI. `cahier`: the Cahier sites (www, blog, ui., java., ts., lab.) — the\n // headings in the Cahier's hand; the structure is the same.\n tone: {\n product: {},\n cahier: {\n title: \"font-[family-name:var(--kz-font-display,inherit)] italic\",\n summary: \"font-[family-name:var(--kz-font-display,inherit)] italic\",\n },\n },\n },\n defaultVariants: { variant: \"site\", tone: \"product\" },\n});\n\nconst bare = (p: string) => p.replace(/^\\/(en|fr)(?=\\/|$)/, \"\").replace(/\\/+$/, \"\") || \"/\";\n\n/** Is `href` (an absolute family address) the page `path` of the site at `siteUrl`? Locale prefix and trailing slash do not count. */\nfunction isThisPage(href: string, siteUrl: string, path: string): boolean {\n try {\n const target = new URL(href);\n return target.host === new URL(siteUrl).host && bare(target.pathname) === bare(path.split(/[?#]/)[0]!);\n } catch {\n return false;\n }\n}\n\n/** The link to the page you are on: no reload, back to the top (the browser would otherwise keep or restore the scroll). */\nfunction backToTop(event: React.MouseEvent<HTMLAnchorElement>) {\n if (event.metaKey || event.ctrlKey || event.shiftKey || event.button !== 0) return;\n event.preventDefault();\n window.scrollTo({ top: 0, behavior: \"auto\" });\n}\n\ntype Tone = \"product\" | \"cahier\";\nconst ToneContext = React.createContext<Tone>(\"product\");\n\nexport type SiteFooterProps = Omit<React.ComponentProps<\"footer\">, \"children\"> & {\n /** The site this footer belongs to (`@krizaka/ui/sites`): marked in the family, its address for `path`. */\n current: SiteId;\n /**\n * The family's words, passed translated: `familyLabels.fr` from `@krizaka/ui/sites`, or your own of the same shape.\n * @default familyLabels.en\n */\n labels?: FamilyLabels;\n /** The site's own link groups (`SiteFooter.Column`), on the first line. */\n children?: React.ReactNode;\n /** The version the site runs (`1.2.3`, shown `v1.2.3`). */\n version?: string;\n /** The environment, when it is not production (`DEV`). */\n env?: string;\n /**\n * The path of the page being read on this site (`/en/story`, `/blog/…`): the company link that points to this very\n * page says so (`aria-current=\"page\"`) and a click on it scrolls to the top instead of reloading.\n */\n path?: string;\n /**\n * Shows the family on the second line, folded on a phone. The links to the other sites live on krizaka.com only\n * (founder rule, 2026-10-30): every other site and its documentation opts in on purpose, none by default.\n * @default current === \"krizaka\" (and never in `variant=\"app\"`)\n */\n family?: boolean;\n /** Only these products in the Products group (the current site always kept). Omit it to list every product. */\n products?: readonly SiteId[];\n /**\n * The organisation's public facts (`org` of `@krizaka/org`) — pass them on every site. The names and addresses of the\n * family are then `org.family`, the signature is `org.footer.line` (« Une entreprise de Technologies Krizaka · Fait à\n * Montréal », the same everywhere) and, without `legal`, the legal links are `org.footer.legal`.\n */\n org?: OrgFacts;\n /** The legal links, when not the org's (`SiteFooter.Link`s). */\n legal?: React.ReactNode;\n /** The host's controls at the end of the last line: the language switch, the theme toggle. */\n controls?: React.ReactNode;\n /**\n * `site` — every public site. `docs` — the same under documentation, on its width. `app` — inside a signed-in product:\n * the last line only; render it once, in the layout.\n * @default \"site\"\n */\n variant?: \"site\" | \"docs\" | \"app\";\n /** `cahier` on the Cahier sites (www, blog, ui., java., ts., lab.), `product` in the products. @default \"product\" */\n tone?: Tone;\n};\n\n/** The footer of a Krizaka site or app: at most three lines — its links, the family, then signature · version · legal. */\nexport function SiteFooter({\n current,\n labels = familyLabels.en,\n children,\n version,\n env,\n path,\n legal: legalProp,\n controls,\n org,\n family: familyProp,\n products,\n variant = \"site\",\n tone = \"product\",\n className,\n ...props\n}: SiteFooterProps) {\n const id = React.useId();\n const s = siteFooter({ variant, tone });\n const slim = variant === \"app\";\n const family = !slim && (familyProp ?? current === \"krizaka\");\n const site = siteById(current);\n const krizaka = siteById(\"krizaka\");\n const currentId = orgIdOf(current);\n const tag = [env, version && `v${version.replace(/^v/, \"\")}`].filter(Boolean).join(\" · \");\n const own = !slim && React.Children.toArray(children).length > 0;\n const lang = labels.lang ?? \"en\";\n const company = labels.company ?? familyLabels.en.company!;\n const legal =\n legalProp ??\n (org && (\n <>\n {org.footer.legal.map((l) => (\n <SiteFooterLink key={l.id} href={l.url[lang]}>\n {l.label[lang]}\n </SiteFooterLink>\n ))}\n </>\n ));\n const here = (href: string) => path !== undefined && isThisPage(href, site.url, path);\n const productIds = products?.map(orgIdOf);\n // Products · Open source (GitHub closes it) · Krizaka (the company's pages; its home is the signature's link).\n const groups = familyGroups(org);\n const columns = [\n ...groups\n .filter((g) => g.group === \"products\")\n .map((g) => ({ ...g, entries: productIds ? g.entries.filter((e) => productIds.includes(e.id) || e.id === currentId) : g.entries })),\n { group: \"open-source\" as const, entries: groups.filter((g) => g.group === \"open-source\" || g.group === \"github\").flatMap((g) => g.entries) },\n ];\n const companyEntries = companyLinks.map((l) => ({ id: l.id, name: company[l.id], url: l.url[lang] }));\n return (\n <ToneContext.Provider value={tone}>\n <footer className={s.root({ className })} {...props}>\n <div className={s.inner()}>\n {own && <div className={s.row()}>{children}</div>}\n {family && (\n <nav aria-label={labels.family} className={s.family()}>\n {[\n ...columns.map((c) => ({ key: c.group, title: labels.groups[c.group], entries: c.entries })),\n { key: \"krizaka\" as const, title: labels.groups.krizaka, entries: companyEntries },\n ]\n .filter((c) => c.entries.length > 0)\n .map((c) => (\n <details key={c.key} className={s.group()}>\n <summary id={`${id}-${c.key}`} className={s.summary()}>\n {c.title}\n <svg aria-hidden=\"true\" viewBox=\"0 0 16 16\" fill=\"none\" stroke=\"currentColor\" strokeWidth=\"1.5\" className={s.chevron()}>\n <path d=\"M4 6l4 4 4-4\" strokeLinecap=\"round\" strokeLinejoin=\"round\" />\n </svg>\n </summary>\n <ul aria-labelledby={`${id}-${c.key}`} className={s.list()}>\n {c.entries.map((e) => {\n const isCompany = c.key === \"krizaka\";\n const atHome = isCompany && here(e.url);\n const isCurrent = !isCompany && e.id === currentId;\n return (\n <li key={e.id}>\n <a\n href={e.url}\n aria-current={atHome ? \"page\" : isCurrent ? \"true\" : undefined}\n onClick={atHome ? backToTop : undefined}\n className={s.link()}\n >\n {e.name}\n {isCurrent && <span className=\"sr-only\"> ({labels.current})</span>}\n </a>\n </li>\n );\n })}\n </ul>\n </details>\n ))}\n </nav>\n )}\n <div className={s.bottom()}>\n <a href={krizaka.url} className={s.signature()}>\n <ProductLogo id=\"krizaka\" size={18} animated={false} />\n {org ? org.footer.line[lang] : `${labels.signature[site.kind]} · ${labels.place}`}\n </a>\n {tag && (\n <span className={s.version()}>\n <span className=\"sr-only\">{labels.version} </span>\n {tag}\n </span>\n )}\n {legal && <div className={s.legal()}>{legal}</div>}\n {controls && <div className={s.controls()}>{controls}</div>}\n </div>\n </div>\n </footer>\n </ToneContext.Provider>\n );\n}\n\nexport type SiteFooterColumnProps = Omit<React.ComponentProps<\"div\">, \"title\"> & {\n /** The group's heading (“Docs”) — passed translated. */\n title: string;\n /** Its links (`SiteFooter.Link`). */\n children: React.ReactNode;\n};\n\n/** One of the site's own link groups, inline on the first line: its heading, then its links. */\nexport function SiteFooterColumn({ title, children, className, ...props }: SiteFooterColumnProps) {\n const id = React.useId();\n const tone = React.useContext(ToneContext);\n // A group with no link is not a group: only a heading over nothing.\n if (React.Children.toArray(children).length === 0) return null;\n const s = siteFooter({ tone });\n return (\n <div className={s.column({ className })} {...props}>\n <p id={id} className={s.title()}>\n {title}\n </p>\n <ul aria-labelledby={id} className={s.list({ className: \"pb-0\" })}>\n {React.Children.toArray(children).map((child, i) => <li key={i}>{child}</li>)}\n </ul>\n </div>\n );\n}\n\nexport type SiteFooterLinkProps = React.ComponentProps<\"a\"> & {\n /** The current page: `aria-current=\"page\"`. */\n active?: boolean;\n /** Renders your router's `<Link>`. */\n asChild?: boolean;\n};\n\n/** A link of the footer. */\nexport function SiteFooterLink({ active, asChild, className, ...props }: SiteFooterLinkProps) {\n const s = siteFooter();\n const Comp = asChild ? Slot.Root : \"a\";\n return <Comp aria-current={active ? \"page\" : undefined} className={s.link({ className })} {...props} />;\n}\n\nSiteFooter.Column = SiteFooterColumn;\nSiteFooter.Link = SiteFooterLink;\n"
|
|
321
334
|
}
|
|
322
335
|
],
|
|
323
336
|
"dependencies": [
|
|
324
|
-
"@krizaka/tokens@^3.
|
|
337
|
+
"@krizaka/tokens@^3.80.0",
|
|
325
338
|
"radix-ui@^1.8.1",
|
|
326
339
|
"tailwind-variants@^3.3.1"
|
|
327
340
|
],
|
|
@@ -330,25 +343,32 @@
|
|
|
330
343
|
],
|
|
331
344
|
"demo": {
|
|
332
345
|
"path": "examples/site-footer/product.tsx",
|
|
333
|
-
"content": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// A product's footer (
|
|
346
|
+
"content": "import { SiteFooter } from \"@krizaka/ui/site-footer\";\nimport { familyLabels } from \"@krizaka/ui/sites\";\n\n// A product's footer (www.yomizaka.com), three lines: its own links, the family grouped, then the signature, the version,\n// the legal links and the host's controls. In a real site pass `org` from `@krizaka/org`: the names, the signature line\n// and the legal links are then the org's, never typed here.\nexport default function SiteFooterProduct() {\n return (\n <SiteFooter\n current=\"yomizaka\"\n labels={familyLabels.en}\n env=\"DEV\"\n version=\"1.2.3\"\n legal={\n <>\n <SiteFooter.Link href=\"#privacy\">Privacy</SiteFooter.Link>\n <SiteFooter.Link href=\"#terms\">Terms</SiteFooter.Link>\n </>\n }\n controls={\n <SiteFooter.Link href=\"#fr\" lang=\"fr\">\n Français\n </SiteFooter.Link>\n }\n >\n <SiteFooter.Column title=\"Yomizaka\">\n <SiteFooter.Link href=\"#download\">Download</SiteFooter.Link>\n <SiteFooter.Link href=\"#docs\">Documentation</SiteFooter.Link>\n <SiteFooter.Link href=\"#pricing\">Pricing</SiteFooter.Link>\n <SiteFooter.Link href=\"https://github.com/krizaka/yomizaka\">Source code</SiteFooter.Link>\n </SiteFooter.Column>\n </SiteFooter>\n );\n}\n"
|
|
334
347
|
},
|
|
335
348
|
"props": [
|
|
336
349
|
{
|
|
337
350
|
"component": "SiteFooter",
|
|
338
|
-
"description": "The footer of a Krizaka site
|
|
351
|
+
"description": "The footer of a Krizaka site or app: at most three lines — its links, the family, then signature · version · legal.",
|
|
339
352
|
"props": [
|
|
340
353
|
{
|
|
341
354
|
"name": "current",
|
|
342
355
|
"type": "SiteId",
|
|
343
356
|
"default": null,
|
|
344
|
-
"description": "The site this footer belongs to (`@krizaka/ui/sites`):
|
|
357
|
+
"description": "The site this footer belongs to (`@krizaka/ui/sites`): marked in the family, its address for `path`.",
|
|
345
358
|
"required": true
|
|
346
359
|
},
|
|
347
360
|
{
|
|
348
361
|
"name": "children",
|
|
349
362
|
"type": "ReactNode",
|
|
350
363
|
"default": null,
|
|
351
|
-
"description": "The site's own
|
|
364
|
+
"description": "The site's own link groups (`SiteFooter.Column`), on the first line.",
|
|
365
|
+
"required": false
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "controls",
|
|
369
|
+
"type": "ReactNode",
|
|
370
|
+
"default": null,
|
|
371
|
+
"description": "The host's controls at the end of the last line: the language switch, the theme toggle.",
|
|
352
372
|
"required": false
|
|
353
373
|
},
|
|
354
374
|
{
|
|
@@ -361,8 +381,8 @@
|
|
|
361
381
|
{
|
|
362
382
|
"name": "family",
|
|
363
383
|
"type": "boolean",
|
|
364
|
-
"default": "current === \"krizaka\"",
|
|
365
|
-
"description": "Shows the family
|
|
384
|
+
"default": "current === \"krizaka\" (and never in `variant=\"app\"`)",
|
|
385
|
+
"description": "Shows the family on the second line, folded on a phone. The links to the other sites live on krizaka.com only\n(founder rule, 2026-10-30): every other site and its documentation opts in on purpose, none by default.",
|
|
366
386
|
"required": false
|
|
367
387
|
},
|
|
368
388
|
{
|
|
@@ -376,35 +396,42 @@
|
|
|
376
396
|
"name": "legal",
|
|
377
397
|
"type": "ReactNode",
|
|
378
398
|
"default": null,
|
|
379
|
-
"description": "The
|
|
399
|
+
"description": "The legal links, when not the org's (`SiteFooter.Link`s).",
|
|
380
400
|
"required": false
|
|
381
401
|
},
|
|
382
402
|
{
|
|
383
403
|
"name": "org",
|
|
384
404
|
"type": "OrgFacts",
|
|
385
405
|
"default": null,
|
|
386
|
-
"description": "The organisation's public facts (`org` of `@krizaka/org`). The
|
|
406
|
+
"description": "The organisation's public facts (`org` of `@krizaka/org`) — pass them on every site. The names and addresses of the\nfamily are then `org.family`, the signature is `org.footer.line` (« Une entreprise de Technologies Krizaka · Fait à\nMontréal », the same everywhere) and, without `legal`, the legal links are `org.footer.legal`.",
|
|
387
407
|
"required": false
|
|
388
408
|
},
|
|
389
409
|
{
|
|
390
410
|
"name": "path",
|
|
391
411
|
"type": "string",
|
|
392
412
|
"default": null,
|
|
393
|
-
"description": "The path of the page being read on this site (`/en/story`, `/blog/…`): the company link that points to this very\npage says so (`aria-current=\"page\"
|
|
413
|
+
"description": "The path of the page being read on this site (`/en/story`, `/blog/…`): the company link that points to this very\npage says so (`aria-current=\"page\"`) and a click on it scrolls to the top instead of reloading.",
|
|
394
414
|
"required": false
|
|
395
415
|
},
|
|
396
416
|
{
|
|
397
417
|
"name": "products",
|
|
398
418
|
"type": "readonly SiteId[]",
|
|
399
419
|
"default": null,
|
|
400
|
-
"description": "
|
|
420
|
+
"description": "Only these products in the Products group (the current site always kept). Omit it to list every product.",
|
|
421
|
+
"required": false
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "tone",
|
|
425
|
+
"type": "Tone",
|
|
426
|
+
"default": "product",
|
|
427
|
+
"description": "`cahier` on the Cahier sites (www, blog, ui., java., ts., lab.), `product` in the products.",
|
|
401
428
|
"required": false
|
|
402
429
|
},
|
|
403
430
|
{
|
|
404
431
|
"name": "variant",
|
|
405
432
|
"type": "\"docs\" | \"app\" | \"site\"",
|
|
406
433
|
"default": "site",
|
|
407
|
-
"description": "`site` —
|
|
434
|
+
"description": "`site` — every public site. `docs` — the same under documentation, on its width. `app` — inside a signed-in product:\nthe last line only; render it once, in the layout.",
|
|
408
435
|
"required": false
|
|
409
436
|
},
|
|
410
437
|
{
|
|
@@ -418,13 +445,13 @@
|
|
|
418
445
|
},
|
|
419
446
|
{
|
|
420
447
|
"component": "SiteFooter.Column",
|
|
421
|
-
"description": "One of the site's own
|
|
448
|
+
"description": "One of the site's own link groups, inline on the first line: its heading, then its links.",
|
|
422
449
|
"props": [
|
|
423
450
|
{
|
|
424
451
|
"name": "title",
|
|
425
452
|
"type": "string",
|
|
426
453
|
"default": null,
|
|
427
|
-
"description": "The
|
|
454
|
+
"description": "The group's heading (“Docs”) — passed translated.",
|
|
428
455
|
"required": true
|
|
429
456
|
}
|
|
430
457
|
]
|
|
@@ -451,13 +478,13 @@
|
|
|
451
478
|
},
|
|
452
479
|
{
|
|
453
480
|
"component": "SiteFooterColumn",
|
|
454
|
-
"description": "One of the site's own
|
|
481
|
+
"description": "One of the site's own link groups, inline on the first line: its heading, then its links.",
|
|
455
482
|
"props": [
|
|
456
483
|
{
|
|
457
484
|
"name": "title",
|
|
458
485
|
"type": "string",
|
|
459
486
|
"default": null,
|
|
460
|
-
"description": "The
|
|
487
|
+
"description": "The group's heading (“Docs”) — passed translated.",
|
|
461
488
|
"required": true
|
|
462
489
|
}
|
|
463
490
|
]
|