@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,445 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "analysis-report",
|
|
3
|
+
"type": "primitive",
|
|
4
|
+
"title": "Analysis report",
|
|
5
|
+
"summary": "The result of an AI analysis, honest and calm: one sentence and an overall status, findings grouped by status with what was observed and what it may indicate, what the report did not examine, the next steps and where the result comes from.",
|
|
6
|
+
"description": "The result of an AI analysis, honest and calm: one sentence and an overall status, findings grouped by status with what was observed and what it may indicate, what the report did not examine, the next steps and where the result comes from.",
|
|
7
|
+
"status": "beta",
|
|
8
|
+
"deprecated": null,
|
|
9
|
+
"category": "blocks",
|
|
10
|
+
"platforms": "both",
|
|
11
|
+
"parity": {
|
|
12
|
+
"web": {
|
|
13
|
+
"state": "yes"
|
|
14
|
+
},
|
|
15
|
+
"native": {
|
|
16
|
+
"state": "yes"
|
|
17
|
+
},
|
|
18
|
+
"desktop": {
|
|
19
|
+
"state": "yes"
|
|
20
|
+
}
|
|
21
|
+
},
|
|
22
|
+
"whenToUse": [
|
|
23
|
+
"Showing what an Orazaka analysis found in a document, a lease, an identity check or a moderated item, in any product.",
|
|
24
|
+
"Any result that has findings of different gravity, a list of limits and a provenance the reader may need to cite."
|
|
25
|
+
],
|
|
26
|
+
"whenNotToUse": [
|
|
27
|
+
{
|
|
28
|
+
"when": "A single yes / no outcome with no findings.",
|
|
29
|
+
"use": "alert"
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"when": "A chat answer that streams as prose.",
|
|
33
|
+
"use": "chat"
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"when": "A log of what happened in order.",
|
|
37
|
+
"use": "activity-feed"
|
|
38
|
+
}
|
|
39
|
+
],
|
|
40
|
+
"bestPractices": [
|
|
41
|
+
"Order is the point: the most serious group comes first, then the calmer ones; never sort by code.",
|
|
42
|
+
"Keep « may indicate » honest: it carries the caveat (« not proof of tampering »), never a verdict.",
|
|
43
|
+
"Say what the report did not examine, in the same weight as the findings; the limits are part of the result.",
|
|
44
|
+
"Pass every word through `labels` from your messages (`@krizaka/i18n`); the package ships none.",
|
|
45
|
+
"While the run is open, set `streaming`: findings are announced politely as they arrive.",
|
|
46
|
+
"Give `onLocate` to scroll a document viewer to a finding's place; without it the location is plain text.",
|
|
47
|
+
"Examples and tests use demo data only."
|
|
48
|
+
],
|
|
49
|
+
"accessibility": {
|
|
50
|
+
"keyboard": [
|
|
51
|
+
{
|
|
52
|
+
"keys": "Tab / Enter",
|
|
53
|
+
"action": "Reaches the copy buttons, the locations and the folded evidence."
|
|
54
|
+
}
|
|
55
|
+
],
|
|
56
|
+
"notes": [
|
|
57
|
+
"A section named by the studio's title; each status group is a labelled section with a heading, each finding a list item.",
|
|
58
|
+
"A status is always a word with its dot, never a colour alone.",
|
|
59
|
+
"The copy result and the streaming state are said in a polite status region; the list is `aria-busy` while streaming.",
|
|
60
|
+
"The evidence is a native `details`: it works without script and keeps the focus on its summary."
|
|
61
|
+
]
|
|
62
|
+
},
|
|
63
|
+
"related": [
|
|
64
|
+
"badge",
|
|
65
|
+
"decision-list",
|
|
66
|
+
"mascot-quote",
|
|
67
|
+
"alert"
|
|
68
|
+
],
|
|
69
|
+
"web": {
|
|
70
|
+
"entry": "@krizaka/ui/analysis-report",
|
|
71
|
+
"import": "import { AnalysisReport, groupFindings, countByStatus, reportToMarkdown, reportToJson } from \"@krizaka/ui/analysis-report\";",
|
|
72
|
+
"props": [
|
|
73
|
+
{
|
|
74
|
+
"component": "AnalysisReport",
|
|
75
|
+
"description": "The result of an AI analysis: summary, findings by status, limits, next steps, provenance, copy as JSON or Markdown.",
|
|
76
|
+
"props": [
|
|
77
|
+
{
|
|
78
|
+
"name": "findings",
|
|
79
|
+
"type": "readonly AnalysisFinding[]",
|
|
80
|
+
"default": null,
|
|
81
|
+
"description": "The findings, in any order: the report groups them by status, the most serious first.",
|
|
82
|
+
"required": true
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
"name": "labels",
|
|
86
|
+
"type": "AnalysisReportLabels",
|
|
87
|
+
"default": null,
|
|
88
|
+
"description": "Every word the report prints, passed translated (statuses, section titles, buttons).",
|
|
89
|
+
"required": true
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "status",
|
|
93
|
+
"type": "\"inconsistent\" | \"attention\" | \"unverified\" | \"consistent\"",
|
|
94
|
+
"default": null,
|
|
95
|
+
"description": "The overall status of the report.",
|
|
96
|
+
"required": true
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"name": "summary",
|
|
100
|
+
"type": "string",
|
|
101
|
+
"default": null,
|
|
102
|
+
"description": "One sentence: the answer.",
|
|
103
|
+
"required": true
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"name": "title",
|
|
107
|
+
"type": "string",
|
|
108
|
+
"default": null,
|
|
109
|
+
"description": "The studio's name (« Document validation »).",
|
|
110
|
+
"required": true
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "hideActions",
|
|
114
|
+
"type": "boolean",
|
|
115
|
+
"default": null,
|
|
116
|
+
"description": "Hides the copy buttons (a read-only embed).",
|
|
117
|
+
"required": false
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"name": "limits",
|
|
121
|
+
"type": "readonly string[]",
|
|
122
|
+
"default": null,
|
|
123
|
+
"description": "« What this report did not examine ».",
|
|
124
|
+
"required": false
|
|
125
|
+
},
|
|
126
|
+
{
|
|
127
|
+
"name": "mark",
|
|
128
|
+
"type": "ReactNode",
|
|
129
|
+
"default": null,
|
|
130
|
+
"description": "The pack's bird (a mark of `@krizaka/ui/mascots`), shown beside the studio's name.",
|
|
131
|
+
"required": false
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"name": "nextSteps",
|
|
135
|
+
"type": "readonly string[]",
|
|
136
|
+
"default": null,
|
|
137
|
+
"description": "What to do next, one step per item.",
|
|
138
|
+
"required": false
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"name": "onLocate",
|
|
142
|
+
"type": "((finding: AnalysisFinding) => void)",
|
|
143
|
+
"default": null,
|
|
144
|
+
"description": "Makes a finding's location a button (scroll a document viewer to it).",
|
|
145
|
+
"required": false
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"name": "provenance",
|
|
149
|
+
"type": "AnalysisProvenance",
|
|
150
|
+
"default": null,
|
|
151
|
+
"description": "Where the result comes from: model, run id, duration, version.",
|
|
152
|
+
"required": false
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
"name": "streaming",
|
|
156
|
+
"type": "boolean",
|
|
157
|
+
"default": null,
|
|
158
|
+
"description": "Findings are still arriving: the list is announced politely and marked busy.",
|
|
159
|
+
"required": false
|
|
160
|
+
}
|
|
161
|
+
]
|
|
162
|
+
},
|
|
163
|
+
{
|
|
164
|
+
"component": "ANALYSIS_STATUSES",
|
|
165
|
+
"description": "How a finding or a whole report reads, from the most serious to the calmest.",
|
|
166
|
+
"props": []
|
|
167
|
+
}
|
|
168
|
+
],
|
|
169
|
+
"examples": [
|
|
170
|
+
{
|
|
171
|
+
"name": "document-validation",
|
|
172
|
+
"title": "A document validation",
|
|
173
|
+
"description": "Header, findings grouped by status, limits and next steps in two columns, provenance, copy as JSON or Markdown.",
|
|
174
|
+
"path": "examples/analysis-report/document-validation.tsx",
|
|
175
|
+
"module": "@krizaka/ui/registry/examples/analysis-report/document-validation",
|
|
176
|
+
"code": "import { AnalysisReport, type AnalysisReportLabels } from \"@krizaka/ui/analysis-report\";\n\n// The words come from the app's messages (demo wording here).\nconst labels: AnalysisReportLabels = {\n status: { inconsistent: \"Inconsistent\", attention: \"Needs attention\", unverified: \"Not verified\", consistent: \"Consistent\" },\n findings: \"Findings\", mayIndicate: \"May indicate\", location: \"Where:\", evidence: \"Evidence\", details: \"Details\",\n limits: \"What this report did not examine\", nextSteps: \"Next steps\", provenance: \"Provenance\",\n model: \"Model\", runId: \"Run\", duration: \"Duration\", version: \"Version\",\n copyJson: \"Copy JSON\", copyMarkdown: \"Copy Markdown\", copied: \"Copied\", streaming: \"Findings are arriving\", noFindings: \"No finding.\",\n};\n\nexport default function AnalysisReportDocumentValidation() {\n return (\n <AnalysisReport\n labels={labels}\n title=\"Document validation\"\n summary=\"Two signals disagree with the document's own dates.\"\n status=\"inconsistent\"\n findings={[\n { id: \"1\", status: \"inconsistent\", code: \"PDF-META-002\", title: \"Modified after it was signed\", observation: \"The file was saved 12 days after the signature date.\", mayIndicate: \"An edit after signing, or a re-export. Not proof of tampering.\", location: \"metadata\", evidence: \"CreationDate: 2026-03-02\\nModDate: 2026-03-14\" },\n { id: \"2\", status: \"attention\", code: \"PDF-FONT-001\", title: \"Two fonts on one line\", observation: \"A single line mixes two typefaces.\", location: \"page 2\" },\n { id: \"3\", status: \"consistent\", code: \"PDF-PAGE-001\", title: \"Page count matches\", observation: \"4 pages, as the footer says.\" },\n ]}\n limits={[\"Handwritten signatures were not compared.\", \"The sender's identity was not checked.\"]}\n nextSteps={[\"Ask the sender for the original file.\", \"Compare with the copy on record.\"]}\n provenance={{ model: \"demo-model-1\", runId: \"run_8f3a21\", duration: \"4.2 s\", version: \"1.3.0\" }}\n />\n );\n}\n"
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
"name": "streaming",
|
|
180
|
+
"title": "While the run is open",
|
|
181
|
+
"description": "`streaming` marks the report busy and announces each finding as it arrives; the copy actions are hidden.",
|
|
182
|
+
"path": "examples/analysis-report/streaming.tsx",
|
|
183
|
+
"module": "@krizaka/ui/registry/examples/analysis-report/streaming",
|
|
184
|
+
"code": "import { AnalysisReport, type AnalysisReportLabels } from \"@krizaka/ui/analysis-report\";\n\nconst labels: AnalysisReportLabels = {\n status: { inconsistent: \"Inconsistent\", attention: \"Needs attention\", unverified: \"Not verified\", consistent: \"Consistent\" },\n findings: \"Findings\", mayIndicate: \"May indicate\", location: \"Where:\", evidence: \"Evidence\", details: \"Details\",\n limits: \"Limits\", nextSteps: \"Next steps\", provenance: \"Provenance\", model: \"Model\", runId: \"Run\", duration: \"Duration\", version: \"Version\",\n copyJson: \"Copy JSON\", copyMarkdown: \"Copy Markdown\", copied: \"Copied\", streaming: \"Findings are arriving\", noFindings: \"No finding yet.\",\n};\n\n// While the run is open, `streaming` marks the report busy and announces each arrival politely; the actions can be hidden.\nexport default function AnalysisReportStreaming() {\n return (\n <AnalysisReport\n labels={labels}\n streaming\n hideActions\n title=\"Lease compliance\"\n summary=\"Reading the lease, clause by clause…\"\n status=\"unverified\"\n findings={[{ id: \"1\", status: \"consistent\", code: \"LEASE-TERM-001\", title: \"Term is 12 months\", observation: \"Start and end dates agree with the stated term.\", location: \"clause 3\" }]}\n />\n );\n}\n"
|
|
185
|
+
}
|
|
186
|
+
]
|
|
187
|
+
},
|
|
188
|
+
"native": {
|
|
189
|
+
"entry": "@krizaka/ui/native",
|
|
190
|
+
"import": "import { AnalysisReport } from \"@krizaka/ui/native\";",
|
|
191
|
+
"differences": [
|
|
192
|
+
"There is no clipboard in the package: `onCopy` receives the text and the app copies it.",
|
|
193
|
+
"The evidence unfolds in place (a pressable summary) instead of a native `details`."
|
|
194
|
+
],
|
|
195
|
+
"deprecated": null,
|
|
196
|
+
"props": [
|
|
197
|
+
{
|
|
198
|
+
"component": "AnalysisReport",
|
|
199
|
+
"description": "The web `AnalysisReport` on React Native.",
|
|
200
|
+
"props": [
|
|
201
|
+
{
|
|
202
|
+
"name": "findings",
|
|
203
|
+
"type": "readonly AnalysisFinding[]",
|
|
204
|
+
"default": null,
|
|
205
|
+
"description": "The findings, in any order: the report groups them by status, the most serious first.",
|
|
206
|
+
"required": true
|
|
207
|
+
},
|
|
208
|
+
{
|
|
209
|
+
"name": "labels",
|
|
210
|
+
"type": "AnalysisReportLabels",
|
|
211
|
+
"default": null,
|
|
212
|
+
"description": "Every word the report prints, passed translated (statuses, section titles, buttons).",
|
|
213
|
+
"required": true
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"name": "status",
|
|
217
|
+
"type": "\"inconsistent\" | \"attention\" | \"unverified\" | \"consistent\"",
|
|
218
|
+
"default": null,
|
|
219
|
+
"description": "The overall status of the report.",
|
|
220
|
+
"required": true
|
|
221
|
+
},
|
|
222
|
+
{
|
|
223
|
+
"name": "summary",
|
|
224
|
+
"type": "string",
|
|
225
|
+
"default": null,
|
|
226
|
+
"description": "One sentence: the answer.",
|
|
227
|
+
"required": true
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"name": "title",
|
|
231
|
+
"type": "string",
|
|
232
|
+
"default": null,
|
|
233
|
+
"description": "The studio's name (« Document validation »).",
|
|
234
|
+
"required": true
|
|
235
|
+
},
|
|
236
|
+
{
|
|
237
|
+
"name": "hideActions",
|
|
238
|
+
"type": "boolean",
|
|
239
|
+
"default": null,
|
|
240
|
+
"description": "Hides the copy buttons.",
|
|
241
|
+
"required": false
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "limits",
|
|
245
|
+
"type": "readonly string[]",
|
|
246
|
+
"default": null,
|
|
247
|
+
"description": "« What this report did not examine ».",
|
|
248
|
+
"required": false
|
|
249
|
+
},
|
|
250
|
+
{
|
|
251
|
+
"name": "mark",
|
|
252
|
+
"type": "ReactNode",
|
|
253
|
+
"default": null,
|
|
254
|
+
"description": "The pack's bird, beside the studio's name.",
|
|
255
|
+
"required": false
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"name": "nextSteps",
|
|
259
|
+
"type": "readonly string[]",
|
|
260
|
+
"default": null,
|
|
261
|
+
"description": "What to do next, one step per item.",
|
|
262
|
+
"required": false
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"name": "onCopy",
|
|
266
|
+
"type": "((kind: AnalysisExport, text: string) => void)",
|
|
267
|
+
"default": null,
|
|
268
|
+
"description": "Called with the text when the person asks to copy: the app puts it on the clipboard.",
|
|
269
|
+
"required": false
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"name": "onLocate",
|
|
273
|
+
"type": "((finding: AnalysisFinding) => void)",
|
|
274
|
+
"default": null,
|
|
275
|
+
"description": "Makes a finding's location pressable.",
|
|
276
|
+
"required": false
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
"name": "provenance",
|
|
280
|
+
"type": "AnalysisProvenance",
|
|
281
|
+
"default": null,
|
|
282
|
+
"description": "Where the result comes from: model, run id, duration, version.",
|
|
283
|
+
"required": false
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
"name": "streaming",
|
|
287
|
+
"type": "boolean",
|
|
288
|
+
"default": null,
|
|
289
|
+
"description": "Findings are still arriving.",
|
|
290
|
+
"required": false
|
|
291
|
+
}
|
|
292
|
+
]
|
|
293
|
+
},
|
|
294
|
+
{
|
|
295
|
+
"component": "AnalysisReportLabels",
|
|
296
|
+
"description": "Every word the report prints, passed translated (the package ships none).",
|
|
297
|
+
"props": []
|
|
298
|
+
}
|
|
299
|
+
],
|
|
300
|
+
"examples": [
|
|
301
|
+
{
|
|
302
|
+
"name": "document-validation",
|
|
303
|
+
"title": "A document validation",
|
|
304
|
+
"description": "The same report on the phone: findings by status, limits, next steps.",
|
|
305
|
+
"path": "examples/analysis-report/native/document-validation.tsx",
|
|
306
|
+
"module": "@krizaka/ui/registry/examples/analysis-report/native/document-validation",
|
|
307
|
+
"code": "import { AnalysisReport, type AnalysisReportLabels } from \"@krizaka/ui/native\";\nimport { View } from \"react-native\";\n\nconst labels: AnalysisReportLabels = {\n status: { inconsistent: \"Inconsistent\", attention: \"Needs attention\", unverified: \"Not verified\", consistent: \"Consistent\" },\n findings: \"Findings\", mayIndicate: \"May indicate\", location: \"Where:\", evidence: \"Evidence\", details: \"Details\",\n limits: \"What this report did not examine\", nextSteps: \"Next steps\", provenance: \"Provenance\",\n model: \"Model\", runId: \"Run\", duration: \"Duration\", version: \"Version\",\n copyJson: \"Copy JSON\", copyMarkdown: \"Copy Markdown\", copied: \"Copied\", streaming: \"Findings are arriving\", noFindings: \"No finding.\",\n};\n\n// The phone has no clipboard here: `onCopy` receives the text and the app copies it (expo-clipboard).\nexport default function NativeAnalysisReportDocumentValidation() {\n return (\n <View style={{ width: 360 }}>\n <AnalysisReport\n labels={labels}\n title=\"Document validation\"\n summary=\"Two signals disagree with the document's own dates.\"\n status=\"inconsistent\"\n findings={[\n { id: \"1\", status: \"inconsistent\", code: \"PDF-META-002\", title: \"Modified after it was signed\", observation: \"The file was saved 12 days after the signature date.\", mayIndicate: \"An edit after signing. Not proof of tampering.\", location: \"metadata\" },\n { id: \"2\", status: \"consistent\", code: \"PDF-PAGE-001\", title: \"Page count matches\", observation: \"4 pages, as the footer says.\" },\n ]}\n limits={[\"Handwritten signatures were not compared.\"]}\n nextSteps={[\"Ask the sender for the original file.\"]}\n provenance={{ model: \"demo-model-1\", runId: \"run_8f3a21\" }}\n onCopy={() => undefined}\n />\n </View>\n );\n}\n",
|
|
308
|
+
"screenshots": {
|
|
309
|
+
"dark": "examples/analysis-report/native/document-validation.dark.png",
|
|
310
|
+
"light": "examples/analysis-report/native/document-validation.light.png"
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
]
|
|
314
|
+
},
|
|
315
|
+
"files": [
|
|
316
|
+
{
|
|
317
|
+
"path": "analysis-report/analysis-report.tsx",
|
|
318
|
+
"content": "// Client (the copy buttons, the folds). The result of an AI analysis, read in five seconds then deeper on demand: a header\n// (studio, one sentence, overall status, counts), findings grouped by status (the most serious first), the limits and the\n// next steps as a calm two-column section, a provenance footer, and copy as JSON / Markdown. Words arrive as props.\nimport * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\nimport { Badge } from \"../badge/badge\";\nimport { Button } from \"../button/button\";\nimport {\n type AnalysisExport,\n type AnalysisFinding,\n type AnalysisReportData,\n type AnalysisReportLabels,\n type AnalysisStatus,\n countByStatus,\n exportReport,\n groupFindings,\n} from \"./model\";\n\nexport const analysisReportStyles = tv({\n slots: {\n root: \"flex w-full flex-col gap-6 text-fg\",\n header: \"flex items-start gap-4\",\n headText: \"flex min-w-0 flex-1 flex-col gap-2\",\n title: \"font-display text-xl font-bold tracking-tight text-fg\",\n summary: \"text-base text-fg-secondary\",\n counts: \"flex flex-wrap items-center gap-2\",\n actions: \"flex flex-wrap gap-2\",\n group: \"flex flex-col gap-3\",\n groupTitle: \"text-sm font-semibold text-fg-secondary\",\n list: \"flex flex-col gap-3\",\n finding: \"flex min-w-0 flex-col gap-2 rounded-lg border border-border-default bg-surface-1 p-4\",\n findingHead: \"flex flex-wrap items-center gap-2\",\n code: \"font-mono text-xs text-fg-secondary\",\n findingTitle: \"text-base font-semibold text-fg\",\n muted: \"text-sm text-fg-secondary\",\n locate: \"w-fit\",\n fold: \"text-sm text-fg-secondary\",\n evidence: \"mt-2 overflow-x-auto rounded-md border border-border-default bg-surface-2 p-3 font-mono text-xs text-fg focus-visible:focus-ring\",\n foldSummary: \"w-fit cursor-pointer rounded-sm font-semibold text-fg-accent focus-visible:focus-ring\",\n columns: \"grid gap-6 border-t border-border-default pt-6 @lg:grid-cols-2\",\n column: \"flex flex-col gap-2\",\n columnTitle: \"text-sm font-semibold text-fg\",\n items: \"flex list-disc flex-col gap-1 pl-5 text-sm text-fg-secondary\",\n provenance: \"flex flex-wrap gap-x-6 gap-y-1 border-t border-border-default pt-4 text-xs text-fg-secondary\",\n term: \"font-semibold text-fg\",\n live: \"text-sm text-fg-secondary\",\n },\n});\n\nconst TONE = { inconsistent: \"danger\", attention: \"warning\", unverified: \"neutral\", consistent: \"success\" } as const satisfies Record<AnalysisStatus, string>;\n\nexport type AnalysisReportProps = Omit<React.ComponentProps<\"section\">, \"title\" | \"children\"> &\n AnalysisReportData & {\n /** Every word the report prints, passed translated (statuses, section titles, buttons). */\n labels: AnalysisReportLabels;\n /** The pack's bird (a mark of `@krizaka/ui/mascots`), shown beside the studio's name. */\n mark?: React.ReactNode;\n /** Findings are still arriving: the list is announced politely and marked busy. */\n streaming?: boolean;\n /** Makes a finding's location a button (scroll a document viewer to it). */\n onLocate?: (finding: AnalysisFinding) => void;\n /** Called after the report is copied (`json` or `markdown`), with the copied text. Without a clipboard, the app can copy it here. */\n onCopy?: (kind: AnalysisExport, text: string) => void;\n /** Hides the copy buttons (a read-only embed). */\n hideActions?: boolean;\n };\n\nfunction FindingCard({ finding, labels, onLocate }: { finding: AnalysisFinding; labels: AnalysisReportLabels; onLocate?: AnalysisReportProps[\"onLocate\"] }) {\n const s = analysisReportStyles();\n return (\n <li className={s.finding()}>\n <div className={s.findingHead()}>\n <Badge tone={TONE[finding.status]} dot>\n {labels.status[finding.status]}\n </Badge>\n {finding.code ? <span className={s.code()}>{finding.code}</span> : null}\n </div>\n <h4 className={s.findingTitle()}>{finding.title}</h4>\n {finding.observation ? <p className={s.muted()}>{finding.observation}</p> : null}\n {finding.mayIndicate ? (\n <p className={s.muted()}>\n <span className={s.term()}>{labels.mayIndicate}</span> {finding.mayIndicate}\n </p>\n ) : null}\n {finding.location ? (\n onLocate ? (\n <Button variant=\"ghost\" size=\"sm\" className={s.locate()} onClick={() => onLocate(finding)}>\n {labels.location} {finding.location}\n </Button>\n ) : (\n <p className={s.muted()}>\n <span className={s.term()}>{labels.location}</span> {finding.location}\n </p>\n )\n ) : null}\n {finding.evidence ? (\n <details className={s.fold()}>\n <summary className={s.foldSummary()}>{labels.evidence}</summary>\n <pre tabIndex={0} className={s.evidence()}>\n <code>{finding.evidence}</code>\n </pre>\n </details>\n ) : null}\n </li>\n );\n}\n\nfunction TextColumn({ title, items }: { title: string; items: readonly string[] | undefined }) {\n const s = analysisReportStyles();\n if (!items?.length) return null;\n return (\n <section className={s.column()}>\n <h3 className={s.columnTitle()}>{title}</h3>\n <ul className={s.items()}>\n {items.map((i) => (\n <li key={i}>{i}</li>\n ))}\n </ul>\n </section>\n );\n}\n\nfunction Provenance({ data, labels }: { data: NonNullable<AnalysisReportData[\"provenance\"]>; labels: AnalysisReportLabels }) {\n const s = analysisReportStyles();\n const rows = [\n [labels.model, data.model],\n [labels.runId, data.runId],\n [labels.duration, data.duration],\n [labels.version, data.version],\n ].filter((r): r is [string, string] => Boolean(r[1]));\n if (!rows.length) return null;\n return (\n <dl aria-label={labels.provenance} className={s.provenance()}>\n {rows.map(([k, v]) => (\n <div key={k} className=\"flex gap-1.5\">\n <dt className={s.term()}>{k}</dt>\n <dd className=\"font-mono\">{v}</dd>\n </div>\n ))}\n </dl>\n );\n}\n\n/** The result of an AI analysis: summary, findings by status, limits, next steps, provenance, copy as JSON or Markdown. */\nexport function AnalysisReport({ title, summary, status, findings, limits, nextSteps, provenance, labels, mark, streaming, onLocate, onCopy, hideActions, className, ...props }: AnalysisReportProps) {\n const s = analysisReportStyles();\n const [copied, setCopied] = React.useState<AnalysisExport | null>(null);\n const report: AnalysisReportData = { title, summary, status, findings, limits, nextSteps, provenance };\n const counts = countByStatus(findings);\n const heading = React.useId();\n const copy = (kind: AnalysisExport) => {\n const text = exportReport(kind, report, labels);\n void navigator.clipboard?.writeText(text).then(() => setCopied(kind));\n onCopy?.(kind, text);\n };\n return (\n <section aria-labelledby={heading} aria-busy={streaming || undefined} className={s.root({ className })} {...props}>\n <header className={s.header()}>\n {mark}\n <div className={s.headText()}>\n <h2 id={heading} className={s.title()}>\n {title}\n </h2>\n <p className={s.summary()}>{summary}</p>\n <div className={s.counts()}>\n <Badge tone={TONE[status]} size=\"md\" dot>\n {labels.status[status]}\n </Badge>\n {(Object.keys(counts) as AnalysisStatus[])\n .filter((k) => counts[k] > 0)\n .map((k) => (\n <Badge key={k} tone={TONE[k]}>\n {counts[k]} {labels.status[k]}\n </Badge>\n ))}\n </div>\n </div>\n {hideActions ? null : (\n <div className={s.actions()}>\n <Button variant=\"outline\" size=\"sm\" onClick={() => copy(\"json\")}>\n {labels.copyJson}\n </Button>\n <Button variant=\"outline\" size=\"sm\" onClick={() => copy(\"markdown\")}>\n {labels.copyMarkdown}\n </Button>\n </div>\n )}\n </header>\n <p role=\"status\" className=\"sr-only\">\n {copied ? labels.copied : streaming ? labels.streaming : \"\"}\n </p>\n <div aria-live={streaming ? \"polite\" : undefined} className=\"flex flex-col gap-6\">\n {findings.length === 0 && !streaming ? <p className={s.live()}>{labels.noFindings}</p> : null}\n {groupFindings(findings).map((g) => (\n <section key={g.status} className={s.group()} aria-label={`${labels.findings}: ${labels.status[g.status]}`}>\n <h3 className={s.groupTitle()}>\n {labels.status[g.status]} · {g.findings.length}\n </h3>\n <ul className={s.list()}>\n {g.findings.map((f) => (\n <FindingCard key={f.id} finding={f} labels={labels} onLocate={onLocate} />\n ))}\n </ul>\n </section>\n ))}\n </div>\n {limits?.length || nextSteps?.length ? (\n <div className=\"@container\">\n <div className={s.columns()}>\n <TextColumn title={labels.limits} items={limits} />\n <TextColumn title={labels.nextSteps} items={nextSteps} />\n </div>\n </div>\n ) : null}\n {provenance ? <Provenance data={provenance} labels={labels} /> : null}\n </section>\n );\n}\n"
|
|
319
|
+
},
|
|
320
|
+
{
|
|
321
|
+
"path": "analysis-report/index.ts",
|
|
322
|
+
"content": "/** @krizaka/ui/analysis-report — `AnalysisReport`, the result of an AI analysis (summary, findings, limits, next steps, provenance, copy as JSON / Markdown), and its rules. Client. */\nexport { AnalysisReport, type AnalysisReportProps, analysisReportStyles } from \"./analysis-report\";\nexport {\n ANALYSIS_STATUSES,\n type AnalysisExport,\n type AnalysisFinding,\n type AnalysisProvenance,\n type AnalysisReportData,\n type AnalysisReportLabels,\n type AnalysisStatus,\n countByStatus,\n exportReport,\n groupFindings,\n reportToJson,\n reportToMarkdown,\n} from \"./model\";\n"
|
|
323
|
+
},
|
|
324
|
+
{
|
|
325
|
+
"path": "analysis-report/meta.ts",
|
|
326
|
+
"content": "import type { ComponentMeta } from \"../meta\";\n\nexport const meta = {\n title: \"Analysis report\",\n summary:\n \"The result of an AI analysis, honest and calm: one sentence and an overall status, findings grouped by status with what was observed and what it may indicate, what the report did not examine, the next steps and where the result comes from.\",\n status: \"beta\",\n category: \"blocks\",\n platforms: \"both\",\n parity: { desktop: \"web\" },\n whenToUse: [\n \"Showing what an Orazaka analysis found in a document, a lease, an identity check or a moderated item, in any product.\",\n \"Any result that has findings of different gravity, a list of limits and a provenance the reader may need to cite.\",\n ],\n whenNotToUse: [\n { when: \"A single yes / no outcome with no findings.\", use: \"alert\" },\n { when: \"A chat answer that streams as prose.\", use: \"chat\" },\n { when: \"A log of what happened in order.\", use: \"activity-feed\" },\n ],\n bestPractices: [\n \"Order is the point: the most serious group comes first, then the calmer ones; never sort by code.\",\n \"Keep « may indicate » honest: it carries the caveat (« not proof of tampering »), never a verdict.\",\n \"Say what the report did not examine, in the same weight as the findings; the limits are part of the result.\",\n \"Pass every word through `labels` from your messages (`@krizaka/i18n`); the package ships none.\",\n \"While the run is open, set `streaming`: findings are announced politely as they arrive.\",\n \"Give `onLocate` to scroll a document viewer to a finding's place; without it the location is plain text.\",\n \"Examples and tests use demo data only.\",\n ],\n accessibility: {\n keyboard: [{ keys: \"Tab / Enter\", action: \"Reaches the copy buttons, the locations and the folded evidence.\" }],\n notes: [\n \"A section named by the studio's title; each status group is a labelled section with a heading, each finding a list item.\",\n \"A status is always a word with its dot, never a colour alone.\",\n \"The copy result and the streaming state are said in a polite status region; the list is `aria-busy` while streaming.\",\n \"The evidence is a native `details`: it works without script and keeps the focus on its summary.\",\n ],\n },\n related: [\"badge\", \"decision-list\", \"mascot-quote\", \"alert\"],\n web: {\n imports: [\"AnalysisReport\", \"groupFindings\", \"countByStatus\", \"reportToMarkdown\", \"reportToJson\"],\n examples: [\n { name: \"document-validation\", title: \"A document validation\", description: \"Header, findings grouped by status, limits and next steps in two columns, provenance, copy as JSON or Markdown.\" },\n { name: \"streaming\", title: \"While the run is open\", description: \"`streaming` marks the report busy and announces each finding as it arrives; the copy actions are hidden.\" },\n ],\n },\n native: {\n imports: [\"AnalysisReport\"],\n differences: [\n \"There is no clipboard in the package: `onCopy` receives the text and the app copies it.\",\n \"The evidence unfolds in place (a pressable summary) instead of a native `details`.\",\n ],\n examples: [{ name: \"document-validation\", title: \"A document validation\", description: \"The same report on the phone: findings by status, limits, next steps.\" }],\n },\n} satisfies ComponentMeta;\n"
|
|
327
|
+
},
|
|
328
|
+
{
|
|
329
|
+
"path": "analysis-report/model.ts",
|
|
330
|
+
"content": "// The rules of an analysis report, shared by the web entry and tested alone: the order of the statuses, the grouping of the\n// findings (the most serious first), the counts, and the two exports (JSON, Markdown). No words of its own: the labels arrive.\n\n/** How a finding or a whole report reads, from the most serious to the calmest. */\nexport const ANALYSIS_STATUSES = [\"inconsistent\", \"attention\", \"unverified\", \"consistent\"] as const;\nexport type AnalysisStatus = (typeof ANALYSIS_STATUSES)[number];\n\nexport type AnalysisFinding = {\n id: string;\n status: AnalysisStatus;\n /** The rule's identifier, in mono (`PDF-META-002`). */\n code?: string;\n title: string;\n /** What was observed. */\n observation?: string;\n /** What it may indicate, with its honest caveat. */\n mayIndicate?: string;\n /** Where in the document: « metadata », « page 3 ». `onLocate` receives the finding. */\n location?: string;\n /** The raw evidence, shown in a code block. */\n evidence?: string;\n};\n\nexport type AnalysisProvenance = { model?: string; runId?: string; duration?: string; version?: string };\n\nexport type AnalysisReportData = {\n /** The studio's name (« Document validation »). */\n title: string;\n /** One sentence: the answer. */\n summary: string;\n /** The overall status of the report. */\n status: AnalysisStatus;\n /** The findings, in any order: the report groups them by status, the most serious first. */\n findings: readonly AnalysisFinding[];\n /** « What this report did not examine ». */\n limits?: readonly string[];\n /** What to do next, one step per item. */\n nextSteps?: readonly string[];\n /** Where the result comes from: model, run id, duration, version. */\n provenance?: AnalysisProvenance;\n};\n\n/** Every word the report prints, passed translated (the package ships none). */\nexport type AnalysisReportLabels = {\n status: Record<AnalysisStatus, string>;\n findings: string;\n mayIndicate: string;\n location: string;\n evidence: string;\n details: string;\n limits: string;\n nextSteps: string;\n provenance: string;\n model: string;\n runId: string;\n duration: string;\n version: string;\n copyJson: string;\n copyMarkdown: string;\n copied: string;\n /** Said while findings are still arriving. */\n streaming: string;\n /** Said when the report has no finding. */\n noFindings: string;\n};\n\nexport type AnalysisExport = \"json\" | \"markdown\";\n\n/** The findings grouped by status, the most serious group first; empty groups are left out. */\nexport function groupFindings(findings: readonly AnalysisFinding[]): { status: AnalysisStatus; findings: AnalysisFinding[] }[] {\n return ANALYSIS_STATUSES.map((status) => ({ status, findings: findings.filter((f) => f.status === status) })).filter((g) => g.findings.length > 0);\n}\n\n/** How many findings wear each status (zero included, so a count row is stable). */\nexport function countByStatus(findings: readonly AnalysisFinding[]): Record<AnalysisStatus, number> {\n const counts = { inconsistent: 0, attention: 0, unverified: 0, consistent: 0 } satisfies Record<AnalysisStatus, number>;\n for (const f of findings) counts[f.status] += 1;\n return counts;\n}\n\nexport function reportToJson(report: AnalysisReportData): string {\n return JSON.stringify(report, null, 2);\n}\n\nconst bullets = (items: readonly string[]) => items.map((i) => `- ${i}`);\n\nfunction findingLines(f: AnalysisFinding, labels: AnalysisReportLabels): string[] {\n const head = `### ${f.code ? `\\`${f.code}\\` · ` : \"\"}${f.title}`;\n return [\n head,\n ...(f.observation ? [\"\", f.observation] : []),\n ...(f.mayIndicate ? [\"\", `**${labels.mayIndicate}** ${f.mayIndicate}`] : []),\n ...(f.location ? [\"\", `**${labels.location}** ${f.location}`] : []),\n ...(f.evidence ? [\"\", \"```\", f.evidence, \"```\"] : []),\n \"\",\n ];\n}\n\nfunction provenanceLines(p: AnalysisProvenance | undefined, labels: AnalysisReportLabels): string[] {\n const rows: [string, string | undefined][] = [\n [labels.model, p?.model],\n [labels.runId, p?.runId],\n [labels.duration, p?.duration],\n [labels.version, p?.version],\n ];\n return rows.filter((r): r is [string, string] => Boolean(r[1])).map(([k, v]) => `- ${k}: ${v}`);\n}\n\n/** The report as Markdown, in the same order as the page. */\nexport function reportToMarkdown(report: AnalysisReportData, labels: AnalysisReportLabels): string {\n const sections: string[][] = [\n [`# ${report.title}`, \"\", `**${labels.status[report.status]}** — ${report.summary}`],\n ...groupFindings(report.findings).map((g) => [`## ${labels.status[g.status]}`, \"\", ...g.findings.flatMap((f) => findingLines(f, labels))]),\n ...(report.limits?.length ? [[`## ${labels.limits}`, \"\", ...bullets(report.limits)]] : []),\n ...(report.nextSteps?.length ? [[`## ${labels.nextSteps}`, \"\", ...bullets(report.nextSteps)]] : []),\n ...(provenanceLines(report.provenance, labels).length ? [[`## ${labels.provenance}`, \"\", ...provenanceLines(report.provenance, labels)]] : []),\n ];\n return sections.map((s) => s.join(\"\\n\").trimEnd()).join(\"\\n\\n\") + \"\\n\";\n}\n\n/** The text of an export. */\nexport function exportReport(kind: AnalysisExport, report: AnalysisReportData, labels: AnalysisReportLabels): string {\n return kind === \"json\" ? reportToJson(report) : reportToMarkdown(report, labels);\n}\n"
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
"path": "meta.ts",
|
|
334
|
+
"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"
|
|
335
|
+
}
|
|
336
|
+
],
|
|
337
|
+
"dependencies": [
|
|
338
|
+
"tailwind-variants@^3.3.1"
|
|
339
|
+
],
|
|
340
|
+
"registryDependencies": [
|
|
341
|
+
"badge",
|
|
342
|
+
"button"
|
|
343
|
+
],
|
|
344
|
+
"demo": {
|
|
345
|
+
"path": "examples/analysis-report/document-validation.tsx",
|
|
346
|
+
"content": "import { AnalysisReport, type AnalysisReportLabels } from \"@krizaka/ui/analysis-report\";\n\n// The words come from the app's messages (demo wording here).\nconst labels: AnalysisReportLabels = {\n status: { inconsistent: \"Inconsistent\", attention: \"Needs attention\", unverified: \"Not verified\", consistent: \"Consistent\" },\n findings: \"Findings\", mayIndicate: \"May indicate\", location: \"Where:\", evidence: \"Evidence\", details: \"Details\",\n limits: \"What this report did not examine\", nextSteps: \"Next steps\", provenance: \"Provenance\",\n model: \"Model\", runId: \"Run\", duration: \"Duration\", version: \"Version\",\n copyJson: \"Copy JSON\", copyMarkdown: \"Copy Markdown\", copied: \"Copied\", streaming: \"Findings are arriving\", noFindings: \"No finding.\",\n};\n\nexport default function AnalysisReportDocumentValidation() {\n return (\n <AnalysisReport\n labels={labels}\n title=\"Document validation\"\n summary=\"Two signals disagree with the document's own dates.\"\n status=\"inconsistent\"\n findings={[\n { id: \"1\", status: \"inconsistent\", code: \"PDF-META-002\", title: \"Modified after it was signed\", observation: \"The file was saved 12 days after the signature date.\", mayIndicate: \"An edit after signing, or a re-export. Not proof of tampering.\", location: \"metadata\", evidence: \"CreationDate: 2026-03-02\\nModDate: 2026-03-14\" },\n { id: \"2\", status: \"attention\", code: \"PDF-FONT-001\", title: \"Two fonts on one line\", observation: \"A single line mixes two typefaces.\", location: \"page 2\" },\n { id: \"3\", status: \"consistent\", code: \"PDF-PAGE-001\", title: \"Page count matches\", observation: \"4 pages, as the footer says.\" },\n ]}\n limits={[\"Handwritten signatures were not compared.\", \"The sender's identity was not checked.\"]}\n nextSteps={[\"Ask the sender for the original file.\", \"Compare with the copy on record.\"]}\n provenance={{ model: \"demo-model-1\", runId: \"run_8f3a21\", duration: \"4.2 s\", version: \"1.3.0\" }}\n />\n );\n}\n"
|
|
347
|
+
},
|
|
348
|
+
"props": [
|
|
349
|
+
{
|
|
350
|
+
"component": "AnalysisReport",
|
|
351
|
+
"description": "The result of an AI analysis: summary, findings by status, limits, next steps, provenance, copy as JSON or Markdown.",
|
|
352
|
+
"props": [
|
|
353
|
+
{
|
|
354
|
+
"name": "findings",
|
|
355
|
+
"type": "readonly AnalysisFinding[]",
|
|
356
|
+
"default": null,
|
|
357
|
+
"description": "The findings, in any order: the report groups them by status, the most serious first.",
|
|
358
|
+
"required": true
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
"name": "labels",
|
|
362
|
+
"type": "AnalysisReportLabels",
|
|
363
|
+
"default": null,
|
|
364
|
+
"description": "Every word the report prints, passed translated (statuses, section titles, buttons).",
|
|
365
|
+
"required": true
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
"name": "status",
|
|
369
|
+
"type": "\"inconsistent\" | \"attention\" | \"unverified\" | \"consistent\"",
|
|
370
|
+
"default": null,
|
|
371
|
+
"description": "The overall status of the report.",
|
|
372
|
+
"required": true
|
|
373
|
+
},
|
|
374
|
+
{
|
|
375
|
+
"name": "summary",
|
|
376
|
+
"type": "string",
|
|
377
|
+
"default": null,
|
|
378
|
+
"description": "One sentence: the answer.",
|
|
379
|
+
"required": true
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"name": "title",
|
|
383
|
+
"type": "string",
|
|
384
|
+
"default": null,
|
|
385
|
+
"description": "The studio's name (« Document validation »).",
|
|
386
|
+
"required": true
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"name": "hideActions",
|
|
390
|
+
"type": "boolean",
|
|
391
|
+
"default": null,
|
|
392
|
+
"description": "Hides the copy buttons (a read-only embed).",
|
|
393
|
+
"required": false
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
"name": "limits",
|
|
397
|
+
"type": "readonly string[]",
|
|
398
|
+
"default": null,
|
|
399
|
+
"description": "« What this report did not examine ».",
|
|
400
|
+
"required": false
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
"name": "mark",
|
|
404
|
+
"type": "ReactNode",
|
|
405
|
+
"default": null,
|
|
406
|
+
"description": "The pack's bird (a mark of `@krizaka/ui/mascots`), shown beside the studio's name.",
|
|
407
|
+
"required": false
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"name": "nextSteps",
|
|
411
|
+
"type": "readonly string[]",
|
|
412
|
+
"default": null,
|
|
413
|
+
"description": "What to do next, one step per item.",
|
|
414
|
+
"required": false
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "onLocate",
|
|
418
|
+
"type": "((finding: AnalysisFinding) => void)",
|
|
419
|
+
"default": null,
|
|
420
|
+
"description": "Makes a finding's location a button (scroll a document viewer to it).",
|
|
421
|
+
"required": false
|
|
422
|
+
},
|
|
423
|
+
{
|
|
424
|
+
"name": "provenance",
|
|
425
|
+
"type": "AnalysisProvenance",
|
|
426
|
+
"default": null,
|
|
427
|
+
"description": "Where the result comes from: model, run id, duration, version.",
|
|
428
|
+
"required": false
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "streaming",
|
|
432
|
+
"type": "boolean",
|
|
433
|
+
"default": null,
|
|
434
|
+
"description": "Findings are still arriving: the list is announced politely and marked busy.",
|
|
435
|
+
"required": false
|
|
436
|
+
}
|
|
437
|
+
]
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"component": "ANALYSIS_STATUSES",
|
|
441
|
+
"description": "How a finding or a whole report reads, from the most serious to the calmest.",
|
|
442
|
+
"props": []
|
|
443
|
+
}
|
|
444
|
+
]
|
|
445
|
+
}
|
|
@@ -126,7 +126,7 @@
|
|
|
126
126
|
},
|
|
127
127
|
{
|
|
128
128
|
"path": "meta.ts",
|
|
129
|
-
"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"
|
|
129
|
+
"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"
|
|
130
130
|
}
|
|
131
131
|
],
|
|
132
132
|
"dependencies": [],
|