@krizaka/ui 2.9.0 → 3.0.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 +44 -6
- package/dist/audio-player.js +1 -1
- package/dist/blocks.css +247 -0
- package/dist/catalogue-page.d.ts +34 -0
- package/dist/catalogue-page.js +26 -0
- package/dist/catalogue-page.js.map +1 -0
- package/dist/changelog-page.d.ts +50 -0
- package/dist/changelog-page.js +27 -0
- package/dist/changelog-page.js.map +1 -0
- package/dist/{chunk-EUPTXKH7.js → chunk-BRKMQ6JV.js} +2 -1
- package/dist/chunk-FDCMBWUU.js +168 -0
- package/dist/chunk-FDCMBWUU.js.map +1 -0
- package/dist/chunk-HCNOOPZE.js +210 -0
- package/dist/chunk-HCNOOPZE.js.map +1 -0
- package/dist/{chunk-NOVUREEC.js → chunk-JZPVUJIX.js} +25 -3
- package/dist/chunk-JZPVUJIX.js.map +1 -0
- package/dist/chunk-KNBYZGSQ.js +11 -0
- package/dist/chunk-KNBYZGSQ.js.map +1 -0
- package/dist/{chunk-X6TW3X6Y.js → chunk-LCZXS6AK.js} +2 -2
- package/dist/chunk-OGJI5X4W.js +157 -0
- package/dist/chunk-OGJI5X4W.js.map +1 -0
- package/dist/combobox.js +2 -2
- package/dist/component-page.d.ts +41 -0
- package/dist/component-page.js +17 -0
- package/dist/component-page.js.map +1 -0
- package/dist/contact-page.d.ts +31 -0
- package/dist/contact-page.js +26 -0
- package/dist/contact-page.js.map +1 -0
- package/dist/data-table.d.ts +284 -24
- package/dist/data-table.js +914 -121
- package/dist/data-table.js.map +1 -1
- package/dist/date-picker.js +1 -1
- package/dist/docs-article-page.d.ts +54 -0
- package/dist/docs-article-page.js +29 -0
- package/dist/docs-article-page.js.map +1 -0
- package/dist/docs-hub-page.d.ts +72 -0
- package/dist/docs-hub-page.js +45 -0
- package/dist/docs-hub-page.js.map +1 -0
- package/dist/error-page.d.ts +22 -0
- package/dist/error-page.js +23 -0
- package/dist/error-page.js.map +1 -0
- package/dist/filter-bar.d.ts +12 -12
- package/dist/filter-bar.js +9 -145
- package/dist/filter-bar.js.map +1 -1
- package/dist/gallery-page.d.ts +50 -0
- package/dist/gallery-page.js +30 -0
- package/dist/gallery-page.js.map +1 -0
- package/dist/{geometry-CXrAW34x.d.ts → geometry-CbOU4rtL.d.ts} +4 -4
- package/dist/how-it-works-page.d.ts +48 -0
- package/dist/how-it-works-page.js +28 -0
- package/dist/how-it-works-page.js.map +1 -0
- package/dist/image-cropper.js +1 -1
- package/dist/index.d.ts +11 -2
- package/dist/index.js +93 -5
- package/dist/index.js.map +1 -1
- package/dist/landing-page.d.ts +58 -0
- package/dist/landing-page.js +42 -0
- package/dist/landing-page.js.map +1 -0
- package/dist/legal-page.d.ts +34 -0
- package/dist/legal-page.js +18 -0
- package/dist/legal-page.js.map +1 -0
- package/dist/longform-page.d.ts +42 -0
- package/dist/longform-page.js +29 -0
- package/dist/longform-page.js.map +1 -0
- package/dist/mascot-quote.d.ts +4 -4
- package/dist/mascot-quote.js +23 -1
- package/dist/mascot-quote.js.map +1 -1
- package/dist/mascot-state.d.ts +2 -2
- package/dist/mascot-state.js +1 -1
- package/dist/mascot-state.js.map +1 -1
- package/dist/mascots.d.ts +4 -4
- package/dist/mascots.js +1 -1
- package/dist/media-capture.js +1 -1
- package/dist/native/list.d.ts +95 -0
- package/dist/native/list.js +135 -0
- package/dist/native/list.js.map +1 -0
- package/dist/native.d.ts +16 -9
- package/dist/native.js +183 -74
- package/dist/native.js.map +1 -1
- package/dist/pricing-page.d.ts +62 -0
- package/dist/pricing-page.js +71 -0
- package/dist/pricing-page.js.map +1 -0
- package/dist/product-page.d.ts +83 -0
- package/dist/product-page.js +60 -0
- package/dist/product-page.js.map +1 -0
- package/dist/search-field.js +6 -160
- package/dist/search-field.js.map +1 -1
- package/dist/status-page.d.ts +42 -0
- package/dist/status-page.js +28 -0
- package/dist/status-page.js.map +1 -0
- package/dist/tag-input.js +2 -2
- package/dist/video-player.js +1 -1
- package/dist/video-trimmer.js +1 -1
- package/dist/virtual.d.ts +140 -0
- package/dist/virtual.js +19 -0
- package/dist/virtual.js.map +1 -0
- package/package.json +296 -10
- package/registry/achievement.json +1 -1
- package/registry/action-bar.json +1 -1
- package/registry/alert.json +1 -1
- package/registry/app-shell.json +1 -1
- package/registry/argument-card.json +1 -1
- package/registry/audio-player.json +1 -1
- package/registry/auth-layout.json +1 -1
- package/registry/avatar.json +1 -1
- package/registry/badge.json +1 -1
- package/registry/button.json +1 -1
- package/registry/card-grid.json +1 -1
- package/registry/card.json +1 -1
- package/registry/catalogue-page.json +240 -0
- package/registry/changelog-page.json +226 -0
- package/registry/checkbox.json +1 -1
- package/registry/chip-link.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/combobox.json +1 -1
- package/registry/command.json +1 -1
- package/registry/component-page.json +227 -0
- package/registry/confirm-button.json +1 -1
- package/registry/contact-page.json +212 -0
- package/registry/continue-prompt.json +1 -1
- package/registry/countdown.json +1 -1
- package/registry/cta-panel.json +1 -1
- package/registry/dashboard-layout.json +1 -1
- package/registry/data-table.json +643 -49
- package/registry/date-picker.json +1 -1
- package/registry/decision-list.json +1 -1
- package/registry/detail-layout.json +1 -1
- package/registry/dialog.json +1 -1
- package/registry/docs-article-page.json +242 -0
- package/registry/docs-hub-page.json +270 -0
- package/registry/docs-layout.json +1 -1
- package/registry/dropdown-menu.json +1 -1
- package/registry/empty-state.json +1 -1
- package/registry/error-page.json +183 -0
- package/registry/examples/catalogue-page/components.d.ts +4 -0
- package/registry/examples/catalogue-page/components.js +33 -0
- package/registry/examples/catalogue-page/components.tsx +36 -0
- package/registry/examples/changelog-page/releases.d.ts +4 -0
- package/registry/examples/changelog-page/releases.js +44 -0
- package/registry/examples/changelog-page/releases.tsx +39 -0
- package/registry/examples/component-page/button.d.ts +4 -0
- package/registry/examples/component-page/button.js +33 -0
- package/registry/examples/component-page/button.tsx +30 -0
- package/registry/examples/contact-page/team.d.ts +4 -0
- package/registry/examples/contact-page/team.js +39 -0
- package/registry/examples/contact-page/team.tsx +38 -0
- package/registry/examples/data-table/details.d.ts +4 -0
- package/registry/examples/data-table/details.js +33 -0
- package/registry/examples/data-table/details.tsx +31 -0
- package/registry/examples/data-table/filters.d.ts +4 -0
- package/registry/examples/data-table/filters.js +40 -0
- package/registry/examples/data-table/filters.tsx +40 -0
- package/registry/examples/data-table/grouped.d.ts +4 -0
- package/registry/examples/data-table/grouped.js +24 -0
- package/registry/examples/data-table/grouped.tsx +23 -0
- package/registry/examples/data-table/paginated.d.ts +4 -0
- package/registry/examples/data-table/paginated.js +23 -0
- package/registry/examples/data-table/paginated.tsx +22 -0
- package/registry/examples/data-table/pinned.d.ts +4 -0
- package/registry/examples/data-table/pinned.js +26 -0
- package/registry/examples/data-table/pinned.tsx +25 -0
- package/registry/examples/data-table/server.d.ts +4 -0
- package/registry/examples/data-table/server.js +40 -0
- package/registry/examples/data-table/server.tsx +40 -0
- package/registry/examples/data-table/virtualized.js +2 -2
- package/registry/examples/data-table/virtualized.tsx +3 -3
- package/registry/examples/docs-article-page/cli.d.ts +4 -0
- package/registry/examples/docs-article-page/cli.js +33 -0
- package/registry/examples/docs-article-page/cli.tsx +38 -0
- package/registry/examples/docs-hub-page/krizaka.d.ts +4 -0
- package/registry/examples/docs-hub-page/krizaka.js +46 -0
- package/registry/examples/docs-hub-page/krizaka.tsx +37 -0
- package/registry/examples/error-page/not-found.d.ts +4 -0
- package/registry/examples/error-page/not-found.js +24 -0
- package/registry/examples/error-page/not-found.tsx +19 -0
- package/registry/examples/gallery-page/made-here.d.ts +4 -0
- package/registry/examples/gallery-page/made-here.js +34 -0
- package/registry/examples/gallery-page/made-here.tsx +32 -0
- package/registry/examples/how-it-works-page/orazaka.d.ts +4 -0
- package/registry/examples/how-it-works-page/orazaka.js +30 -0
- package/registry/examples/how-it-works-page/orazaka.tsx +26 -0
- package/registry/examples/landing-page/krizaka.d.ts +4 -0
- package/registry/examples/landing-page/krizaka.js +44 -0
- package/registry/examples/landing-page/krizaka.tsx +44 -0
- package/registry/examples/legal-page/privacy.d.ts +4 -0
- package/registry/examples/legal-page/privacy.js +24 -0
- package/registry/examples/legal-page/privacy.tsx +19 -0
- package/registry/examples/list/native/default.d.ts +4 -0
- package/registry/examples/list/native/default.dark.png +0 -0
- package/registry/examples/list/native/default.js +33 -0
- package/registry/examples/list/native/default.light.png +0 -0
- package/registry/examples/list/native/default.tsx +31 -0
- package/registry/examples/list/native/infinite.d.ts +4 -0
- package/registry/examples/list/native/infinite.dark.png +0 -0
- package/registry/examples/list/native/infinite.js +30 -0
- package/registry/examples/list/native/infinite.light.png +0 -0
- package/registry/examples/list/native/infinite.tsx +35 -0
- package/registry/examples/list/native/states.d.ts +4 -0
- package/registry/examples/list/native/states.dark.png +0 -0
- package/registry/examples/list/native/states.js +26 -0
- package/registry/examples/list/native/states.light.png +0 -0
- package/registry/examples/list/native/states.tsx +21 -0
- package/registry/examples/longform-page/story.d.ts +4 -0
- package/registry/examples/longform-page/story.js +38 -0
- package/registry/examples/longform-page/story.tsx +35 -0
- package/registry/examples/mascots/crane.d.ts +4 -0
- package/registry/examples/mascots/crane.js +19 -0
- package/registry/examples/mascots/crane.tsx +18 -0
- package/registry/examples/mascots/flock.tsx +2 -1
- package/registry/examples/mascots/native/crane.d.ts +4 -0
- package/registry/examples/mascots/native/crane.dark.png +0 -0
- package/registry/examples/mascots/native/crane.js +21 -0
- package/registry/examples/mascots/native/crane.light.png +0 -0
- package/registry/examples/mascots/native/crane.tsx +18 -0
- package/registry/examples/pricing-page/credits.d.ts +4 -0
- package/registry/examples/pricing-page/credits.js +41 -0
- package/registry/examples/pricing-page/credits.tsx +33 -0
- package/registry/examples/product-page/orazaka.d.ts +4 -0
- package/registry/examples/product-page/orazaka.js +44 -0
- package/registry/examples/product-page/orazaka.tsx +36 -0
- package/registry/examples/status-page/building.d.ts +4 -0
- package/registry/examples/status-page/building.js +29 -0
- package/registry/examples/status-page/building.tsx +25 -0
- package/registry/examples/status-page/operational.d.ts +4 -0
- package/registry/examples/status-page/operational.js +26 -0
- package/registry/examples/status-page/operational.tsx +20 -0
- package/registry/examples/virtual/feed.d.ts +4 -0
- package/registry/examples/virtual/feed.js +26 -0
- package/registry/examples/virtual/feed.tsx +24 -0
- package/registry/examples/virtual/gallery.d.ts +4 -0
- package/registry/examples/virtual/gallery.js +31 -0
- package/registry/examples/virtual/gallery.tsx +28 -0
- package/registry/examples/virtual/messages.d.ts +4 -0
- package/registry/examples/virtual/messages.js +28 -0
- package/registry/examples/virtual/messages.tsx +28 -0
- package/registry/field.json +1 -1
- package/registry/file-upload.json +1 -1
- package/registry/filter-bar.json +1 -1
- package/registry/gallery-page.json +256 -0
- package/registry/glow-card.json +1 -1
- package/registry/goal-gauge.json +1 -1
- package/registry/how-it-works-page.json +242 -0
- package/registry/image-cropper.json +1 -1
- package/registry/index.json +356 -9
- package/registry/iso.json +1 -1
- package/registry/kbd.json +1 -1
- package/registry/landing-page.json +242 -0
- package/registry/landscape.json +1 -1
- package/registry/legal-page.json +199 -0
- package/registry/link-card.json +1 -1
- package/registry/list.json +249 -0
- package/registry/loader.json +1 -1
- package/registry/longform-page.json +213 -0
- package/registry/marketing-layout.json +1 -1
- package/registry/marquee.json +1 -1
- package/registry/mascot-quote.json +6 -6
- package/registry/mascot-state.json +34 -34
- package/registry/mascots.json +41 -21
- package/registry/media-capture.json +1 -1
- package/registry/meter.json +1 -1
- package/registry/nav-bar.json +1 -1
- package/registry/number-ticker.json +1 -1
- package/registry/page-header.json +1 -1
- package/registry/page-hero.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/pricing-page.json +245 -0
- package/registry/product-page.json +319 -0
- package/registry/profile-card.json +1 -1
- package/registry/progress.json +1 -1
- package/registry/promise-card.json +1 -1
- package/registry/radio-group.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/settings-layout.json +1 -1
- package/registry/skeleton.json +1 -1
- package/registry/slider.json +1 -1
- package/registry/slot.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-page.json +263 -0
- package/registry/stepper.json +1 -1
- package/registry/switch.json +1 -1
- package/registry/tabs.json +1 -1
- package/registry/tag-input.json +1 -1
- package/registry/terminal-replay.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/video-player.json +1 -1
- package/registry/video-trimmer.json +1 -1
- package/registry/virtual.json +569 -0
- package/skills/data-table/SKILL.md +56 -0
- package/skills/native-list/SKILL.md +39 -0
- package/skills/virtual/SKILL.md +35 -0
- package/dist/chunk-NOVUREEC.js.map +0 -1
- /package/dist/{chunk-EUPTXKH7.js.map → chunk-BRKMQ6JV.js.map} +0 -0
- /package/dist/{chunk-X6TW3X6Y.js.map → chunk-LCZXS6AK.js.map} +0 -0
package/registry/index.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@krizaka/ui",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"items": [
|
|
5
5
|
{
|
|
6
6
|
"name": "achievement",
|
|
@@ -233,6 +233,44 @@
|
|
|
233
233
|
"pointer-light"
|
|
234
234
|
]
|
|
235
235
|
},
|
|
236
|
+
{
|
|
237
|
+
"name": "catalogue-page",
|
|
238
|
+
"type": "primitive",
|
|
239
|
+
"title": "Catalogue page",
|
|
240
|
+
"summary": "A catalogue or an index: the search in the hero, the filters in a sticky column beside the results (folded above them on a phone), the count, the results.",
|
|
241
|
+
"description": "A catalogue or an index: the search in the hero, the filters in a sticky column beside the results (folded above them on a phone), the count, the results.",
|
|
242
|
+
"status": "beta",
|
|
243
|
+
"category": "templates",
|
|
244
|
+
"platforms": "web",
|
|
245
|
+
"examples": {
|
|
246
|
+
"web": 1,
|
|
247
|
+
"native": 0
|
|
248
|
+
},
|
|
249
|
+
"dependencies": [],
|
|
250
|
+
"registryDependencies": [
|
|
251
|
+
"page",
|
|
252
|
+
"page-hero"
|
|
253
|
+
]
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"name": "changelog-page",
|
|
257
|
+
"type": "primitive",
|
|
258
|
+
"title": "Changelog page",
|
|
259
|
+
"summary": "What changed and why: each entry with its date and version sticking beside it, its changes by kind in words and colour, its reasons under it.",
|
|
260
|
+
"description": "What changed and why: each entry with its date and version sticking beside it, its changes by kind in words and colour, its reasons under it.",
|
|
261
|
+
"status": "beta",
|
|
262
|
+
"category": "templates",
|
|
263
|
+
"platforms": "web",
|
|
264
|
+
"examples": {
|
|
265
|
+
"web": 1,
|
|
266
|
+
"native": 0
|
|
267
|
+
},
|
|
268
|
+
"dependencies": [],
|
|
269
|
+
"registryDependencies": [
|
|
270
|
+
"page",
|
|
271
|
+
"page-hero"
|
|
272
|
+
]
|
|
273
|
+
},
|
|
236
274
|
{
|
|
237
275
|
"name": "checkbox",
|
|
238
276
|
"type": "primitive",
|
|
@@ -389,6 +427,26 @@
|
|
|
389
427
|
"dialog"
|
|
390
428
|
]
|
|
391
429
|
},
|
|
430
|
+
{
|
|
431
|
+
"name": "component-page",
|
|
432
|
+
"type": "primitive",
|
|
433
|
+
"title": "Component page",
|
|
434
|
+
"summary": "A component's page: its name, summary, status and platforms, the live preview, the import line, its sections, the related components aside.",
|
|
435
|
+
"description": "A component's page: its name, summary, status and platforms, the live preview, the import line, its sections, the related components aside.",
|
|
436
|
+
"status": "beta",
|
|
437
|
+
"category": "templates",
|
|
438
|
+
"platforms": "web",
|
|
439
|
+
"examples": {
|
|
440
|
+
"web": 1,
|
|
441
|
+
"native": 0
|
|
442
|
+
},
|
|
443
|
+
"dependencies": [],
|
|
444
|
+
"registryDependencies": [
|
|
445
|
+
"code-block",
|
|
446
|
+
"detail-layout",
|
|
447
|
+
"page"
|
|
448
|
+
]
|
|
449
|
+
},
|
|
392
450
|
{
|
|
393
451
|
"name": "confirm-button",
|
|
394
452
|
"type": "primitive",
|
|
@@ -410,6 +468,25 @@
|
|
|
410
468
|
"cn"
|
|
411
469
|
]
|
|
412
470
|
},
|
|
471
|
+
{
|
|
472
|
+
"name": "contact-page",
|
|
473
|
+
"type": "primitive",
|
|
474
|
+
"title": "Contact page",
|
|
475
|
+
"summary": "Reaching the team: the public channels as cards beside the form, then what happens after sending.",
|
|
476
|
+
"description": "Reaching the team: the public channels as cards beside the form, then what happens after sending.",
|
|
477
|
+
"status": "beta",
|
|
478
|
+
"category": "templates",
|
|
479
|
+
"platforms": "web",
|
|
480
|
+
"examples": {
|
|
481
|
+
"web": 1,
|
|
482
|
+
"native": 0
|
|
483
|
+
},
|
|
484
|
+
"dependencies": [],
|
|
485
|
+
"registryDependencies": [
|
|
486
|
+
"page",
|
|
487
|
+
"page-hero"
|
|
488
|
+
]
|
|
489
|
+
},
|
|
413
490
|
{
|
|
414
491
|
"name": "continue-prompt",
|
|
415
492
|
"type": "primitive",
|
|
@@ -487,20 +564,28 @@
|
|
|
487
564
|
"name": "data-table",
|
|
488
565
|
"type": "primitive",
|
|
489
566
|
"title": "Data table",
|
|
490
|
-
"summary": "A table of records — sort, selection,
|
|
491
|
-
"description": "A table of records — sort, selection,
|
|
567
|
+
"summary": "A table of records on TanStack Table v9 — sort, filters and facets, groups, details, pages, selection, column visibility, pinning and resizing — in the browser or on the server, cards on a phone, windowing for long lists.",
|
|
568
|
+
"description": "A table of records on TanStack Table v9 — sort, filters and facets, groups, details, pages, selection, column visibility, pinning and resizing — in the browser or on the server, cards on a phone, windowing for long lists.",
|
|
492
569
|
"status": "beta",
|
|
493
570
|
"category": "data-display",
|
|
494
571
|
"platforms": "web",
|
|
495
572
|
"examples": {
|
|
496
|
-
"web":
|
|
573
|
+
"web": 12,
|
|
497
574
|
"native": 0
|
|
498
575
|
},
|
|
499
576
|
"dependencies": [
|
|
577
|
+
"@tanstack/react-table@9.2.8",
|
|
500
578
|
"tailwind-variants@^3.3.1"
|
|
501
579
|
],
|
|
502
580
|
"registryDependencies": [
|
|
503
|
-
"
|
|
581
|
+
"button",
|
|
582
|
+
"checkbox",
|
|
583
|
+
"dropdown-menu",
|
|
584
|
+
"field",
|
|
585
|
+
"filter-bar",
|
|
586
|
+
"pagination",
|
|
587
|
+
"search-field",
|
|
588
|
+
"virtual"
|
|
504
589
|
]
|
|
505
590
|
},
|
|
506
591
|
{
|
|
@@ -581,6 +666,47 @@
|
|
|
581
666
|
"button"
|
|
582
667
|
]
|
|
583
668
|
},
|
|
669
|
+
{
|
|
670
|
+
"name": "docs-article-page",
|
|
671
|
+
"type": "primitive",
|
|
672
|
+
"title": "Docs article page",
|
|
673
|
+
"summary": "A documentation article in the docs frame: the pages, the breadcrumb, the title with its facts, the reading column, the contents, previous and next.",
|
|
674
|
+
"description": "A documentation article in the docs frame: the pages, the breadcrumb, the title with its facts, the reading column, the contents, previous and next.",
|
|
675
|
+
"status": "beta",
|
|
676
|
+
"category": "templates",
|
|
677
|
+
"platforms": "web",
|
|
678
|
+
"examples": {
|
|
679
|
+
"web": 1,
|
|
680
|
+
"native": 0
|
|
681
|
+
},
|
|
682
|
+
"dependencies": [],
|
|
683
|
+
"registryDependencies": [
|
|
684
|
+
"docs-layout",
|
|
685
|
+
"page",
|
|
686
|
+
"page-hero",
|
|
687
|
+
"toc"
|
|
688
|
+
]
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"name": "docs-hub-page",
|
|
692
|
+
"type": "primitive",
|
|
693
|
+
"title": "Docs hub page",
|
|
694
|
+
"summary": "The entry of a documentation: the search in the middle of the hero, the collections each in its product's brand with their quick links, quick starts beside the most read pages, what is new, the owl's promise.",
|
|
695
|
+
"description": "The entry of a documentation: the search in the middle of the hero, the collections each in its product's brand with their quick links, quick starts beside the most read pages, what is new, the owl's promise.",
|
|
696
|
+
"status": "beta",
|
|
697
|
+
"category": "templates",
|
|
698
|
+
"platforms": "web",
|
|
699
|
+
"examples": {
|
|
700
|
+
"web": 1,
|
|
701
|
+
"native": 0
|
|
702
|
+
},
|
|
703
|
+
"dependencies": [],
|
|
704
|
+
"registryDependencies": [
|
|
705
|
+
"mascot-quote",
|
|
706
|
+
"page",
|
|
707
|
+
"page-hero"
|
|
708
|
+
]
|
|
709
|
+
},
|
|
584
710
|
{
|
|
585
711
|
"name": "docs-layout",
|
|
586
712
|
"type": "primitive",
|
|
@@ -638,6 +764,24 @@
|
|
|
638
764
|
],
|
|
639
765
|
"registryDependencies": []
|
|
640
766
|
},
|
|
767
|
+
{
|
|
768
|
+
"name": "error-page",
|
|
769
|
+
"type": "primitive",
|
|
770
|
+
"title": "Error page",
|
|
771
|
+
"summary": "When a page is not there: the code drawn huge, the bird that lost its way, one sentence, a search and the ways back — never a dead end.",
|
|
772
|
+
"description": "When a page is not there: the code drawn huge, the bird that lost its way, one sentence, a search and the ways back — never a dead end.",
|
|
773
|
+
"status": "beta",
|
|
774
|
+
"category": "templates",
|
|
775
|
+
"platforms": "web",
|
|
776
|
+
"examples": {
|
|
777
|
+
"web": 1,
|
|
778
|
+
"native": 0
|
|
779
|
+
},
|
|
780
|
+
"dependencies": [],
|
|
781
|
+
"registryDependencies": [
|
|
782
|
+
"cn"
|
|
783
|
+
]
|
|
784
|
+
},
|
|
641
785
|
{
|
|
642
786
|
"name": "field",
|
|
643
787
|
"type": "primitive",
|
|
@@ -701,6 +845,27 @@
|
|
|
701
845
|
"dropdown-menu"
|
|
702
846
|
]
|
|
703
847
|
},
|
|
848
|
+
{
|
|
849
|
+
"name": "gallery-page",
|
|
850
|
+
"type": "primitive",
|
|
851
|
+
"title": "Gallery page",
|
|
852
|
+
"summary": "A demo or a gallery: the filters as links, then the pieces in staggered columns, each framed with how it was made.",
|
|
853
|
+
"description": "A demo or a gallery: the filters as links, then the pieces in staggered columns, each framed with how it was made.",
|
|
854
|
+
"status": "beta",
|
|
855
|
+
"category": "templates",
|
|
856
|
+
"platforms": "web",
|
|
857
|
+
"examples": {
|
|
858
|
+
"web": 1,
|
|
859
|
+
"native": 0
|
|
860
|
+
},
|
|
861
|
+
"dependencies": [],
|
|
862
|
+
"registryDependencies": [
|
|
863
|
+
"cn",
|
|
864
|
+
"cta-panel",
|
|
865
|
+
"page",
|
|
866
|
+
"page-hero"
|
|
867
|
+
]
|
|
868
|
+
},
|
|
704
869
|
{
|
|
705
870
|
"name": "glow-card",
|
|
706
871
|
"type": "primitive",
|
|
@@ -739,6 +904,27 @@
|
|
|
739
904
|
"cn"
|
|
740
905
|
]
|
|
741
906
|
},
|
|
907
|
+
{
|
|
908
|
+
"name": "how-it-works-page",
|
|
909
|
+
"type": "primitive",
|
|
910
|
+
"title": "How-it-works page",
|
|
911
|
+
"summary": "How a product works, told in steps along a numbered line — each step its words beside its visual, the sides alternating on a wide screen.",
|
|
912
|
+
"description": "How a product works, told in steps along a numbered line — each step its words beside its visual, the sides alternating on a wide screen.",
|
|
913
|
+
"status": "beta",
|
|
914
|
+
"category": "templates",
|
|
915
|
+
"platforms": "web",
|
|
916
|
+
"examples": {
|
|
917
|
+
"web": 1,
|
|
918
|
+
"native": 0
|
|
919
|
+
},
|
|
920
|
+
"dependencies": [],
|
|
921
|
+
"registryDependencies": [
|
|
922
|
+
"cn",
|
|
923
|
+
"cta-panel",
|
|
924
|
+
"page",
|
|
925
|
+
"page-hero"
|
|
926
|
+
]
|
|
927
|
+
},
|
|
742
928
|
{
|
|
743
929
|
"name": "image-cropper",
|
|
744
930
|
"type": "primitive",
|
|
@@ -793,6 +979,26 @@
|
|
|
793
979
|
],
|
|
794
980
|
"registryDependencies": []
|
|
795
981
|
},
|
|
982
|
+
{
|
|
983
|
+
"name": "landing-page",
|
|
984
|
+
"type": "primitive",
|
|
985
|
+
"title": "Landing page",
|
|
986
|
+
"summary": "A landing page: the promise beside the product alive in a window, a band of proofs, the features as a bento where the main one takes the room, the closing call.",
|
|
987
|
+
"description": "A landing page: the promise beside the product alive in a window, a band of proofs, the features as a bento where the main one takes the room, the closing call.",
|
|
988
|
+
"status": "beta",
|
|
989
|
+
"category": "templates",
|
|
990
|
+
"platforms": "web",
|
|
991
|
+
"examples": {
|
|
992
|
+
"web": 1,
|
|
993
|
+
"native": 0
|
|
994
|
+
},
|
|
995
|
+
"dependencies": [],
|
|
996
|
+
"registryDependencies": [
|
|
997
|
+
"cta-panel",
|
|
998
|
+
"page",
|
|
999
|
+
"section-backdrop"
|
|
1000
|
+
]
|
|
1001
|
+
},
|
|
796
1002
|
{
|
|
797
1003
|
"name": "landscape",
|
|
798
1004
|
"type": "primitive",
|
|
@@ -811,6 +1017,26 @@
|
|
|
811
1017
|
"cn"
|
|
812
1018
|
]
|
|
813
1019
|
},
|
|
1020
|
+
{
|
|
1021
|
+
"name": "legal-page",
|
|
1022
|
+
"type": "primitive",
|
|
1023
|
+
"title": "Legal page",
|
|
1024
|
+
"summary": "A policy or terms: the date in force, the short version in plain words, the sections in a narrow column with their contents beside them.",
|
|
1025
|
+
"description": "A policy or terms: the date in force, the short version in plain words, the sections in a narrow column with their contents beside them.",
|
|
1026
|
+
"status": "beta",
|
|
1027
|
+
"category": "templates",
|
|
1028
|
+
"platforms": "web",
|
|
1029
|
+
"examples": {
|
|
1030
|
+
"web": 1,
|
|
1031
|
+
"native": 0
|
|
1032
|
+
},
|
|
1033
|
+
"dependencies": [],
|
|
1034
|
+
"registryDependencies": [
|
|
1035
|
+
"page",
|
|
1036
|
+
"page-hero",
|
|
1037
|
+
"toc"
|
|
1038
|
+
]
|
|
1039
|
+
},
|
|
814
1040
|
{
|
|
815
1041
|
"name": "link-card",
|
|
816
1042
|
"type": "primitive",
|
|
@@ -829,6 +1055,22 @@
|
|
|
829
1055
|
"cn"
|
|
830
1056
|
]
|
|
831
1057
|
},
|
|
1058
|
+
{
|
|
1059
|
+
"name": "list",
|
|
1060
|
+
"type": "native",
|
|
1061
|
+
"title": "List",
|
|
1062
|
+
"summary": "A long list for React Native on FlashList v2 — separators, skeleton rows, empty and error states, pull to refresh, the next page loaded near the end through useInfiniteQuery of @krizaka/query.",
|
|
1063
|
+
"description": "A long list for React Native on FlashList v2 — separators, skeleton rows, empty and error states, pull to refresh, the next page loaded near the end through useInfiniteQuery of @krizaka/query.",
|
|
1064
|
+
"status": "beta",
|
|
1065
|
+
"category": "data-display",
|
|
1066
|
+
"platforms": "native",
|
|
1067
|
+
"examples": {
|
|
1068
|
+
"web": 0,
|
|
1069
|
+
"native": 3
|
|
1070
|
+
},
|
|
1071
|
+
"dependencies": [],
|
|
1072
|
+
"registryDependencies": []
|
|
1073
|
+
},
|
|
832
1074
|
{
|
|
833
1075
|
"name": "loader",
|
|
834
1076
|
"type": "primitive",
|
|
@@ -849,6 +1091,26 @@
|
|
|
849
1091
|
"spinner"
|
|
850
1092
|
]
|
|
851
1093
|
},
|
|
1094
|
+
{
|
|
1095
|
+
"name": "longform-page",
|
|
1096
|
+
"type": "primitive",
|
|
1097
|
+
"title": "Longform page",
|
|
1098
|
+
"summary": "A long read — a story, an essay, a case: numbered chapters in a reading column, pull quotes in the margin, figures that break out.",
|
|
1099
|
+
"description": "A long read — a story, an essay, a case: numbered chapters in a reading column, pull quotes in the margin, figures that break out.",
|
|
1100
|
+
"status": "beta",
|
|
1101
|
+
"category": "templates",
|
|
1102
|
+
"platforms": "web",
|
|
1103
|
+
"examples": {
|
|
1104
|
+
"web": 1,
|
|
1105
|
+
"native": 0
|
|
1106
|
+
},
|
|
1107
|
+
"dependencies": [],
|
|
1108
|
+
"registryDependencies": [
|
|
1109
|
+
"cn",
|
|
1110
|
+
"page",
|
|
1111
|
+
"page-hero"
|
|
1112
|
+
]
|
|
1113
|
+
},
|
|
852
1114
|
{
|
|
853
1115
|
"name": "marketing-layout",
|
|
854
1116
|
"type": "primitive",
|
|
@@ -928,14 +1190,14 @@
|
|
|
928
1190
|
"name": "mascots",
|
|
929
1191
|
"type": "primitive",
|
|
930
1192
|
"title": "Mascots",
|
|
931
|
-
"summary": "The Krizaka flock:
|
|
932
|
-
"description": "The Krizaka flock:
|
|
1193
|
+
"summary": "The Krizaka flock: seven birds (falcon, owl, duck, flamingo, pigeon, lovebird, crane) in five moods, drawn in the product's brand colours — and the phoenix, the comeback.",
|
|
1194
|
+
"description": "The Krizaka flock: seven birds (falcon, owl, duck, flamingo, pigeon, lovebird, crane) in five moods, drawn in the product's brand colours — and the phoenix, the comeback.",
|
|
933
1195
|
"status": "beta",
|
|
934
1196
|
"category": "feedback",
|
|
935
1197
|
"platforms": "both",
|
|
936
1198
|
"examples": {
|
|
937
|
-
"web":
|
|
938
|
-
"native":
|
|
1199
|
+
"web": 8,
|
|
1200
|
+
"native": 4
|
|
939
1201
|
},
|
|
940
1202
|
"dependencies": [],
|
|
941
1203
|
"registryDependencies": []
|
|
@@ -1124,6 +1386,53 @@
|
|
|
1124
1386
|
"cn"
|
|
1125
1387
|
]
|
|
1126
1388
|
},
|
|
1389
|
+
{
|
|
1390
|
+
"name": "pricing-page",
|
|
1391
|
+
"type": "primitive",
|
|
1392
|
+
"title": "Pricing page",
|
|
1393
|
+
"summary": "Plans and what they cost: the plans side by side with the featured one lifted, the comparison as a table, what a credit buys, the questions people ask.",
|
|
1394
|
+
"description": "Plans and what they cost: the plans side by side with the featured one lifted, the comparison as a table, what a credit buys, the questions people ask.",
|
|
1395
|
+
"status": "beta",
|
|
1396
|
+
"category": "templates",
|
|
1397
|
+
"platforms": "web",
|
|
1398
|
+
"examples": {
|
|
1399
|
+
"web": 1,
|
|
1400
|
+
"native": 0
|
|
1401
|
+
},
|
|
1402
|
+
"dependencies": [],
|
|
1403
|
+
"registryDependencies": [
|
|
1404
|
+
"cn",
|
|
1405
|
+
"page",
|
|
1406
|
+
"page-hero"
|
|
1407
|
+
]
|
|
1408
|
+
},
|
|
1409
|
+
{
|
|
1410
|
+
"name": "product-page",
|
|
1411
|
+
"type": "primitive",
|
|
1412
|
+
"title": "Product page",
|
|
1413
|
+
"summary": "A product's overview in its brand: split hero with facts and the product alive, the traps it removes as compact argument cards, its decisions with their cost, the promise a bird keeps, the closing call.",
|
|
1414
|
+
"description": "A product's overview in its brand: split hero with facts and the product alive, the traps it removes as compact argument cards, its decisions with their cost, the promise a bird keeps, the closing call.",
|
|
1415
|
+
"status": "beta",
|
|
1416
|
+
"category": "templates",
|
|
1417
|
+
"platforms": "web",
|
|
1418
|
+
"examples": {
|
|
1419
|
+
"web": 1,
|
|
1420
|
+
"native": 0
|
|
1421
|
+
},
|
|
1422
|
+
"dependencies": [],
|
|
1423
|
+
"registryDependencies": [
|
|
1424
|
+
"argument-card",
|
|
1425
|
+
"card-grid",
|
|
1426
|
+
"cn",
|
|
1427
|
+
"cta-panel",
|
|
1428
|
+
"decision-list",
|
|
1429
|
+
"mascot-quote",
|
|
1430
|
+
"mascots",
|
|
1431
|
+
"page",
|
|
1432
|
+
"page-hero",
|
|
1433
|
+
"section-backdrop"
|
|
1434
|
+
]
|
|
1435
|
+
},
|
|
1127
1436
|
{
|
|
1128
1437
|
"name": "profile-card",
|
|
1129
1438
|
"type": "primitive",
|
|
@@ -1433,6 +1742,25 @@
|
|
|
1433
1742
|
],
|
|
1434
1743
|
"registryDependencies": []
|
|
1435
1744
|
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "status-page",
|
|
1747
|
+
"type": "primitive",
|
|
1748
|
+
"title": "Status page",
|
|
1749
|
+
"summary": "Where things stand: the overall state in words and colour, each service on its line, the incidents — or, for what is not built yet, its progress and how to hear about it.",
|
|
1750
|
+
"description": "Where things stand: the overall state in words and colour, each service on its line, the incidents — or, for what is not built yet, its progress and how to hear about it.",
|
|
1751
|
+
"status": "beta",
|
|
1752
|
+
"category": "templates",
|
|
1753
|
+
"platforms": "web",
|
|
1754
|
+
"examples": {
|
|
1755
|
+
"web": 2,
|
|
1756
|
+
"native": 0
|
|
1757
|
+
},
|
|
1758
|
+
"dependencies": [],
|
|
1759
|
+
"registryDependencies": [
|
|
1760
|
+
"page",
|
|
1761
|
+
"page-hero"
|
|
1762
|
+
]
|
|
1763
|
+
},
|
|
1436
1764
|
{
|
|
1437
1765
|
"name": "stepper",
|
|
1438
1766
|
"type": "primitive",
|
|
@@ -1657,6 +1985,25 @@
|
|
|
1657
1985
|
"tailwind-variants@^3.3.1"
|
|
1658
1986
|
],
|
|
1659
1987
|
"registryDependencies": []
|
|
1988
|
+
},
|
|
1989
|
+
{
|
|
1990
|
+
"name": "virtual",
|
|
1991
|
+
"type": "primitive",
|
|
1992
|
+
"title": "Virtual",
|
|
1993
|
+
"summary": "Long lists and galleries rendered by what is in view, on TanStack Virtual: a list in its own region or the page's, a grid that fits the width, measured items, the end announced for infinite loading.",
|
|
1994
|
+
"description": "Long lists and galleries rendered by what is in view, on TanStack Virtual: a list in its own region or the page's, a grid that fits the width, measured items, the end announced for infinite loading.",
|
|
1995
|
+
"status": "beta",
|
|
1996
|
+
"category": "data-display",
|
|
1997
|
+
"platforms": "web",
|
|
1998
|
+
"examples": {
|
|
1999
|
+
"web": 3,
|
|
2000
|
+
"native": 0
|
|
2001
|
+
},
|
|
2002
|
+
"dependencies": [
|
|
2003
|
+
"@tanstack/react-virtual@3.14.15",
|
|
2004
|
+
"tailwind-variants@^3.3.1"
|
|
2005
|
+
],
|
|
2006
|
+
"registryDependencies": []
|
|
1660
2007
|
}
|
|
1661
2008
|
]
|
|
1662
2009
|
}
|
package/registry/iso.json
CHANGED
|
@@ -727,7 +727,7 @@
|
|
|
727
727
|
},
|
|
728
728
|
{
|
|
729
729
|
"path": "meta.ts",
|
|
730
|
-
"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 krizaka.com renders as\n// /docs/ui/<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 | \"achievement\"\n | \"action-bar\"\n | \"alert\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"card\"\n | \"card-grid\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"command\"\n | \"confirm-button\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-layout\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"image-cropper\"\n | \"iso\"\n | \"kbd\"\n | \"landscape\"\n | \"link-card\"\n | \"loader\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"media-capture\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"pointer-light\"\n | \"popover\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"radio-group\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"settings-layout\"\n | \"skeleton\"\n | \"slider\"\n | \"slot\"\n | \"spinner\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"stepper\"\n | \"switch\"\n | \"tabs\"\n | \"tag-input\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"txt\"\n | \"video-player\"\n | \"video-trimmer\";\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/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\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 templates.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"layout\" | \"foundations\";\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 */\nexport interface Example {\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 * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n */\n readonly template?: boolean;\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}\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 readonly category: Category;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\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"
|
|
730
|
+
"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 krizaka.com renders as\n// /docs/ui/<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 | \"achievement\"\n | \"action-bar\"\n | \"alert\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"card\"\n | \"card-grid\"\n | \"catalogue-page\"\n | \"changelog-page\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"command\"\n | \"component-page\"\n | \"confirm-button\"\n | \"contact-page\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-article-page\"\n | \"docs-hub-page\"\n | \"docs-layout\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"error-page\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"gallery-page\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"how-it-works-page\"\n | \"image-cropper\"\n | \"iso\"\n | \"kbd\"\n | \"landing-page\"\n | \"landscape\"\n | \"legal-page\"\n | \"link-card\"\n | \"list\"\n | \"loader\"\n | \"longform-page\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"media-capture\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"pointer-light\"\n | \"popover\"\n | \"pricing-page\"\n | \"product-page\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"radio-group\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"settings-layout\"\n | \"skeleton\"\n | \"slider\"\n | \"slot\"\n | \"spinner\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"status-page\"\n | \"stepper\"\n | \"switch\"\n | \"tabs\"\n | \"tag-input\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"txt\"\n | \"video-player\"\n | \"video-trimmer\"\n | \"virtual\";\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/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\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/**\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 */\nexport interface Example {\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 * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n */\n readonly template?: boolean;\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}\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 readonly category: Category;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\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"
|
|
731
731
|
}
|
|
732
732
|
],
|
|
733
733
|
"dependencies": [],
|
package/registry/kbd.json
CHANGED
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
},
|
|
97
97
|
{
|
|
98
98
|
"path": "meta.ts",
|
|
99
|
-
"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 krizaka.com renders as\n// /docs/ui/<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 | \"achievement\"\n | \"action-bar\"\n | \"alert\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"card\"\n | \"card-grid\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"command\"\n | \"confirm-button\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-layout\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"image-cropper\"\n | \"iso\"\n | \"kbd\"\n | \"landscape\"\n | \"link-card\"\n | \"loader\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"media-capture\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"pointer-light\"\n | \"popover\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"radio-group\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"settings-layout\"\n | \"skeleton\"\n | \"slider\"\n | \"slot\"\n | \"spinner\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"stepper\"\n | \"switch\"\n | \"tabs\"\n | \"tag-input\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"txt\"\n | \"video-player\"\n | \"video-trimmer\";\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/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\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 templates.\n */\nexport type Category = \"actions\" | \"forms\" | \"navigation\" | \"overlays\" | \"feedback\" | \"data-display\" | \"media\" | \"blocks\" | \"layouts\" | \"layout\" | \"foundations\";\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 */\nexport interface Example {\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 * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n */\n readonly template?: boolean;\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}\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 readonly category: Category;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\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"
|
|
99
|
+
"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 krizaka.com renders as\n// /docs/ui/<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 | \"achievement\"\n | \"action-bar\"\n | \"alert\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\n | \"auth-layout\"\n | \"avatar\"\n | \"badge\"\n | \"button\"\n | \"card\"\n | \"card-grid\"\n | \"catalogue-page\"\n | \"changelog-page\"\n | \"checkbox\"\n | \"chip\"\n | \"chip-link\"\n | \"choice-grid\"\n | \"cn\"\n | \"code-block\"\n | \"combobox\"\n | \"command\"\n | \"component-page\"\n | \"confirm-button\"\n | \"contact-page\"\n | \"continue-prompt\"\n | \"countdown\"\n | \"cta-panel\"\n | \"dashboard-layout\"\n | \"data-table\"\n | \"date-picker\"\n | \"decision-list\"\n | \"detail-layout\"\n | \"dialog\"\n | \"docs-article-page\"\n | \"docs-hub-page\"\n | \"docs-layout\"\n | \"dropdown-menu\"\n | \"empty-state\"\n | \"error-page\"\n | \"field\"\n | \"file-upload\"\n | \"filter-bar\"\n | \"gallery-page\"\n | \"glow-card\"\n | \"goal-gauge\"\n | \"how-it-works-page\"\n | \"image-cropper\"\n | \"iso\"\n | \"kbd\"\n | \"landing-page\"\n | \"landscape\"\n | \"legal-page\"\n | \"link-card\"\n | \"list\"\n | \"loader\"\n | \"longform-page\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"media-capture\"\n | \"meter\"\n | \"nav-bar\"\n | \"number-ticker\"\n | \"page\"\n | \"page-header\"\n | \"page-hero\"\n | \"pagination\"\n | \"pointer-light\"\n | \"popover\"\n | \"pricing-page\"\n | \"product-page\"\n | \"profile-card\"\n | \"progress\"\n | \"promise-card\"\n | \"radio-group\"\n | \"scroll-stage\"\n | \"search-field\"\n | \"section-backdrop\"\n | \"segmented\"\n | \"separator\"\n | \"settings-layout\"\n | \"skeleton\"\n | \"slider\"\n | \"slot\"\n | \"spinner\"\n | \"split-view\"\n | \"stage-banner\"\n | \"stat\"\n | \"status-page\"\n | \"stepper\"\n | \"switch\"\n | \"tabs\"\n | \"tag-input\"\n | \"terminal-replay\"\n | \"theme\"\n | \"toast\"\n | \"toc\"\n | \"tooltip\"\n | \"txt\"\n | \"video-player\"\n | \"video-trimmer\"\n | \"virtual\";\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/** `stable`: its API only changes in a major. `beta`: it may still change in a minor. */\nexport type Status = \"stable\" | \"beta\";\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/**\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 */\nexport interface Example {\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 * A template: a whole screen of a product composed from the platform (a layout and its blocks, real words, its phone\n * version thought out), copied as a starting point — at most 160 lines, listed on krizaka.com/docs/ui/templates.\n */\n readonly template?: boolean;\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}\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 readonly category: Category;\n /** Must match the sides below: `both` ⇔ `web` and `native`. */\n readonly platforms: Platform;\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"
|
|
100
100
|
}
|
|
101
101
|
],
|
|
102
102
|
"dependencies": [
|