@krizaka/ui 3.62.0 → 3.63.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -16
- package/dist/account-menu.d.ts +1 -1
- package/dist/account-menu.js +1 -1
- package/dist/account-settings.d.ts +1 -1
- package/dist/account-settings.js +2 -2
- package/dist/achievement.d.ts +2 -2
- package/dist/achievement.js +1 -1
- package/dist/achievement.js.map +1 -1
- package/dist/action-bar.js +4 -4
- package/dist/activity-feed.d.ts +1 -1
- package/dist/activity-feed.js.map +1 -1
- package/dist/analysis-report.d.ts +274 -0
- package/dist/analysis-report.js +207 -0
- package/dist/analysis-report.js.map +1 -0
- package/dist/app-shell.js.map +1 -1
- package/dist/argument-card.d.ts +1 -1
- package/dist/argument-card.js +5 -5
- package/dist/auth-layout.d.ts +1 -1
- package/dist/auth-layout.js.map +1 -1
- package/dist/avatar/defaults.d.ts +2 -1
- package/dist/avatar/defaults.js.map +1 -1
- package/dist/{avatar-iajODANU.d.ts → avatar-BL2iG_Js.d.ts} +2 -1
- package/dist/avatar.d.ts +3 -2
- package/dist/avatar.js.map +1 -1
- package/dist/badge.js +4 -34
- package/dist/badge.js.map +1 -1
- package/dist/bird-plate.d.ts +1 -1
- package/dist/bird-plate.js +1 -1
- package/dist/blocks.css +99 -8
- package/dist/button.js +1 -1
- package/dist/captcha.js +1 -1
- package/dist/chat.js +1 -1
- package/dist/choice-grid.d.ts +1 -1
- package/dist/choice-grid.js +1 -1
- package/dist/choice-grid.js.map +1 -1
- package/dist/chunk-5PFCELGW.js +41 -0
- package/dist/chunk-5PFCELGW.js.map +1 -0
- package/dist/chunk-5RWHDX5J.js +37 -0
- package/dist/chunk-5RWHDX5J.js.map +1 -0
- package/dist/{chunk-KB7OLYIJ.js → chunk-7AZ23BUX.js} +1 -1
- package/dist/chunk-7AZ23BUX.js.map +1 -0
- package/dist/{chunk-4E5IUZHR.js → chunk-B2HS5EAH.js} +1 -1
- package/dist/chunk-B2HS5EAH.js.map +1 -0
- package/dist/{chunk-5LANVCK7.js → chunk-BG5APGX6.js} +2 -2
- package/dist/{chunk-WOZP3JLW.js → chunk-DJ5ZPPWL.js} +1 -1
- package/dist/chunk-DJ5ZPPWL.js.map +1 -0
- package/dist/{chunk-MHUUNC5W.js → chunk-DRTIE44Z.js} +1 -1
- package/dist/chunk-DRTIE44Z.js.map +1 -0
- package/dist/{chunk-UV4HBVH7.js → chunk-EB45EVPJ.js} +2 -2
- package/dist/{chunk-SJS6RJIT.js.map → chunk-EB45EVPJ.js.map} +1 -1
- package/dist/{chunk-555LWYIN.js → chunk-EHTXLZSM.js} +1 -1
- package/dist/{chunk-555LWYIN.js.map → chunk-EHTXLZSM.js.map} +1 -1
- package/dist/{chunk-6EAHUURY.js → chunk-GHAN7OOE.js} +2 -2
- package/dist/chunk-JT7ZKZT5.js +1 -0
- package/dist/chunk-JT7ZKZT5.js.map +1 -0
- package/dist/{chunk-3DHNN5V7.js → chunk-M3GEYLMR.js} +2 -2
- package/dist/{chunk-3DHNN5V7.js.map → chunk-M3GEYLMR.js.map} +1 -1
- package/dist/{chunk-7J2L4HOD.js → chunk-MTVX4RRF.js} +2 -2
- package/dist/{chunk-7J2L4HOD.js.map → chunk-MTVX4RRF.js.map} +1 -1
- package/dist/{chunk-YKEIOYJ5.js → chunk-NPMGYLJV.js} +1 -1
- package/dist/chunk-NPMGYLJV.js.map +1 -0
- package/dist/{chunk-3RVFD3UX.js → chunk-PW2FVPTV.js} +1 -1
- package/dist/chunk-PW2FVPTV.js.map +1 -0
- package/dist/{chunk-HEKDKM5Y.js → chunk-QVHSV6RA.js} +1 -1
- package/dist/{chunk-MIMOTE4W.js → chunk-RCHKIOVV.js} +1 -1
- package/dist/chunk-RCHKIOVV.js.map +1 -0
- package/dist/{chunk-7JG3VR4C.js → chunk-RCKXJEDQ.js} +5 -5
- package/dist/{chunk-XVFQZ3ZG.js → chunk-TPITVAUW.js} +1 -1
- package/dist/{chunk-XVFQZ3ZG.js.map → chunk-TPITVAUW.js.map} +1 -1
- package/dist/chunk-U4XTZMB7.js +103 -0
- package/dist/chunk-U4XTZMB7.js.map +1 -0
- package/dist/{chunk-SJS6RJIT.js → chunk-V7W4RLRW.js} +2 -2
- package/dist/{chunk-UV4HBVH7.js.map → chunk-V7W4RLRW.js.map} +1 -1
- package/dist/{chunk-RBETQO2P.js → chunk-Y5YBTHVD.js} +9 -15
- package/dist/chunk-Y5YBTHVD.js.map +1 -0
- package/dist/command.js +2 -2
- package/dist/confirm-button.js +1 -1
- package/dist/continue-prompt.js +2 -2
- package/dist/continue-prompt.js.map +1 -1
- package/dist/cover-hero.js +1 -1
- package/dist/dashboard-layout.js.map +1 -1
- package/dist/data-table.js +2 -2
- package/dist/detail-layout.js.map +1 -1
- package/dist/dialog.js +2 -2
- package/dist/elephant.js.map +1 -1
- package/dist/embed-facade.d.ts +37 -0
- package/dist/embed-facade.js +96 -0
- package/dist/embed-facade.js.map +1 -0
- package/dist/engine-flow.d.ts +4 -4
- package/dist/engine-flow.js.map +1 -1
- package/dist/environment-notice.d.ts +110 -0
- package/dist/environment-notice.js +47 -0
- package/dist/environment-notice.js.map +1 -0
- package/dist/file-upload.d.ts +2 -2
- package/dist/flock.js +1 -1
- package/dist/force-update-screen.js +1 -1
- package/dist/genui.js +2 -2
- package/dist/{geometry-DZ4Q3hDQ.d.ts → geometry-DDlFDtiQ.d.ts} +3 -4
- package/dist/{geometry-DncHaYP8.d.ts → geometry-DuUQyHZ1.d.ts} +3 -4
- package/dist/goal-gauge.d.ts +1 -1
- package/dist/goal-gauge.js +1 -1
- package/dist/goal-gauge.js.map +1 -1
- package/dist/index.d.ts +15 -1
- package/dist/index.js +1 -1
- package/dist/kind-config-editor.js +1 -1
- package/dist/landing-page.d.ts +1 -1
- package/dist/landing-page.js.map +1 -1
- package/dist/language-switch.d.ts +9 -9
- package/dist/link-card.js +2 -2
- package/dist/loader.d.ts +1 -1
- package/dist/loader.js.map +1 -1
- package/dist/maintenance-screen.js +1 -1
- package/dist/map.js +6 -0
- package/dist/map.js.map +1 -1
- package/dist/margin-layout.d.ts +71 -0
- package/dist/margin-layout.js +29 -0
- package/dist/margin-layout.js.map +1 -0
- package/dist/mascot-quote.d.ts +1 -1
- package/dist/mascot-quote.js +1 -1
- package/dist/mascot-state.js +1 -1
- package/dist/mascots.d.ts +2 -2
- package/dist/mascots.js +1 -1
- package/dist/match-dialog.js +2 -2
- package/dist/media-grid.d.ts +1 -0
- package/dist/media-grid.js +2 -2
- package/dist/meter.js +2 -1
- package/dist/native/map.js +6 -0
- package/dist/native/map.js.map +1 -1
- package/dist/native.d.ts +125 -10
- package/dist/native.js +1690 -1517
- package/dist/native.js.map +1 -1
- package/dist/nav-bar.d.ts +1 -1
- package/dist/nav-bar.js +3 -3
- package/dist/page-DPHDmDAQ.d.ts +131 -0
- package/dist/page-hero.js +4 -4
- package/dist/page.d.ts +7 -125
- package/dist/page.js +13 -1
- package/dist/page.js.map +1 -1
- package/dist/product-page.d.ts +1 -1
- package/dist/product-page.js.map +1 -1
- package/dist/profile-card.d.ts +1 -1
- package/dist/profile-card.js +1 -1
- package/dist/profile-card.js.map +1 -1
- package/dist/promise-card.js +1 -1
- package/dist/quota-meter.js +2 -1
- package/dist/quota-meter.js.map +1 -1
- package/dist/rail-nav.d.ts +4 -0
- package/dist/retro-tv.d.ts +6 -3
- package/dist/retro-tv.js +6 -5
- package/dist/retro-tv.js.map +1 -1
- package/dist/reviews.d.ts +49 -0
- package/dist/reviews.js +66 -0
- package/dist/reviews.js.map +1 -0
- package/dist/scroll-stage.d.ts +1 -1
- package/dist/scroll-stage.js +1 -1
- package/dist/scroll-stage.js.map +1 -1
- package/dist/separator.d.ts +26 -3
- package/dist/separator.js +19 -1
- package/dist/separator.js.map +1 -1
- package/dist/service-card.d.ts +56 -63
- package/dist/service-card.js +49 -10
- package/dist/service-card.js.map +1 -1
- package/dist/settings-layout.js +1 -1
- package/dist/site-cahier.d.ts +10 -2
- package/dist/site-cahier.js +9 -15
- package/dist/site-cahier.js.map +1 -1
- package/dist/site-footer.d.ts +1 -1
- package/dist/site-footer.js +2 -2
- package/dist/{sites-BKz1beUK.d.ts → sites-CEnywB89.d.ts} +10 -2
- package/dist/sites.d.ts +13 -5
- package/dist/sites.js +7 -13
- package/dist/sites.js.map +1 -1
- package/dist/specimen-tag.d.ts +15 -3
- package/dist/specimen-tag.js +4 -27
- package/dist/specimen-tag.js.map +1 -1
- package/dist/stage-banner.d.ts +1 -1
- package/dist/stage-banner.js +1 -1
- package/dist/stage-banner.js.map +1 -1
- package/dist/stat.d.ts +87 -5
- package/dist/stat.js +9 -53
- package/dist/stat.js.map +1 -1
- package/dist/status-page.d.ts +1 -1
- package/dist/status-page.js.map +1 -1
- package/dist/sticky-action.d.ts +7 -2
- package/dist/sticky-action.js +24 -3
- package/dist/sticky-action.js.map +1 -1
- package/dist/theme.js +1 -1
- package/dist/update-prompt.js +1 -1
- package/dist/usage.d.ts +229 -0
- package/dist/usage.js +189 -0
- package/dist/usage.js.map +1 -0
- package/dist/versus-card.js +1 -1
- package/dist/vertical-video.js +2 -2
- package/dist/wall.d.ts +24 -12
- package/dist/wall.js +106 -43
- package/dist/wall.js.map +1 -1
- package/package.json +108 -17
- package/registry/account-menu.json +1 -1
- package/registry/account-settings.json +1 -1
- package/registry/achievement.json +8 -8
- package/registry/action-bar.json +1 -1
- package/registry/activity-feed.json +8 -8
- package/registry/agenda.json +1 -1
- package/registry/alert.json +1 -1
- package/registry/analysis-report.json +445 -0
- package/registry/anatomy-plate.json +1 -1
- package/registry/app-header.json +3 -3
- package/registry/app-shell.json +10 -10
- package/registry/argument-card.json +3 -3
- package/registry/audio-player.json +6 -6
- package/registry/auth-layout.json +9 -9
- package/registry/avatar.json +8 -8
- package/registry/badge.json +1 -1
- package/registry/bird-plate.json +1 -1
- package/registry/button.json +2 -2
- package/registry/captcha.json +1 -1
- package/registry/card-grid.json +6 -6
- 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 +3 -3
- 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 +6 -6
- package/registry/code-block.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 +2 -2
- 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 +2 -2
- package/registry/data-table.json +1 -1
- package/registry/date-picker.json +2 -2
- package/registry/decision-list.json +1 -1
- package/registry/description-list.json +1 -1
- package/registry/detail-layout.json +6 -6
- package/registry/dialog.json +1 -1
- package/registry/docs-article-page.json +1 -1
- package/registry/docs-hub-page.json +3 -3
- 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 +7 -7
- package/registry/embed-facade.json +243 -0
- package/registry/empty-state.json +2 -2
- package/registry/engine-flow.json +6 -6
- package/registry/environment-notice.json +270 -0
- package/registry/error-page.json +1 -1
- package/registry/examples/achievement/arcade.js +1 -1
- package/registry/examples/achievement/arcade.tsx +1 -1
- package/registry/examples/activity-feed/job-activity.tsx +1 -1
- package/registry/examples/analysis-report/document-validation.js +47 -0
- package/registry/examples/analysis-report/document-validation.tsx +29 -0
- package/registry/examples/analysis-report/native/document-validation.dark.png +0 -0
- package/registry/examples/analysis-report/native/document-validation.js +48 -0
- package/registry/examples/analysis-report/native/document-validation.light.png +0 -0
- package/registry/examples/analysis-report/native/document-validation.tsx +32 -0
- package/registry/examples/analysis-report/streaming.d.ts +4 -0
- package/registry/examples/analysis-report/streaming.js +42 -0
- package/registry/examples/analysis-report/streaming.tsx +23 -0
- package/registry/examples/app-shell/admin-console.js +1 -1
- package/registry/examples/app-shell/admin-console.tsx +2 -2
- package/registry/examples/app-shell/basic.js +1 -1
- package/registry/examples/app-shell/basic.tsx +1 -1
- package/registry/examples/app-shell/creator-studio.d.ts +4 -0
- package/registry/examples/app-shell/{orochia-studio.js → creator-studio.js} +6 -6
- package/registry/examples/app-shell/{orochia-studio.tsx → creator-studio.tsx} +4 -4
- package/registry/examples/audio-player/podcast.js +1 -1
- package/registry/examples/audio-player/podcast.tsx +1 -1
- package/registry/examples/audio-player/voice-note.js +1 -1
- package/registry/examples/audio-player/voice-note.tsx +1 -1
- package/registry/examples/auth-layout/onboarding.js +3 -3
- package/registry/examples/auth-layout/onboarding.tsx +3 -3
- package/registry/examples/auth-layout/sign-in.js +3 -3
- package/registry/examples/auth-layout/sign-in.tsx +3 -3
- package/registry/examples/avatar/default.js +1 -1
- package/registry/examples/avatar/default.tsx +1 -1
- package/registry/examples/card-grid/aligned.js +2 -2
- package/registry/examples/card-grid/aligned.tsx +2 -2
- package/registry/examples/card-grid/foundation.js +1 -2
- package/registry/examples/card-grid/foundation.tsx +1 -2
- package/registry/examples/card-grid/hover-quiet.js +1 -1
- package/registry/examples/card-grid/hover-quiet.tsx +1 -1
- package/registry/examples/card-grid/products.js +1 -1
- package/registry/examples/card-grid/products.tsx +1 -1
- package/registry/examples/choice-grid/line-up.js +1 -1
- package/registry/examples/choice-grid/line-up.tsx +1 -1
- package/registry/examples/detail-layout/checkout.js +1 -1
- package/registry/examples/detail-layout/checkout.tsx +2 -2
- package/registry/examples/detail-layout/video.js +1 -1
- package/registry/examples/detail-layout/video.tsx +2 -2
- package/registry/examples/docs-hub-page/krizaka.js +1 -1
- package/registry/examples/docs-hub-page/krizaka.tsx +1 -1
- package/registry/examples/embed-facade/tiktok.d.ts +4 -0
- package/registry/examples/embed-facade/tiktok.js +20 -0
- package/registry/examples/embed-facade/tiktok.tsx +16 -0
- package/registry/examples/embed-facade/youtube.d.ts +4 -0
- package/registry/examples/embed-facade/youtube.js +22 -0
- package/registry/examples/embed-facade/youtube.tsx +20 -0
- package/registry/examples/empty-state/library.js +1 -1
- package/registry/examples/empty-state/library.tsx +1 -1
- package/registry/examples/engine-flow/calm.js +1 -1
- package/registry/examples/engine-flow/calm.tsx +1 -1
- package/registry/examples/engine-flow/compact.js +4 -4
- package/registry/examples/engine-flow/compact.tsx +4 -4
- package/registry/examples/engine-flow/radial.js +2 -6
- package/registry/examples/engine-flow/radial.tsx +1 -5
- package/registry/examples/environment-notice/development.d.ts +4 -0
- package/registry/examples/environment-notice/development.js +15 -0
- package/registry/examples/environment-notice/development.tsx +13 -0
- package/registry/examples/environment-notice/native/development.d.ts +4 -0
- package/registry/examples/environment-notice/native/development.dark.png +0 -0
- package/registry/examples/environment-notice/native/development.js +21 -0
- package/registry/examples/environment-notice/native/development.light.png +0 -0
- package/registry/examples/environment-notice/native/development.tsx +17 -0
- package/registry/examples/environment-notice/staging.d.ts +4 -0
- package/registry/examples/environment-notice/staging.js +11 -0
- package/registry/examples/environment-notice/staging.tsx +6 -0
- package/registry/examples/force-update-screen/default.js +1 -1
- package/registry/examples/force-update-screen/default.tsx +1 -1
- package/registry/examples/force-update-screen/native/default.dark.png +0 -0
- package/registry/examples/force-update-screen/native/default.js +1 -1
- package/registry/examples/force-update-screen/native/default.light.png +0 -0
- package/registry/examples/force-update-screen/native/default.tsx +1 -1
- package/registry/examples/form/native/sign-up.js +2 -2
- package/registry/examples/form/native/sign-up.tsx +2 -2
- package/registry/examples/form/sign-up.js +1 -1
- package/registry/examples/form/sign-up.tsx +3 -3
- package/registry/examples/goal-gauge/arcade.js +1 -1
- package/registry/examples/goal-gauge/arcade.tsx +1 -1
- package/registry/examples/image-cropper/avatar.js +1 -1
- package/registry/examples/image-cropper/avatar.tsx +1 -1
- package/registry/examples/image-cropper/banner.js +1 -1
- package/registry/examples/image-cropper/banner.tsx +1 -1
- package/registry/examples/image-cropper/vertical-video.js +1 -2
- package/registry/examples/image-cropper/vertical-video.tsx +1 -3
- package/registry/examples/iso/creator-hero.d.ts +4 -0
- package/registry/examples/iso/{orochia-hero.js → creator-hero.js} +3 -3
- package/registry/examples/iso/{orochia-hero.tsx → creator-hero.tsx} +1 -1
- package/registry/examples/landing-page/krizaka.js +2 -2
- package/registry/examples/landing-page/krizaka.tsx +2 -2
- package/registry/examples/link-card/docs-hub.js +1 -1
- package/registry/examples/link-card/docs-hub.tsx +1 -1
- package/registry/examples/link-card/hover-quiet.js +1 -1
- package/registry/examples/link-card/hover-quiet.tsx +1 -1
- package/registry/examples/loader/branded.js +2 -2
- package/registry/examples/loader/branded.tsx +3 -3
- package/registry/examples/loader/native/branded.dark.png +0 -0
- package/registry/examples/loader/native/branded.js +1 -1
- package/registry/examples/loader/native/branded.light.png +0 -0
- package/registry/examples/loader/native/branded.tsx +2 -2
- package/registry/examples/longform-page/story.js +3 -3
- package/registry/examples/longform-page/story.tsx +3 -3
- package/registry/examples/margin-layout/findings.d.ts +4 -0
- package/registry/examples/margin-layout/findings.js +15 -0
- package/registry/examples/margin-layout/findings.tsx +18 -0
- package/registry/examples/margin-layout/steps.d.ts +4 -0
- package/registry/examples/margin-layout/steps.js +15 -0
- package/registry/examples/margin-layout/steps.tsx +16 -0
- package/registry/examples/marketing-layout/docs-hub.js +1 -1
- package/registry/examples/marketing-layout/docs-hub.tsx +1 -1
- package/registry/examples/mascots/flock.tsx +2 -2
- package/registry/examples/nav-bar/family-admin.js +5 -5
- package/registry/examples/nav-bar/family-admin.tsx +4 -4
- package/registry/examples/nav-bar/site.js +1 -1
- package/registry/examples/nav-bar/site.tsx +1 -1
- package/registry/examples/page/kraft.d.ts +4 -0
- package/registry/examples/page/kraft.js +14 -0
- package/registry/examples/page/kraft.tsx +12 -0
- package/registry/examples/page/papers.d.ts +4 -0
- package/registry/examples/page/papers.js +14 -0
- package/registry/examples/page/papers.tsx +13 -0
- package/registry/examples/permission-prompt/native/blocked.dark.png +0 -0
- package/registry/examples/permission-prompt/native/blocked.js +1 -1
- package/registry/examples/permission-prompt/native/blocked.tsx +1 -1
- package/registry/examples/permission-prompt/native/camera.dark.png +0 -0
- package/registry/examples/permission-prompt/native/camera.js +1 -1
- package/registry/examples/permission-prompt/native/camera.light.png +0 -0
- package/registry/examples/permission-prompt/native/camera.tsx +1 -1
- package/registry/examples/profile-card/match.js +1 -1
- package/registry/examples/profile-card/match.tsx +1 -1
- package/registry/examples/promise-card/arcade.js +1 -1
- package/registry/examples/promise-card/arcade.tsx +1 -1
- package/registry/examples/pull-to-refresh/native/branded.dark.png +0 -0
- package/registry/examples/pull-to-refresh/native/branded.js +1 -1
- package/registry/examples/pull-to-refresh/native/branded.light.png +0 -0
- package/registry/examples/pull-to-refresh/native/branded.tsx +1 -1
- package/registry/examples/rail-nav/expandable.js +3 -3
- package/registry/examples/rail-nav/expandable.tsx +3 -3
- package/registry/examples/retro-tv/cabinet.js +1 -2
- package/registry/examples/retro-tv/cabinet.tsx +1 -3
- package/registry/examples/retro-tv/facade.d.ts +4 -0
- package/registry/examples/retro-tv/facade.js +12 -0
- package/registry/examples/retro-tv/facade.tsx +13 -0
- package/registry/examples/retro-tv/portable.js +1 -2
- package/registry/examples/retro-tv/portable.tsx +1 -3
- package/registry/examples/reviews/card.d.ts +4 -0
- package/registry/examples/reviews/card.js +23 -0
- package/registry/examples/reviews/card.tsx +19 -0
- package/registry/examples/reviews/summary.d.ts +4 -0
- package/registry/examples/reviews/summary.js +23 -0
- package/registry/examples/reviews/summary.tsx +17 -0
- package/registry/examples/scroll-stage/arcade.js +1 -1
- package/registry/examples/scroll-stage/arcade.tsx +1 -1
- package/registry/examples/search-field/global.js +1 -1
- package/registry/examples/search-field/global.tsx +1 -1
- package/registry/examples/separator/hand.d.ts +4 -0
- package/registry/examples/separator/hand.js +19 -0
- package/registry/examples/separator/hand.tsx +16 -0
- package/registry/examples/service-card/index-card.d.ts +4 -0
- package/registry/examples/service-card/index-card.js +15 -0
- package/registry/examples/service-card/index-card.tsx +12 -0
- package/registry/examples/service-card/index-list.d.ts +4 -0
- package/registry/examples/service-card/index-list.js +14 -0
- package/registry/examples/service-card/index-list.tsx +11 -0
- package/registry/examples/sites/french.js +1 -1
- package/registry/examples/sites/french.tsx +1 -1
- package/registry/examples/specimen-tag/facts.d.ts +4 -0
- package/registry/examples/specimen-tag/facts.js +23 -0
- package/registry/examples/specimen-tag/facts.tsx +18 -0
- package/registry/examples/specimen-tag/wire.js +2 -2
- package/registry/examples/specimen-tag/wire.tsx +2 -2
- package/registry/examples/splash-handoff/native/default.dark.png +0 -0
- package/registry/examples/splash-handoff/native/default.js +1 -1
- package/registry/examples/splash-handoff/native/default.light.png +0 -0
- package/registry/examples/splash-handoff/native/default.tsx +1 -1
- package/registry/examples/split-view/messages.tsx +1 -1
- package/registry/examples/split-view/notifications.js +1 -1
- package/registry/examples/split-view/notifications.tsx +1 -1
- package/registry/examples/stat/strip.d.ts +4 -0
- package/registry/examples/stat/strip.js +25 -0
- package/registry/examples/stat/strip.tsx +25 -0
- package/registry/examples/status-page/building.js +2 -2
- package/registry/examples/status-page/building.tsx +2 -2
- package/registry/examples/status-page/operational.js +1 -1
- package/registry/examples/status-page/operational.tsx +1 -1
- package/registry/examples/sticky-action/hide-while-visible.d.ts +4 -0
- package/registry/examples/sticky-action/hide-while-visible.js +16 -0
- package/registry/examples/sticky-action/hide-while-visible.tsx +17 -0
- package/registry/examples/tab-bar/native/main-sections.tsx +1 -1
- package/registry/examples/tree-view/docs.js +1 -1
- package/registry/examples/tree-view/docs.tsx +1 -1
- package/registry/examples/usage/credits-page.d.ts +4 -0
- package/registry/examples/usage/credits-page.js +45 -0
- package/registry/examples/usage/credits-page.tsx +40 -0
- package/registry/examples/usage/empty.d.ts +4 -0
- package/registry/examples/usage/empty.js +15 -0
- package/registry/examples/usage/empty.tsx +12 -0
- package/registry/examples/video-player/default.js +1 -2
- package/registry/examples/video-player/default.tsx +1 -3
- package/registry/examples/video-player/gated.js +2 -3
- package/registry/examples/video-player/gated.tsx +2 -4
- package/registry/examples/video-player/native/default.dark.png +0 -0
- package/registry/examples/video-player/native/default.js +3 -3
- package/registry/examples/video-player/native/default.light.png +0 -0
- package/registry/examples/video-player/native/default.tsx +3 -3
- package/registry/examples/video-player/signed-source.js +2 -3
- package/registry/examples/video-player/signed-source.tsx +2 -4
- package/registry/examples/video-player/vertical.js +1 -2
- package/registry/examples/video-player/vertical.tsx +1 -3
- package/registry/examples/video-trimmer/filmstrip.js +10 -2
- package/registry/examples/video-trimmer/filmstrip.tsx +11 -2
- package/registry/examples/video-trimmer/playhead.js +8 -1
- package/registry/examples/video-trimmer/playhead.tsx +9 -1
- package/registry/examples/wall/brick.js +1 -1
- package/registry/examples/wall/brick.tsx +1 -1
- package/registry/examples/wall/composition-fr.js +1 -1
- package/registry/examples/wall/composition-fr.tsx +1 -1
- package/registry/examples/wall/composition.js +1 -1
- package/registry/examples/wall/composition.tsx +1 -1
- package/registry/examples/wall/pinned-note.js +2 -2
- package/registry/examples/wall/pinned-note.tsx +3 -2
- package/registry/examples/wall/plaster.js +1 -1
- package/registry/examples/wall/plaster.tsx +1 -1
- package/registry/examples/wall/ridge.js +1 -1
- package/registry/examples/wall/ridge.tsx +1 -1
- package/registry/examples/wall/shop-sign.js +5 -4
- package/registry/examples/wall/shop-sign.tsx +7 -4
- package/registry/examples/wall/zellige.js +1 -1
- package/registry/examples/wall/zellige.tsx +1 -1
- package/registry/field.json +1 -1
- package/registry/file-upload.json +2 -2
- 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 +4 -4
- package/registry/form.json +7 -7
- package/registry/gallery-page.json +1 -1
- package/registry/genui.json +2 -2
- 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 +6 -6
- package/registry/grade-stamp.json +1 -1
- package/registry/how-it-works-page.json +1 -1
- package/registry/image-cropper.json +5 -5
- package/registry/index.json +231 -35
- package/registry/iso.json +7 -7
- package/registry/kanban.json +3 -3
- package/registry/kbd.json +1 -1
- package/registry/kind-config-editor.json +1 -1
- package/registry/kpi-explained.json +2 -2
- package/registry/landing-page.json +6 -6
- 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 +4 -4
- package/registry/list.json +3 -3
- package/registry/loader.json +11 -11
- package/registry/longform-page.json +3 -3
- package/registry/maintenance-screen.json +1 -1
- package/registry/map.json +2 -2
- package/registry/margin-layout.json +200 -0
- package/registry/markdown.json +1 -1
- package/registry/marketing-layout.json +2 -2
- package/registry/marquee.json +1 -1
- package/registry/mascot-quote.json +1 -1
- package/registry/mascot-state.json +1 -1
- package/registry/mascots.json +5 -5
- package/registry/match-dialog.json +1 -1
- package/registry/media-capture.json +1 -1
- package/registry/media-gallery.json +1 -1
- package/registry/media-grid.json +3 -3
- package/registry/meta-row.json +1 -1
- package/registry/meter.json +1 -1
- package/registry/nav-bar.json +9 -9
- package/registry/next-actions.json +1 -1
- package/registry/notification-preferences.json +3 -3
- package/registry/number-ticker.json +1 -1
- package/registry/onboarding.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 +53 -11
- package/registry/pagination.json +1 -1
- package/registry/permission-prompt.json +3 -3
- package/registry/photo-grid.json +1 -1
- package/registry/pointer-light.json +1 -1
- package/registry/popover.json +1 -1
- package/registry/pricing-page.json +1 -1
- package/registry/product-page.json +6 -6
- package/registry/profile-card.json +7 -7
- package/registry/progress.json +1 -1
- package/registry/promise-card.json +3 -3
- package/registry/pull-to-refresh.json +2 -2
- package/registry/quota-meter.json +1 -1
- package/registry/radio-group.json +1 -1
- package/registry/rail-nav.json +10 -10
- package/registry/recipes.json +1 -1
- package/registry/retro-tv.json +48 -32
- package/registry/reviews.json +361 -0
- package/registry/router.json +1 -1
- package/registry/scroll-stage.json +6 -6
- package/registry/search-field.json +3 -3
- package/registry/section-backdrop.json +1 -1
- package/registry/separator.json +71 -6
- package/registry/service-card.json +55 -6
- package/registry/settings-layout.json +1 -1
- package/registry/showcase.json +1 -1
- package/registry/signature.json +1 -1
- package/registry/site-cahier.json +1 -1
- package/registry/site-footer.json +7 -7
- package/registry/sites.json +4 -4
- 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 +58 -6
- package/registry/speed-lines.json +1 -1
- package/registry/spinner.json +1 -1
- package/registry/splash-handoff.json +4 -4
- package/registry/split-view.json +4 -4
- package/registry/stage-banner.json +10 -6
- package/registry/stat.json +62 -10
- package/registry/status-chip.json +1 -1
- package/registry/status-page.json +9 -9
- 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 +27 -4
- package/registry/stuck.json +1 -1
- package/registry/swipe-deck.json +1 -1
- package/registry/switch.json +1 -1
- package/registry/tab-bar.json +2 -2
- 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 +3 -3
- package/registry/update-prompt.json +1 -1
- package/registry/upload-queue.json +1 -1
- package/registry/usage.json +542 -0
- package/registry/verified-badge.json +1 -1
- package/registry/versus-card.json +1 -1
- package/registry/vertical-video.json +4 -4
- package/registry/video-player.json +7 -7
- package/registry/video-trimmer.json +8 -8
- package/registry/virtual.json +1 -1
- package/registry/wall.json +128 -40
- package/registry/waveform.json +1 -1
- package/skills/form/SKILL.md +1 -1
- package/skills/map/SKILL.md +2 -2
- package/dist/chunk-3RVFD3UX.js.map +0 -1
- package/dist/chunk-4E5IUZHR.js.map +0 -1
- package/dist/chunk-KB7OLYIJ.js.map +0 -1
- package/dist/chunk-MHUUNC5W.js.map +0 -1
- package/dist/chunk-MIMOTE4W.js.map +0 -1
- package/dist/chunk-RBETQO2P.js.map +0 -1
- package/dist/chunk-WOZP3JLW.js.map +0 -1
- package/dist/chunk-YKEIOYJ5.js.map +0 -1
- /package/dist/{chunk-5LANVCK7.js.map → chunk-BG5APGX6.js.map} +0 -0
- /package/dist/{chunk-6EAHUURY.js.map → chunk-GHAN7OOE.js.map} +0 -0
- /package/dist/{chunk-HEKDKM5Y.js.map → chunk-QVHSV6RA.js.map} +0 -0
- /package/dist/{chunk-7JG3VR4C.js.map → chunk-RCKXJEDQ.js.map} +0 -0
- /package/registry/examples/{app-shell/orochia-studio.d.ts → analysis-report/document-validation.d.ts} +0 -0
- /package/registry/examples/{iso/orochia-hero.d.ts → analysis-report/native/document-validation.d.ts} +0 -0
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "embed-facade",
|
|
3
|
+
"type": "primitive",
|
|
4
|
+
"title": "Embed facade",
|
|
5
|
+
"summary": "A platform's short video (TikTok, YouTube Shorts, Instagram) behind a button: until the visitor asks, no frame, no script and no platform picture is requested — the frame is added on the click, sandboxed.",
|
|
6
|
+
"description": "A platform's short video (TikTok, YouTube Shorts, Instagram) behind a button: until the visitor asks, no frame, no script and no platform picture is requested — the frame is added on the click, sandboxed.",
|
|
7
|
+
"status": "beta",
|
|
8
|
+
"deprecated": null,
|
|
9
|
+
"category": "media",
|
|
10
|
+
"platforms": "web",
|
|
11
|
+
"parity": {
|
|
12
|
+
"web": {
|
|
13
|
+
"state": "yes"
|
|
14
|
+
},
|
|
15
|
+
"native": {
|
|
16
|
+
"state": "n/a",
|
|
17
|
+
"reason": "A web page's embed; a native app opens the platform's own app or a link.",
|
|
18
|
+
"use": "video-player"
|
|
19
|
+
},
|
|
20
|
+
"desktop": {
|
|
21
|
+
"state": "yes"
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"whenToUse": [
|
|
25
|
+
"A shop or a profile that shows its latest reel from a platform, where privacy law (Québec's Law 25) wants consent before anything third-party loads.",
|
|
26
|
+
"Inside a `RetroTv`, as the television's screen."
|
|
27
|
+
],
|
|
28
|
+
"whenNotToUse": [
|
|
29
|
+
{
|
|
30
|
+
"when": "A video you host yourself: no facade is needed.",
|
|
31
|
+
"use": "video-player"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"when": "A plain link to a profile: an anchor with rel=\"noopener noreferrer\" loads nothing.",
|
|
35
|
+
"use": "chip-link"
|
|
36
|
+
}
|
|
37
|
+
],
|
|
38
|
+
"bestPractices": [
|
|
39
|
+
"Validate the address when the owner saves it, with the same `embedUrl(platform, url)` the page uses: it returns the frame's address, or `null` for another host, `http:`, a short link or a profile.",
|
|
40
|
+
"Give a `poster` that is your own copy (your storage or CDN). A poster on a platform's domain (ytimg, tiktokcdn, cdninstagram…) is refused: it would be a request before the click.",
|
|
41
|
+
"`playLabel` names the platform it loads (« Load TikTok and play ») and `notice` says what the platform receives; both are translated by the host.",
|
|
42
|
+
"The frame needs the host's Content-Security-Policy to allow `frame-src` for the three platforms; nothing else is loaded.",
|
|
43
|
+
"Inside a television's screen it fills its parent; alone, it takes `aspectRatio` (9 / 16 by default)."
|
|
44
|
+
],
|
|
45
|
+
"accessibility": {
|
|
46
|
+
"keyboard": [
|
|
47
|
+
{
|
|
48
|
+
"keys": "Tab, Enter / Space",
|
|
49
|
+
"action": "Reaches the one button and loads the video; focus moves to the frame."
|
|
50
|
+
}
|
|
51
|
+
],
|
|
52
|
+
"notes": [
|
|
53
|
+
"A group named by `title`, one native button (44 px at least) that says the platform; the frame carries the same title.",
|
|
54
|
+
"The poster is decorative (empty alt). No motion, so nothing changes under reduced motion."
|
|
55
|
+
]
|
|
56
|
+
},
|
|
57
|
+
"related": [
|
|
58
|
+
"retro-tv",
|
|
59
|
+
"video-player",
|
|
60
|
+
"vertical-video"
|
|
61
|
+
],
|
|
62
|
+
"web": {
|
|
63
|
+
"entry": "@krizaka/ui/embed-facade",
|
|
64
|
+
"import": "import { EmbedFacade, embedUrl, isOwnPoster, EMBED_PLATFORMS } from \"@krizaka/ui/embed-facade\";",
|
|
65
|
+
"props": [
|
|
66
|
+
{
|
|
67
|
+
"component": "EmbedFacade",
|
|
68
|
+
"description": "A short video from a platform, behind a button: the frame exists only after the click.",
|
|
69
|
+
"props": [
|
|
70
|
+
{
|
|
71
|
+
"name": "platform",
|
|
72
|
+
"type": "EmbedPlatform",
|
|
73
|
+
"default": null,
|
|
74
|
+
"description": "Which platform's frame to load.",
|
|
75
|
+
"required": true
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "playLabel",
|
|
79
|
+
"type": "string",
|
|
80
|
+
"default": null,
|
|
81
|
+
"description": "The button: what it does and which platform it loads (\"Load TikTok and play\"), passed translated.",
|
|
82
|
+
"required": true
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "title",
|
|
86
|
+
"type": "string",
|
|
87
|
+
"default": null,
|
|
88
|
+
"description": "The accessible name of the video (\"Latest reel\"), passed translated: it names the frame once loaded.",
|
|
89
|
+
"required": true
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "url",
|
|
93
|
+
"type": "string",
|
|
94
|
+
"default": null,
|
|
95
|
+
"description": "The public address of the post (`embedUrl` validates it; anything else renders nothing).",
|
|
96
|
+
"required": true
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "aspectRatio",
|
|
100
|
+
"type": "string",
|
|
101
|
+
"default": "9 / 16",
|
|
102
|
+
"description": "The ratio of the box when it stands alone; inside a television's screen it fills its parent.",
|
|
103
|
+
"required": false
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "notice",
|
|
107
|
+
"type": "ReactNode",
|
|
108
|
+
"default": null,
|
|
109
|
+
"description": "A line under the button, for what the platform will receive on the click (translated).",
|
|
110
|
+
"required": false
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "onLoad",
|
|
114
|
+
"type": "(() => void)",
|
|
115
|
+
"default": null,
|
|
116
|
+
"description": "Called once, when the visitor has asked and the frame is added.",
|
|
117
|
+
"required": false
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "poster",
|
|
121
|
+
"type": "string",
|
|
122
|
+
"default": null,
|
|
123
|
+
"description": "The host's own copy of the picture (never an address on the platform: those are refused, they would be a request).",
|
|
124
|
+
"required": false
|
|
125
|
+
}
|
|
126
|
+
]
|
|
127
|
+
}
|
|
128
|
+
],
|
|
129
|
+
"examples": [
|
|
130
|
+
{
|
|
131
|
+
"name": "youtube",
|
|
132
|
+
"title": "YouTube Shorts",
|
|
133
|
+
"description": "The gate with the host's own poster and a notice; the frame appears on the click.",
|
|
134
|
+
"path": "examples/embed-facade/youtube.tsx",
|
|
135
|
+
"module": "@krizaka/ui/registry/examples/embed-facade/youtube",
|
|
136
|
+
"code": "import { EmbedFacade } from \"@krizaka/ui/embed-facade\";\n\n// Nothing is requested from YouTube until the visitor presses the button. The poster is the host's own copy (here inline;\n// in an app, a picture of your own storage or CDN).\nconst POSTER = `data:image/svg+xml,${encodeURIComponent('<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 9 16\"><rect width=\"9\" height=\"16\" fill=\"#9fb8cc\"/><path d=\"m0 16 4-8 2 4 1.5-2L9 16Z\" fill=\"#2c5f8a\"/></svg>')}`;\n\nexport default function EmbedFacadeYoutube() {\n return (\n <div className=\"w-64 max-w-full\">\n <EmbedFacade\n platform=\"youtube-shorts\"\n url=\"https://www.youtube.com/shorts/abcDEF_-123\"\n title=\"Latest reel\"\n playLabel=\"Load YouTube and play\"\n poster={POSTER}\n notice=\"YouTube will receive your visit when you press play.\"\n />\n </div>\n );\n}\n"
|
|
137
|
+
},
|
|
138
|
+
{
|
|
139
|
+
"name": "tiktok",
|
|
140
|
+
"title": "TikTok, in French",
|
|
141
|
+
"description": "The same facade without a poster; every word is the host's.",
|
|
142
|
+
"path": "examples/embed-facade/tiktok.tsx",
|
|
143
|
+
"module": "@krizaka/ui/registry/examples/embed-facade/tiktok",
|
|
144
|
+
"code": "import { EmbedFacade } from \"@krizaka/ui/embed-facade\";\n\n// TikTok, in French: the words are the host's. Without a poster the gate is plain paper.\nexport default function EmbedFacadeTiktok() {\n return (\n <div className=\"w-64 max-w-full\">\n <EmbedFacade\n platform=\"tiktok\"\n url=\"https://www.tiktok.com/@cedre.ciseaux/video/7301234567890123456\"\n title=\"Dernier reel du salon\"\n playLabel=\"Charger TikTok et lire\"\n notice=\"TikTok saura que vous avez ouvert cette vidéo.\"\n />\n </div>\n );\n}\n"
|
|
145
|
+
}
|
|
146
|
+
]
|
|
147
|
+
},
|
|
148
|
+
"native": null,
|
|
149
|
+
"files": [
|
|
150
|
+
{
|
|
151
|
+
"path": "embed-facade/embed-facade.tsx",
|
|
152
|
+
"content": "\"use client\";\n\n// A click-to-load facade for a platform's short video (krizaka-ui#605, the lite-youtube-embed pattern). Until the visitor\n// asks, nothing is requested from TikTok, YouTube or Instagram: no frame, no script, no platform picture. The poster is the\n// host's own copy. After the click: one frame, a minimal sandbox and permissions. Loi 25: no third-party tracker without consent.\nimport * as React from \"react\";\n\nimport { cn } from \"../cn\";\nimport { EMBED_PLATFORMS, type EmbedPlatform, embedUrl, isOwnPoster } from \"./embed-url\";\n\nexport interface EmbedFacadeProps extends Omit<React.ComponentProps<\"div\">, \"title\" | \"children\" | \"onLoad\"> {\n /** Which platform's frame to load. */\n platform: EmbedPlatform;\n /** The public address of the post (`embedUrl` validates it; anything else renders nothing). */\n url: string;\n /** The accessible name of the video (\"Latest reel\"), passed translated: it names the frame once loaded. */\n title: string;\n /** The button: what it does and which platform it loads (\"Load TikTok and play\"), passed translated. */\n playLabel: string;\n /** The host's own copy of the picture (never an address on the platform: those are refused, they would be a request). */\n poster?: string;\n /** A line under the button, for what the platform will receive on the click (translated). */\n notice?: React.ReactNode;\n /** The ratio of the box when it stands alone; inside a television's screen it fills its parent. @default \"9 / 16\" */\n aspectRatio?: string;\n /** Called once, when the visitor has asked and the frame is added. */\n onLoad?: () => void;\n}\n\nconst SANDBOX = \"allow-scripts allow-same-origin allow-presentation allow-popups allow-popups-to-escape-sandbox\";\n\n/** A short video from a platform, behind a button: the frame exists only after the click. */\nexport function EmbedFacade({ platform, url, title, playLabel, poster, notice, aspectRatio = \"9 / 16\", onLoad, className, style, ...props }: EmbedFacadeProps) {\n const frame = embedUrl(platform, url);\n const [loaded, setLoaded] = React.useState(false);\n const ref = React.useRef<HTMLIFrameElement>(null);\n React.useEffect(() => {\n if (loaded) ref.current?.focus();\n }, [loaded]);\n if (!frame) return null;\n const load = () => {\n setLoaded(true);\n onLoad?.();\n };\n return (\n <div\n role=\"group\"\n aria-label={title}\n className={cn(\"kz-embed\", className)}\n data-platform={platform}\n data-loaded={loaded ? \"\" : undefined}\n style={{ ...style, [\"--kz-embed-ratio\" as string]: aspectRatio }}\n {...props}\n >\n {loaded ? (\n <iframe ref={ref} src={frame} title={title} sandbox={SANDBOX} allow=\"fullscreen; encrypted-media\" allowFullScreen referrerPolicy=\"strict-origin-when-cross-origin\" className=\"kz-embed-frame\" />\n ) : (\n <>\n {poster && isOwnPoster(poster) && <img src={poster} alt=\"\" loading=\"lazy\" decoding=\"async\" referrerPolicy=\"no-referrer\" className=\"kz-embed-poster\" />}\n <div className=\"kz-embed-gate\">\n <button type=\"button\" onClick={load} className=\"kz-embed-play\" data-platform-name={EMBED_PLATFORMS[platform]}>\n <svg aria-hidden=\"true\" focusable=\"false\" viewBox=\"0 0 16 16\" width=\"16\" height=\"16\"><path d=\"M4 2.5v11l9-5.5Z\" fill=\"currentColor\" /></svg>\n <span>{playLabel}</span>\n </button>\n {notice && <p className=\"kz-embed-notice\">{notice}</p>}\n </div>\n </>\n )}\n </div>\n );\n}\n"
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"path": "embed-facade/embed-url.ts",
|
|
156
|
+
"content": "// The pure part of the facade (krizaka-ui#605): which addresses may ever be embedded, and what the frame's address is.\n// Nothing here touches the network or the DOM, so a server (the shop's editor) can validate with the same function the page uses.\n\n/** The platforms a facade can load after a click. */\nexport type EmbedPlatform = \"tiktok\" | \"youtube-shorts\" | \"instagram\";\n\n/** The platforms' names, as proper nouns (they are not translated). */\nexport const EMBED_PLATFORMS: Readonly<Record<EmbedPlatform, string>> = Object.freeze({ tiktok: \"TikTok\", \"youtube-shorts\": \"YouTube Shorts\", instagram: \"Instagram\" });\n\nconst TIKTOK_HOSTS = new Set([\"tiktok.com\", \"www.tiktok.com\"]);\nconst YOUTUBE_HOSTS = new Set([\"youtube.com\", \"www.youtube.com\", \"m.youtube.com\"]);\nconst INSTAGRAM_HOSTS = new Set([\"instagram.com\", \"www.instagram.com\"]);\n\n/** Every host a platform's frame or picture lives on: a poster served from one of them would be a request before the click. */\nconst PLATFORM_DOMAINS = [\"tiktok.com\", \"tiktokcdn.com\", \"tiktokcdn-us.com\", \"youtube.com\", \"youtu.be\", \"youtube-nocookie.com\", \"ytimg.com\", \"googlevideo.com\", \"instagram.com\", \"cdninstagram.com\", \"fbcdn.net\", \"facebook.com\"];\n\nfunction parse(url: string): URL | null {\n try {\n const u = new URL(url);\n // https only, no credentials, no port: the address is a public post, nothing else.\n if (u.protocol !== \"https:\" || u.username || u.password || u.port) return null;\n return u;\n } catch {\n return null;\n }\n}\n\nconst tiktok = (host: string, path: string): string | null => {\n const id = TIKTOK_HOSTS.has(host) ? /^\\/@[\\w.-]{1,64}\\/video\\/(\\d{8,25})\\/?$/.exec(path)?.[1] : undefined;\n return id ? `https://www.tiktok.com/embed/v2/${id}` : null;\n};\n\nconst youtube = (host: string, path: string): string | null => {\n let id: string | undefined;\n if (YOUTUBE_HOSTS.has(host)) id = /^\\/shorts\\/([\\w-]{11})\\/?$/.exec(path)?.[1];\n else if (host === \"youtu.be\") id = /^\\/([\\w-]{11})\\/?$/.exec(path)?.[1];\n return id ? `https://www.youtube-nocookie.com/embed/${id}` : null;\n};\n\nconst instagram = (host: string, path: string): string | null => {\n const match = INSTAGRAM_HOSTS.has(host) ? /^\\/(?:[\\w.]{1,30}\\/)?(p|reel|reels|tv)\\/([\\w-]{5,40})\\/?$/.exec(path) : null;\n return match ? `https://www.instagram.com/${match[1] === \"reels\" ? \"reel\" : match[1]}/${match[2]}/embed` : null;\n};\n\nconst PARSERS: Readonly<Record<EmbedPlatform, (host: string, path: string) => string | null>> = { tiktok, \"youtube-shorts\": youtube, instagram };\n\n/**\n * The address of the platform's frame for a public post, or `null` for anything else: another host, `http:`, a short\n * link we cannot resolve without asking the platform, a profile page. Exact hosts, exact paths.\n */\nexport function embedUrl(platform: EmbedPlatform, url: string): string | null {\n const u = parse(url);\n return u ? PARSERS[platform](u.hostname.toLowerCase(), u.pathname) : null;\n}\n\n/** Whether a poster may be drawn before the click: a path of the host's own origin, or an https picture that is not on a platform's domain (the host copies it to its own storage). */\nexport function isOwnPoster(poster: string): boolean {\n if (poster.startsWith(\"/\") && !poster.startsWith(\"//\")) return true;\n // An inline picture is no request at all.\n if (/^data:image\\/(?:png|jpeg|webp|gif|svg\\+xml)[;,]/i.test(poster)) return true;\n const u = parse(poster);\n if (!u) return false;\n const host = u.hostname.toLowerCase();\n return !PLATFORM_DOMAINS.some((domain) => host === domain || host.endsWith(`.${domain}`));\n}\n"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"path": "embed-facade/index.ts",
|
|
160
|
+
"content": "/** @krizaka/ui/embed-facade — `EmbedFacade` (a platform's short video behind a button: nothing loads before the click), `embedUrl` (the pure validator of the addresses it will embed). Client. */\nexport { EmbedFacade, type EmbedFacadeProps } from \"./embed-facade\";\nexport { EMBED_PLATFORMS, type EmbedPlatform, embedUrl, isOwnPoster } from \"./embed-url\";\n"
|
|
161
|
+
},
|
|
162
|
+
{
|
|
163
|
+
"path": "embed-facade/meta.ts",
|
|
164
|
+
"content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n title: \"Embed facade\",\n summary: \"A platform's short video (TikTok, YouTube Shorts, Instagram) behind a button: until the visitor asks, no frame, no script and no platform picture is requested — the frame is added on the click, sandboxed.\",\n status: \"beta\",\n category: \"media\",\n platforms: \"web\",\n parity: { native: { status: \"n/a\", reason: \"A web page's embed; a native app opens the platform's own app or a link.\", use: \"video-player\" }, desktop: \"web\" },\n whenToUse: [\n \"A shop or a profile that shows its latest reel from a platform, where privacy law (Québec's Law 25) wants consent before anything third-party loads.\",\n \"Inside a `RetroTv`, as the television's screen.\",\n ],\n whenNotToUse: [\n { when: \"A video you host yourself: no facade is needed.\", use: \"video-player\" },\n { when: \"A plain link to a profile: an anchor with rel=\\\"noopener noreferrer\\\" loads nothing.\", use: \"chip-link\" },\n ],\n bestPractices: [\n \"Validate the address when the owner saves it, with the same `embedUrl(platform, url)` the page uses: it returns the frame's address, or `null` for another host, `http:`, a short link or a profile.\",\n \"Give a `poster` that is your own copy (your storage or CDN). A poster on a platform's domain (ytimg, tiktokcdn, cdninstagram…) is refused: it would be a request before the click.\",\n \"`playLabel` names the platform it loads (« Load TikTok and play ») and `notice` says what the platform receives; both are translated by the host.\",\n \"The frame needs the host's Content-Security-Policy to allow `frame-src` for the three platforms; nothing else is loaded.\",\n \"Inside a television's screen it fills its parent; alone, it takes `aspectRatio` (9 / 16 by default).\",\n ],\n accessibility: {\n keyboard: [{ keys: \"Tab, Enter / Space\", action: \"Reaches the one button and loads the video; focus moves to the frame.\" }],\n notes: [\n \"A group named by `title`, one native button (44 px at least) that says the platform; the frame carries the same title.\",\n \"The poster is decorative (empty alt). No motion, so nothing changes under reduced motion.\",\n ],\n },\n related: [\"retro-tv\", \"video-player\", \"vertical-video\"],\n web: {\n imports: [\"EmbedFacade\", \"embedUrl\", \"isOwnPoster\", \"EMBED_PLATFORMS\"],\n examples: [\n { name: \"youtube\", title: \"YouTube Shorts\", description: \"The gate with the host's own poster and a notice; the frame appears on the click.\" },\n { name: \"tiktok\", title: \"TikTok, in French\", description: \"The same facade without a poster; every word is the host's.\" },\n ],\n },\n} satisfies ComponentMeta;\n"
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"path": "meta.ts",
|
|
168
|
+
"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-header\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\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 | \"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 | \"how-it-works-page\"\n | \"image-cropper\"\n | \"image-viewer\"\n | \"iso\"\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 | \"meta-row\"\n | \"waveform\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"match-dialog\"\n | \"media-capture\"\n | \"media-grid\"\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 | \"photo-grid\"\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 | \"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 | \"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 * `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 = \"stable\" | \"beta\" | \"deprecated\";\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 /** 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"
|
|
169
|
+
}
|
|
170
|
+
],
|
|
171
|
+
"dependencies": [],
|
|
172
|
+
"registryDependencies": [
|
|
173
|
+
"cn"
|
|
174
|
+
],
|
|
175
|
+
"demo": {
|
|
176
|
+
"path": "examples/embed-facade/youtube.tsx",
|
|
177
|
+
"content": "import { EmbedFacade } from \"@krizaka/ui/embed-facade\";\n\n// Nothing is requested from YouTube until the visitor presses the button. The poster is the host's own copy (here inline;\n// in an app, a picture of your own storage or CDN).\nconst POSTER = `data:image/svg+xml,${encodeURIComponent('<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 9 16\"><rect width=\"9\" height=\"16\" fill=\"#9fb8cc\"/><path d=\"m0 16 4-8 2 4 1.5-2L9 16Z\" fill=\"#2c5f8a\"/></svg>')}`;\n\nexport default function EmbedFacadeYoutube() {\n return (\n <div className=\"w-64 max-w-full\">\n <EmbedFacade\n platform=\"youtube-shorts\"\n url=\"https://www.youtube.com/shorts/abcDEF_-123\"\n title=\"Latest reel\"\n playLabel=\"Load YouTube and play\"\n poster={POSTER}\n notice=\"YouTube will receive your visit when you press play.\"\n />\n </div>\n );\n}\n"
|
|
178
|
+
},
|
|
179
|
+
"props": [
|
|
180
|
+
{
|
|
181
|
+
"component": "EmbedFacade",
|
|
182
|
+
"description": "A short video from a platform, behind a button: the frame exists only after the click.",
|
|
183
|
+
"props": [
|
|
184
|
+
{
|
|
185
|
+
"name": "platform",
|
|
186
|
+
"type": "EmbedPlatform",
|
|
187
|
+
"default": null,
|
|
188
|
+
"description": "Which platform's frame to load.",
|
|
189
|
+
"required": true
|
|
190
|
+
},
|
|
191
|
+
{
|
|
192
|
+
"name": "playLabel",
|
|
193
|
+
"type": "string",
|
|
194
|
+
"default": null,
|
|
195
|
+
"description": "The button: what it does and which platform it loads (\"Load TikTok and play\"), passed translated.",
|
|
196
|
+
"required": true
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "title",
|
|
200
|
+
"type": "string",
|
|
201
|
+
"default": null,
|
|
202
|
+
"description": "The accessible name of the video (\"Latest reel\"), passed translated: it names the frame once loaded.",
|
|
203
|
+
"required": true
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"name": "url",
|
|
207
|
+
"type": "string",
|
|
208
|
+
"default": null,
|
|
209
|
+
"description": "The public address of the post (`embedUrl` validates it; anything else renders nothing).",
|
|
210
|
+
"required": true
|
|
211
|
+
},
|
|
212
|
+
{
|
|
213
|
+
"name": "aspectRatio",
|
|
214
|
+
"type": "string",
|
|
215
|
+
"default": "9 / 16",
|
|
216
|
+
"description": "The ratio of the box when it stands alone; inside a television's screen it fills its parent.",
|
|
217
|
+
"required": false
|
|
218
|
+
},
|
|
219
|
+
{
|
|
220
|
+
"name": "notice",
|
|
221
|
+
"type": "ReactNode",
|
|
222
|
+
"default": null,
|
|
223
|
+
"description": "A line under the button, for what the platform will receive on the click (translated).",
|
|
224
|
+
"required": false
|
|
225
|
+
},
|
|
226
|
+
{
|
|
227
|
+
"name": "onLoad",
|
|
228
|
+
"type": "(() => void)",
|
|
229
|
+
"default": null,
|
|
230
|
+
"description": "Called once, when the visitor has asked and the frame is added.",
|
|
231
|
+
"required": false
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"name": "poster",
|
|
235
|
+
"type": "string",
|
|
236
|
+
"default": null,
|
|
237
|
+
"description": "The host's own copy of the picture (never an address on the platform: those are refused, they would be a request).",
|
|
238
|
+
"required": false
|
|
239
|
+
}
|
|
240
|
+
]
|
|
241
|
+
}
|
|
242
|
+
]
|
|
243
|
+
}
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
"why": "A person facing an empty page knows what belongs here and how to start.",
|
|
123
123
|
"path": "examples/empty-state/library.tsx",
|
|
124
124
|
"module": "@krizaka/ui/registry/examples/empty-state/library",
|
|
125
|
-
"code": "import { Button } from \"@krizaka/ui/button\";\nimport { EmptyState } from \"@krizaka/ui/empty-state\";\nimport { Mascot } from \"@krizaka/ui/mascots\";\nimport { Page } from \"@krizaka/ui/page\";\n\n// TEMPLATE — a page with nothing in it yet (a creator's library): the page keeps its title and place, the bird says it is\n// empty, one sentence tells what will fill it, one button does the first thing. Never a blank screen.\nexport default function EmptyStateLibrary() {\n return (\n <Page className=\"brand-
|
|
125
|
+
"code": "import { Button } from \"@krizaka/ui/button\";\nimport { EmptyState } from \"@krizaka/ui/empty-state\";\nimport { Mascot } from \"@krizaka/ui/mascots\";\nimport { Page } from \"@krizaka/ui/page\";\n\n// TEMPLATE — a page with nothing in it yet (a creator's library): the page keeps its title and place, the bird says it is\n// empty, one sentence tells what will fill it, one button does the first thing. Never a blank screen.\nexport default function EmptyStateLibrary() {\n return (\n <Page className=\"brand-orazaka\">\n <h1 className=\"font-display text-2xl font-extrabold tracking-tight text-fg\">Library</h1>\n <EmptyState\n icon={<Mascot bird=\"flamingo\" mood=\"empty\" size={96} />}\n title=\"Nothing here yet\"\n description=\"Your videos, once published, wait here with their sales. The first one takes about ten minutes.\"\n action={<Button variant=\"primary\">Publish a first video</Button>}\n />\n </Page>\n );\n}\n"
|
|
126
126
|
}
|
|
127
127
|
]
|
|
128
128
|
},
|
|
@@ -200,7 +200,7 @@
|
|
|
200
200
|
},
|
|
201
201
|
{
|
|
202
202
|
"path": "meta.ts",
|
|
203
|
-
"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 | \"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-header\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\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 | \"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 | \"how-it-works-page\"\n | \"image-cropper\"\n | \"image-viewer\"\n | \"iso\"\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 | \"meta-row\"\n | \"waveform\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"match-dialog\"\n | \"media-capture\"\n | \"media-grid\"\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 | \"photo-grid\"\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 | \"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 | \"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 | \"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 * `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 = \"stable\" | \"beta\" | \"deprecated\";\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 /** 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"
|
|
203
|
+
"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-header\"\n | \"app-shell\"\n | \"argument-card\"\n | \"audio-player\"\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 | \"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 | \"how-it-works-page\"\n | \"image-cropper\"\n | \"image-viewer\"\n | \"iso\"\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 | \"meta-row\"\n | \"waveform\"\n | \"marketing-layout\"\n | \"marquee\"\n | \"mascot-quote\"\n | \"mascot-state\"\n | \"mascots\"\n | \"match-dialog\"\n | \"media-capture\"\n | \"media-grid\"\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 | \"photo-grid\"\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 | \"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 | \"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 * `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 = \"stable\" | \"beta\" | \"deprecated\";\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 /** 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"
|
|
204
204
|
}
|
|
205
205
|
],
|
|
206
206
|
"dependencies": [
|