@supersoniks/concorde 5.1.1 → 5.1.2
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/.agents/skills/concorde-docs/SKILL.md +153 -0
- package/.agents/skills/{concorde-component-docs/template.md → concorde-docs/templates/component.md} +6 -2
- package/.agents/skills/concorde-docs/templates/decorator.md +43 -0
- package/.agents/skills/concorde-docs/templates/guide.md +25 -0
- package/.tmp-cem/custom-elements.json +503 -503
- package/PLAN-DOCS-AGENTS.md +80 -0
- package/README.md +3 -3
- package/ai/skills/concorde/SKILL.md +1 -1
- package/ai/skills/concorde-get-set-dp/SKILL.md +3 -3
- package/ai/skills/concorde-theme/SKILL.md +1 -1
- package/build-infos.json +1 -1
- package/concorde-core.bundle.js +1 -1
- package/concorde-core.es.js +1 -1
- package/dist/concorde-core.bundle.js +1 -1
- package/dist/concorde-core.es.js +1 -1
- package/docs/.htaccess +75 -0
- package/docs/404.html +15 -0
- package/docs/404.md +5 -0
- package/docs/assets/{index-Bb-_LRyY.js → index-BgG6FFPt.js} +2582 -3097
- package/docs/assets/index-x89XINSG.css +1 -0
- package/docs/core/components/functional/date/date.html +211 -0
- package/docs/core/components/functional/date/date.md +150 -0
- package/docs/core/components/functional/fetch/fetch.html +180 -0
- package/docs/core/components/functional/fetch/fetch.md +108 -0
- package/docs/core/components/functional/if/if.html +65 -0
- package/docs/core/components/functional/if/if.md +34 -0
- package/docs/core/components/functional/jsonata/jsonata.html +110 -0
- package/docs/core/components/functional/jsonata/jsonata.md +61 -0
- package/docs/core/components/functional/list/list.html +198 -0
- package/docs/core/components/functional/list/list.md +121 -0
- package/docs/core/components/functional/mix/mix.html +78 -0
- package/docs/core/components/functional/mix/mix.md +46 -0
- package/docs/core/components/functional/queue/queue.html +155 -0
- package/docs/core/components/functional/queue/queue.md +51 -0
- package/docs/core/components/functional/router/router.html +154 -0
- package/docs/core/components/functional/router/router.md +93 -0
- package/docs/core/components/functional/sdui/sdui-extension-points.html +127 -0
- package/docs/core/components/functional/sdui/sdui-extension-points.md +94 -0
- package/docs/core/components/functional/sdui/sdui.html +397 -0
- package/docs/core/components/functional/sdui/sdui.md +307 -0
- package/docs/core/components/functional/states/states.html +141 -0
- package/docs/core/components/functional/states/states.md +112 -0
- package/docs/core/components/functional/submit/submit.html +178 -0
- package/docs/core/components/functional/submit/submit.md +106 -0
- package/docs/core/components/functional/subscriber/subscriber.html +68 -0
- package/docs/core/components/functional/subscriber/subscriber.md +91 -0
- package/docs/core/components/functional/translation/translation.html +60 -0
- package/docs/core/components/functional/translation/translation.md +38 -0
- package/docs/core/components/functional/value/value.html +81 -0
- package/docs/core/components/functional/value/value.md +47 -0
- package/docs/core/components/ui/alert/alert.html +201 -0
- package/docs/core/components/ui/alert/alert.md +186 -0
- package/docs/core/components/ui/alert-messages/alert-messages.html +132 -0
- package/docs/core/components/ui/alert-messages/alert-messages.md +85 -0
- package/docs/core/components/ui/badge/badge.html +197 -0
- package/docs/core/components/ui/badge/badge.md +181 -0
- package/docs/core/components/ui/button/button.html +309 -0
- package/docs/core/components/ui/button/button.md +216 -0
- package/docs/core/components/ui/captcha/captcha.html +80 -0
- package/docs/core/components/ui/captcha/captcha.md +56 -0
- package/docs/core/components/ui/card/card.html +254 -0
- package/docs/core/components/ui/card/card.md +215 -0
- package/docs/core/components/ui/divider/divider.html +144 -0
- package/docs/core/components/ui/divider/divider.md +126 -0
- package/docs/core/components/ui/form/checkbox/checkbox.html +200 -0
- package/docs/core/components/ui/form/checkbox/checkbox.md +125 -0
- package/docs/core/components/ui/form/fieldset/fieldset.html +238 -0
- package/docs/core/components/ui/form/fieldset/fieldset.md +161 -0
- package/docs/core/components/ui/form/form-actions/form-actions.html +122 -0
- package/docs/core/components/ui/form/form-actions/form-actions.md +98 -0
- package/docs/core/components/ui/form/form-layout/form-layout.html +115 -0
- package/docs/core/components/ui/form/form-layout/form-layout.md +109 -0
- package/docs/core/components/ui/form/input/input.html +235 -0
- package/docs/core/components/ui/form/input/input.md +142 -0
- package/docs/core/components/ui/form/radio/radio.html +144 -0
- package/docs/core/components/ui/form/radio/radio.md +78 -0
- package/docs/core/components/ui/form/select/select.html +178 -0
- package/docs/core/components/ui/form/select/select.md +86 -0
- package/docs/core/components/ui/form/switch/switch.html +146 -0
- package/docs/core/components/ui/form/switch/switch.md +80 -0
- package/docs/core/components/ui/form/textarea/textarea.html +162 -0
- package/docs/core/components/ui/form/textarea/textarea.md +82 -0
- package/docs/core/components/ui/group/group.html +113 -0
- package/docs/core/components/ui/group/group.md +77 -0
- package/docs/core/components/ui/icon/icon.html +223 -0
- package/docs/core/components/ui/icon/icon.md +214 -0
- package/docs/core/components/ui/image/image.html +194 -0
- package/docs/core/components/ui/image/image.md +167 -0
- package/docs/core/components/ui/link/link.html +101 -0
- package/docs/core/components/ui/link/link.md +81 -0
- package/docs/core/components/ui/loader/loader.html +114 -0
- package/docs/core/components/ui/loader/loader.md +87 -0
- package/docs/core/components/ui/menu/menu.html +395 -0
- package/docs/core/components/ui/menu/menu.md +370 -0
- package/docs/core/components/ui/modal/modal.html +324 -0
- package/docs/core/components/ui/modal/modal.md +211 -0
- package/docs/core/components/ui/pop/pop.html +250 -0
- package/docs/core/components/ui/pop/pop.md +216 -0
- package/docs/core/components/ui/progress/progress.html +132 -0
- package/docs/core/components/ui/progress/progress.md +109 -0
- package/docs/core/components/ui/table/table.html +333 -0
- package/docs/core/components/ui/table/table.md +267 -0
- package/docs/core/components/ui/theme/theme.html +116 -0
- package/docs/core/components/ui/theme/theme.md +97 -0
- package/docs/core/components/ui/toast/toast.html +185 -0
- package/docs/core/components/ui/toast/toast.md +147 -0
- package/docs/core/components/ui/tooltip/tooltip.html +112 -0
- package/docs/core/components/ui/tooltip/tooltip.md +89 -0
- package/docs/docs/decorators/ancestor-attribute.html +71 -0
- package/docs/docs/decorators/ancestor-attribute.md +59 -0
- package/docs/docs/decorators/auto-subscribe.html +61 -0
- package/docs/docs/decorators/auto-subscribe.md +40 -0
- package/docs/docs/decorators/bind.html +86 -0
- package/docs/docs/decorators/bind.md +77 -0
- package/docs/docs/decorators/get.html +166 -0
- package/docs/docs/decorators/get.md +160 -0
- package/docs/docs/decorators/handle.html +139 -0
- package/docs/docs/decorators/handle.md +119 -0
- package/docs/docs/decorators/on-assign.html +72 -0
- package/docs/docs/decorators/on-assign.md +63 -0
- package/docs/docs/decorators/patch.html +76 -0
- package/docs/docs/decorators/patch.md +44 -0
- package/docs/docs/decorators/post.html +150 -0
- package/docs/docs/decorators/post.md +134 -0
- package/docs/docs/decorators/publish.html +74 -0
- package/docs/docs/decorators/publish.md +56 -0
- package/docs/docs/decorators/put.html +83 -0
- package/docs/docs/decorators/put.md +51 -0
- package/docs/docs/decorators/subscribe.html +91 -0
- package/docs/docs/decorators/subscribe.md +87 -0
- package/docs/docs/decorators/wait-for-ancestors.html +82 -0
- package/docs/docs/decorators/wait-for-ancestors.md +76 -0
- package/docs/docs/directives/sub.html +79 -0
- package/docs/docs/directives/sub.md +75 -0
- package/docs/docs/directives/t.html +91 -0
- package/docs/docs/directives/t.md +73 -0
- package/docs/docs/getting-started/ai-agents.html +174 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/ai-agents.md +3 -3
- package/docs/docs/getting-started/components.html +27 -0
- package/docs/docs/getting-started/create-a-component.html +108 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/create-a-component.md +3 -6
- package/docs/docs/getting-started/dataFlow.html +174 -0
- package/{src/docs/_core-concept → docs/docs/getting-started}/dataFlow.md +17 -18
- package/docs/docs/getting-started/installation.html +69 -0
- package/docs/docs/getting-started/installation.md +36 -0
- package/docs/docs/getting-started/my-first-component.html +180 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/my-first-component.md +5 -14
- package/docs/docs/getting-started/start.html +47 -0
- package/{src/docs/_getting-started → docs/docs/getting-started}/start.md +1 -13
- package/docs/docs/getting-started/theming.html +334 -0
- package/docs/docs/index.html +99 -0
- package/docs/docs/misc/api-configuration.html +149 -0
- package/{src/docs/_misc → docs/docs/misc}/api-configuration.md +10 -12
- package/docs/docs/misc/dataProviderKey.html +136 -0
- package/{src/docs/_misc → docs/docs/misc}/dataProviderKey.md +4 -4
- package/docs/docs/misc/docs-mock-api.html +155 -0
- package/{src/docs/_misc → docs/docs/misc}/docs-mock-api.md +12 -13
- package/docs/docs/misc/dynamic-path.html +181 -0
- package/{src/docs/_misc → docs/docs/misc}/dynamic-path.md +8 -8
- package/docs/docs/misc/endpoint.html +51 -0
- package/{src/docs/_misc → docs/docs/misc}/endpoint.md +8 -8
- package/docs/docs/misc/html-integration.html +45 -0
- package/{src/docs/_misc → docs/docs/misc}/html-integration.md +4 -5
- package/docs/docs-mock-api-sw.js +58 -223
- package/docs/docs-mock-api-sw.js.map +4 -4
- package/docs/hubs/decorators.html +443 -0
- package/docs/hubs/form-components.html +404 -0
- package/docs/hubs/remote-data.html +371 -0
- package/docs/img/archive/concorde-001-2cv.webp +0 -0
- package/docs/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
- package/docs/img/archive/concorde-red-arrows-2002.webm +0 -0
- package/docs/img/archive/credits.json +28 -0
- package/docs/img/concorde/plane_01.jpg +0 -0
- package/docs/img/concorde/plane_02.jpg +0 -0
- package/docs/img/concorde/plane_03.jpg +0 -0
- package/docs/img/concorde/plane_04.jpg +0 -0
- package/docs/img/concorde/plane_05.jpg +0 -0
- package/docs/img/concorde/plane_06.jpg +0 -0
- package/docs/img/concorde/plane_07.jpg +0 -0
- package/docs/img/concorde/plane_08.jpg +0 -0
- package/docs/img/concorde/plane_09.jpg +0 -0
- package/docs/img/concorde/plane_10.jpg +0 -0
- package/docs/img/concorde/plane_11.jpg +0 -0
- package/docs/img/concorde/plane_12.jpg +0 -0
- package/docs/img/concorde/plane_13.jpg +0 -0
- package/docs/index.html +95 -68
- package/docs/index.md +22 -0
- package/docs/llms-full.txt +5795 -0
- package/docs/llms.txt +106 -0
- package/docs/robots.txt +11 -10
- package/docs/sitemap.xml +237 -0
- package/docs/src/core/components/functional/date/date.md +150 -0
- package/docs/src/core/components/functional/fetch/fetch.md +108 -0
- package/docs/src/core/components/functional/if/if.md +34 -0
- package/docs/src/core/components/functional/jsonata/jsonata.md +61 -0
- package/docs/src/core/components/functional/list/list.md +121 -0
- package/docs/src/core/components/functional/mix/mix.md +46 -0
- package/docs/src/core/components/functional/queue/queue.md +51 -0
- package/docs/src/core/components/functional/router/router.md +93 -0
- package/docs/src/core/components/functional/sdui/component-catalog.gaps.json +511 -0
- package/docs/src/core/components/functional/sdui/component-catalog.json +3103 -0
- package/docs/src/core/components/functional/sdui/default-library.json +108 -0
- package/docs/src/core/components/functional/sdui/example.json +32 -0
- package/docs/src/core/components/functional/sdui/sdui-extension-points.md +94 -0
- package/docs/src/core/components/functional/sdui/sdui.md +307 -0
- package/docs/src/core/components/functional/states/states.md +112 -0
- package/docs/src/core/components/functional/submit/submit.md +106 -0
- package/docs/src/core/components/functional/subscriber/subscriber.md +91 -0
- package/docs/src/core/components/functional/translation/translation.md +38 -0
- package/docs/src/core/components/functional/value/value.md +47 -0
- package/docs/src/core/components/ui/alert/alert.md +186 -0
- package/docs/src/core/components/ui/alert-messages/alert-messages.md +85 -0
- package/docs/src/core/components/ui/badge/badge.md +181 -0
- package/docs/src/core/components/ui/button/button.md +216 -0
- package/docs/src/core/components/ui/captcha/captcha.md +56 -0
- package/docs/src/core/components/ui/card/card.md +215 -0
- package/docs/src/core/components/ui/divider/divider.md +126 -0
- package/docs/src/core/components/ui/form/checkbox/checkbox.md +125 -0
- package/docs/src/core/components/ui/form/fieldset/fieldset.md +161 -0
- package/docs/src/core/components/ui/form/form-actions/form-actions.md +98 -0
- package/docs/src/core/components/ui/form/form-layout/form-layout.md +109 -0
- package/docs/src/core/components/ui/form/input/input.md +142 -0
- package/docs/src/core/components/ui/form/radio/radio.md +78 -0
- package/docs/src/core/components/ui/form/select/select.md +86 -0
- package/docs/src/core/components/ui/form/switch/switch.md +80 -0
- package/docs/src/core/components/ui/form/textarea/textarea.md +82 -0
- package/docs/src/core/components/ui/group/group.md +77 -0
- package/docs/src/core/components/ui/icon/icon.md +214 -0
- package/docs/src/core/components/ui/icon/icons.json +1 -0
- package/docs/src/core/components/ui/image/image.md +167 -0
- package/docs/src/core/components/ui/link/link.md +81 -0
- package/docs/src/core/components/ui/loader/loader.md +87 -0
- package/docs/src/core/components/ui/menu/menu.md +370 -0
- package/docs/src/core/components/ui/modal/modal.md +211 -0
- package/docs/src/core/components/ui/pop/pop.md +216 -0
- package/docs/src/core/components/ui/progress/progress.md +109 -0
- package/docs/src/core/components/ui/table/table.md +267 -0
- package/docs/src/core/components/ui/theme/theme.md +97 -0
- package/docs/src/core/components/ui/toast/toast.md +147 -0
- package/docs/src/core/components/ui/tooltip/tooltip.md +89 -0
- package/docs/src/docs/decorators/ancestor-attribute.md +59 -0
- package/docs/src/docs/decorators/auto-subscribe.md +40 -0
- package/docs/src/docs/decorators/bind.md +77 -0
- package/docs/src/docs/decorators/get.md +160 -0
- package/docs/src/docs/decorators/handle.md +119 -0
- package/docs/src/docs/decorators/on-assign.md +63 -0
- package/docs/src/docs/decorators/patch.md +44 -0
- package/docs/src/docs/decorators/post.md +134 -0
- package/docs/src/docs/decorators/publish.md +56 -0
- package/docs/src/docs/decorators/put.md +51 -0
- package/docs/src/docs/decorators/subscribe.md +87 -0
- package/docs/src/docs/decorators/wait-for-ancestors.md +76 -0
- package/docs/src/docs/directives/sub.md +75 -0
- package/docs/src/docs/directives/t.md +73 -0
- package/docs/src/docs/getting-started/ai-agents.md +76 -0
- package/docs/src/docs/getting-started/components.md +5 -0
- package/docs/src/docs/getting-started/create-a-component.md +136 -0
- package/docs/src/docs/getting-started/dataFlow.md +87 -0
- package/docs/src/docs/getting-started/installation.md +36 -0
- package/docs/src/docs/getting-started/my-first-component.md +227 -0
- package/docs/src/docs/getting-started/start.md +35 -0
- package/docs/src/docs/getting-started/theming.md +253 -0
- package/docs/src/docs/misc/api-configuration.md +79 -0
- package/docs/src/docs/misc/dataProviderKey.md +168 -0
- package/docs/src/docs/misc/docs-mock-api.md +62 -0
- package/docs/src/docs/misc/dynamic-path.md +71 -0
- package/docs/src/docs/misc/endpoint.md +45 -0
- package/docs/src/docs/misc/html-integration.md +14 -0
- package/docs/src/docs/search/docs-search.json +10287 -0
- package/docs/src/tag-list.json +1 -0
- package/docs/src/tsconfig-model.json +23 -0
- package/docs/src/tsconfig.json +1353 -0
- package/index.html +68 -5
- package/package.json +1 -1
- package/public/docs-mock-api-sw.js +58 -223
- package/public/docs-mock-api-sw.js.map +4 -4
- package/public/img/concorde/plane_01.jpg +0 -0
- package/public/img/concorde/plane_02.jpg +0 -0
- package/public/img/concorde/plane_03.jpg +0 -0
- package/public/img/concorde/plane_04.jpg +0 -0
- package/public/img/concorde/plane_05.jpg +0 -0
- package/public/img/concorde/plane_06.jpg +0 -0
- package/public/img/concorde/plane_07.jpg +0 -0
- package/public/img/concorde/plane_08.jpg +0 -0
- package/public/img/concorde/plane_09.jpg +0 -0
- package/public/img/concorde/plane_10.jpg +0 -0
- package/public/img/concorde/plane_11.jpg +0 -0
- package/public/img/concorde/plane_12.jpg +0 -0
- package/public/img/concorde/plane_13.jpg +0 -0
- package/public/robots.txt +11 -10
- package/scripts/docs-markdown-vite-plugin.ts +37 -0
- package/scripts/docs-public-url.mjs +50 -0
- package/scripts/docs.htaccess +75 -0
- package/scripts/generate-crawl-docs.mjs +207 -116
- package/scripts/generate-crawl-docs.test.mjs +124 -0
- package/scripts/post-build-docs.js +34 -50
- package/src/core/components/functional/date/date.md +91 -231
- package/src/core/components/functional/fetch/fetch.md +66 -83
- package/src/core/components/functional/if/if.md +28 -3
- package/src/core/components/functional/jsonata/jsonata.md +42 -37
- package/src/core/components/functional/list/list.md +99 -43
- package/src/core/components/functional/mix/mix.md +31 -26
- package/src/core/components/functional/queue/queue.demo.ts +10 -7
- package/src/core/components/functional/queue/queue.md +40 -61
- package/src/core/components/functional/router/router.demo.ts +16 -16
- package/src/core/components/functional/router/router.md +64 -65
- package/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
- package/src/core/components/functional/sdui/component-catalog.json +1 -1
- package/src/core/components/functional/sdui/example.json +19 -86
- package/src/core/components/functional/sdui/sdui-extension-points.md +1 -1
- package/src/core/components/functional/sdui/sdui.md +187 -358
- package/src/core/components/functional/states/states.demo.ts +21 -22
- package/src/core/components/functional/states/states.md +86 -61
- package/src/core/components/functional/states/states.ts +1 -1
- package/src/core/components/functional/submit/submit.md +64 -72
- package/src/core/components/functional/translation/translation.md +38 -0
- package/src/core/components/functional/value/value.md +34 -22
- package/src/core/components/ui/alert/alert.md +48 -58
- package/src/core/components/ui/badge/badge.md +27 -34
- package/src/core/components/ui/button/button.md +139 -106
- package/src/core/components/ui/captcha/captcha.md +17 -32
- package/src/core/components/ui/card/card.md +6 -6
- package/src/core/components/ui/divider/divider.md +8 -11
- package/src/core/components/ui/form/checkbox/checkbox.md +90 -42
- package/src/core/components/ui/form/fieldset/fieldset.md +31 -75
- package/src/core/components/ui/form/form-actions/form-actions.md +14 -16
- package/src/core/components/ui/form/form-layout/form-layout.md +19 -29
- package/src/core/components/ui/form/input/input.md +95 -95
- package/src/core/components/ui/form/radio/radio.md +55 -34
- package/src/core/components/ui/form/select/select.md +60 -45
- package/src/core/components/ui/form/switch/switch.md +57 -34
- package/src/core/components/ui/form/textarea/textarea.md +55 -38
- package/src/core/components/ui/group/group.md +35 -33
- package/src/core/components/ui/icon/icon.md +4 -4
- package/src/core/components/ui/image/image.md +41 -107
- package/src/core/components/ui/link/link.md +6 -6
- package/src/core/components/ui/loader/loader.md +30 -55
- package/src/core/components/ui/menu/menu.md +27 -27
- package/src/core/components/ui/modal/modal.md +72 -96
- package/src/core/components/ui/pop/pop.md +80 -158
- package/src/core/components/ui/progress/progress.md +2 -2
- package/src/core/components/ui/table/table.md +91 -255
- package/src/core/components/ui/theme/theme.md +11 -36
- package/src/core/components/ui/toast/toast.md +48 -117
- package/src/core/components/ui/tooltip/tooltip.md +27 -62
- package/src/core/utils/LocationHandler.spec.ts +80 -0
- package/src/core/utils/LocationHandler.ts +5 -9
- package/src/docs/components/docs-demo-sources.ts +55 -140
- package/src/docs/components/docs-lit-demo.ts +1 -3
- package/src/docs/components/docs-source-link.ts +0 -82
- package/src/docs/decorators/ancestor-attribute.md +59 -0
- package/src/docs/decorators/auto-subscribe.md +40 -0
- package/src/docs/decorators/bind.md +77 -0
- package/src/docs/decorators/get.md +160 -0
- package/src/docs/decorators/handle.md +119 -0
- package/src/docs/decorators/on-assign.md +63 -0
- package/src/docs/decorators/patch.md +44 -0
- package/src/docs/decorators/post.md +134 -0
- package/src/docs/decorators/publish.md +56 -0
- package/src/docs/decorators/put.md +51 -0
- package/src/docs/decorators/subscribe.md +87 -0
- package/src/docs/decorators/wait-for-ancestors.md +76 -0
- package/src/docs/directives/sub.md +75 -0
- package/src/docs/directives/t.md +73 -0
- package/src/docs/docs-location.spec.ts +46 -0
- package/src/docs/docs-location.ts +123 -32
- package/src/docs/docs.ts +1 -2
- package/src/docs/example/decorators-demo-bind-demos.ts +81 -116
- package/src/docs/example/decorators-demo-geo.ts +30 -19
- package/src/docs/example/decorators-demo-post.ts +88 -186
- package/src/docs/example/decorators-demo-subscribe-publish-get-demos.ts +165 -268
- package/src/docs/example/decorators-demo.ts +85 -98
- package/src/docs/example/docs-api-config-demos.ts +19 -20
- package/src/docs/example/docs-flight-demos.ts +147 -0
- package/src/docs/example/docs-jsonata-demos.ts +52 -52
- package/src/docs/example/docs-list-demos.ts +43 -123
- package/src/docs/example/docs-provider-keys.ts +21 -28
- package/src/docs/example/docs-queue-demos.ts +37 -77
- package/src/docs/example/docs-router-demos.ts +20 -25
- package/src/docs/example/docs-submit-demos.ts +48 -48
- package/src/docs/example/docs-toggle-demos.ts +4 -3
- package/src/docs/getting-started/ai-agents.md +76 -0
- package/src/docs/getting-started/components.md +5 -0
- package/src/docs/getting-started/create-a-component.md +136 -0
- package/src/docs/getting-started/dataFlow.md +87 -0
- package/src/docs/getting-started/installation.md +36 -0
- package/src/docs/getting-started/my-first-component.md +227 -0
- package/src/docs/getting-started/start.md +35 -0
- package/src/docs/getting-started/theming.md +253 -0
- package/src/docs/header/header.ts +11 -6
- package/src/docs/home/catalog.ts +1 -1
- package/src/docs/home/home.ts +17 -10
- package/src/docs/layout.ts +12 -13
- package/src/docs/misc/api-configuration.md +79 -0
- package/src/docs/misc/dataProviderKey.md +168 -0
- package/src/docs/misc/docs-mock-api.md +62 -0
- package/src/docs/misc/dynamic-path.md +71 -0
- package/src/docs/misc/endpoint.md +45 -0
- package/src/docs/misc/html-integration.md +14 -0
- package/src/docs/mock-api/api-config-mock.ts +5 -0
- package/src/docs/mock-api/fixtures.ts +0 -278
- package/src/docs/mock-api/flights.ts +89 -0
- package/src/docs/mock-api/router.ts +3 -4
- package/src/docs/mock-api/urls.ts +1 -2
- package/src/docs/navigation/navigation.ts +82 -103
- package/src/docs/navigation/toc.ts +7 -4
- package/src/docs/search/docs-search.json +2845 -5110
- package/src/docs/search/markdown-renderer.ts +25 -7
- package/src/docs/search/page.ts +9 -6
- package/src/docs/search/search.ts +154 -122
- package/vite.config.mts +11 -2
- package/.agents/skills/concorde-component-docs/SKILL.md +0 -194
- package/docs/assets/index-CD4WyL6o.css +0 -1
- package/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +0 -29
- package/src/docs/_core-concept/overview.md +0 -57
- package/src/docs/_core-concept/subscriber.md +0 -75
- package/src/docs/_decorators/ancestor-attribute.md +0 -128
- package/src/docs/_decorators/auto-subscribe.md +0 -202
- package/src/docs/_decorators/bind.md +0 -167
- package/src/docs/_decorators/get.md +0 -162
- package/src/docs/_decorators/handle.md +0 -175
- package/src/docs/_decorators/on-assign.md +0 -390
- package/src/docs/_decorators/patch.md +0 -70
- package/src/docs/_decorators/post.md +0 -146
- package/src/docs/_decorators/publish.md +0 -55
- package/src/docs/_decorators/put.md +0 -70
- package/src/docs/_decorators/subscribe.md +0 -100
- package/src/docs/_decorators/wait-for-ancestors.md +0 -163
- package/src/docs/_directives/sub.md +0 -91
- package/src/docs/_getting-started/concorde-manual-install.md +0 -133
- package/src/docs/_getting-started/concorde-outside.md +0 -33
- package/src/docs/_getting-started/my-first-subscriber.md +0 -120
- package/src/docs/_getting-started/pubsub.md +0 -37
- package/src/docs/_misc/formelement-subscriber-removal.md +0 -115
- package/src/docs/example/docs-input-autocomplete-demos.ts +0 -110
- package/src/docs/example/docs-joke-demos.ts +0 -297
- /package/{src/docs/_getting-started → docs/docs/getting-started}/components.md +0 -0
- /package/{src/docs/_getting-started → docs/docs/getting-started}/theming.md +0 -0
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# Theme
|
|
2
|
+
|
|
3
|
+
**`sonic-theme`** is the root element of a Concorde UI: it holds the `--sc-*` design tokens, optionally applies a built-in palette, and is where popovers, modals and toasts are mounted. Import `@supersoniks/concorde/theme` once at the app entry and wrap your app in it. Token names and brand overrides are covered in [Theming](/docs/getting-started/theming).
|
|
4
|
+
|
|
5
|
+
## Basic example
|
|
6
|
+
|
|
7
|
+
<sonic-code>
|
|
8
|
+
<template>
|
|
9
|
+
<sonic-theme color font class="block bg-base p-6 rounded-lg">
|
|
10
|
+
<sonic-button type="primary">Save changes</sonic-button>
|
|
11
|
+
</sonic-theme>
|
|
12
|
+
</template>
|
|
13
|
+
</sonic-code>
|
|
14
|
+
|
|
15
|
+
## Theme mode
|
|
16
|
+
|
|
17
|
+
With no `theme` (or `theme="custom"`), only the core tokens and your own `--sc-*` overrides apply. `light` and `dark` apply the built-in palettes; `auto` switches between them with `prefers-color-scheme`.
|
|
18
|
+
|
|
19
|
+
<sonic-code>
|
|
20
|
+
<template>
|
|
21
|
+
<div class="grid gap-4 md:grid-cols-2">
|
|
22
|
+
<sonic-theme theme="light" color font class="block bg-base p-4 rounded-md border border-neutral-200">
|
|
23
|
+
<p class="text-sm mb-3 opacity-80">theme="light"</p>
|
|
24
|
+
<div class="flex flex-wrap gap-2">
|
|
25
|
+
<sonic-badge type="primary">Primary</sonic-badge>
|
|
26
|
+
<sonic-badge type="success">Success</sonic-badge>
|
|
27
|
+
<sonic-badge type="danger">Danger</sonic-badge>
|
|
28
|
+
</div>
|
|
29
|
+
</sonic-theme>
|
|
30
|
+
<sonic-theme theme="dark" color font class="block bg-base p-4 rounded-md">
|
|
31
|
+
<p class="text-sm mb-3 opacity-80">theme="dark"</p>
|
|
32
|
+
<div class="flex flex-wrap gap-2">
|
|
33
|
+
<sonic-badge type="primary">Primary</sonic-badge>
|
|
34
|
+
<sonic-badge type="success">Success</sonic-badge>
|
|
35
|
+
<sonic-badge type="danger">Danger</sonic-badge>
|
|
36
|
+
</div>
|
|
37
|
+
</sonic-theme>
|
|
38
|
+
</div>
|
|
39
|
+
</template>
|
|
40
|
+
</sonic-code>
|
|
41
|
+
|
|
42
|
+
## Text color and font
|
|
43
|
+
|
|
44
|
+
`color` sets the host text color to `--sc-base-content`. `font` applies the base font family, weight and style tokens. Both are off by default. To paint the background, add the Tailwind classes `block` and `bg-base` on the host.
|
|
45
|
+
|
|
46
|
+
<sonic-code>
|
|
47
|
+
<template>
|
|
48
|
+
<sonic-theme theme="light" color font class="block bg-base p-6 rounded-lg">
|
|
49
|
+
<p>Body copy inherits the base content color and font from the theme.</p>
|
|
50
|
+
</sonic-theme>
|
|
51
|
+
</template>
|
|
52
|
+
</sonic-code>
|
|
53
|
+
|
|
54
|
+
## Pop container
|
|
55
|
+
|
|
56
|
+
Overlays such as `sonic-modal` are appended to the last connected `sonic-theme`, or to `document.body` when there is none. `Theme.getPopContainer()` returns that element.
|
|
57
|
+
|
|
58
|
+
<sonic-code>
|
|
59
|
+
<template>
|
|
60
|
+
<sonic-theme theme="light" color font class="block bg-base p-4 rounded-lg">
|
|
61
|
+
<sonic-button onclick="document.getElementById('themePopModal').show()">
|
|
62
|
+
Open modal
|
|
63
|
+
</sonic-button>
|
|
64
|
+
<sonic-modal id="themePopModal">
|
|
65
|
+
<sonic-modal-title>Mounted on theme</sonic-modal-title>
|
|
66
|
+
<sonic-modal-content>
|
|
67
|
+
This dialog is appended under the nearest sonic-theme pop container.
|
|
68
|
+
</sonic-modal-content>
|
|
69
|
+
<sonic-modal-actions>
|
|
70
|
+
<sonic-button hideModal>Close</sonic-button>
|
|
71
|
+
</sonic-modal-actions>
|
|
72
|
+
</sonic-modal>
|
|
73
|
+
</sonic-theme>
|
|
74
|
+
</template>
|
|
75
|
+
</sonic-code>
|
|
76
|
+
|
|
77
|
+
## Embedded iframes
|
|
78
|
+
|
|
79
|
+
On connect, the theme posts its resolved `--sc-*` values and linked Google Fonts / Adobe Fonts stylesheets to every iframe on the page (message type `SonicTheme`). An iframe can ask for them again:
|
|
80
|
+
|
|
81
|
+
<sonic-code language="javascript">
|
|
82
|
+
<template>
|
|
83
|
+
window.parent.postMessage({ type: "GetSonicTheme" }, "*");
|
|
84
|
+
</template>
|
|
85
|
+
</sonic-code>
|
|
86
|
+
|
|
87
|
+
## API reference
|
|
88
|
+
|
|
89
|
+
| Attribute | Values | Description |
|
|
90
|
+
|----------|---------|-------------|
|
|
91
|
+
| `theme` | `custom` (default) · `light` · `dark` · `auto` | Built-in palette; `custom` applies core tokens and your overrides only |
|
|
92
|
+
| `color` | boolean | Host text color uses `--sc-base-content` |
|
|
93
|
+
| `font` | boolean | Host uses the base font family, weight and style tokens |
|
|
94
|
+
|
|
95
|
+
| Slot | Description |
|
|
96
|
+
|------|-------------|
|
|
97
|
+
| *(default)* | Application content |
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# Toast
|
|
2
|
+
|
|
3
|
+
Toasts show short-lived feedback in a fixed stack at the bottom right of the page. Call **`SonicToast.add()`** (also `window.SonicToast`); the **`sonic-toast`** host is created on first use. Use **`label`** for a heading and **`preserve`** when the user must read or act before the toast goes away.
|
|
4
|
+
|
|
5
|
+
## Basic example
|
|
6
|
+
|
|
7
|
+
<sonic-code>
|
|
8
|
+
<template>
|
|
9
|
+
<sonic-button onclick="SonicToast.add({ text: 'Flight CN 001 is now boarding' })">
|
|
10
|
+
Show toast
|
|
11
|
+
</sonic-button>
|
|
12
|
+
</template>
|
|
13
|
+
</sonic-code>
|
|
14
|
+
|
|
15
|
+
## Status
|
|
16
|
+
|
|
17
|
+
**`status`** sets the color, the icon and the live-region role. With no `status`, the toast is neutral.
|
|
18
|
+
|
|
19
|
+
<sonic-code>
|
|
20
|
+
<template>
|
|
21
|
+
<div class="flex flex-wrap gap-2">
|
|
22
|
+
<sonic-button onclick="SonicToast.add({ text: 'Default message' })">Default</sonic-button>
|
|
23
|
+
<sonic-button onclick="SonicToast.add({ text: 'Operation succeeded', status: 'success' })">Success</sonic-button>
|
|
24
|
+
<sonic-button onclick="SonicToast.add({ text: 'Something went wrong', status: 'error' })">Error</sonic-button>
|
|
25
|
+
<sonic-button onclick="SonicToast.add({ text: 'Check this detail', status: 'warning' })">Warning</sonic-button>
|
|
26
|
+
<sonic-button onclick="SonicToast.add({ text: 'Helpful context', status: 'info' })">Info</sonic-button>
|
|
27
|
+
</div>
|
|
28
|
+
</template>
|
|
29
|
+
</sonic-code>
|
|
30
|
+
|
|
31
|
+
## Label
|
|
32
|
+
|
|
33
|
+
**`label`** adds a bold heading above **`text`**. `title` is a deprecated alias.
|
|
34
|
+
|
|
35
|
+
<sonic-code>
|
|
36
|
+
<template>
|
|
37
|
+
<sonic-button
|
|
38
|
+
onclick="SonicToast.add({ label: 'Gate change', text: 'Flight CN 001 now departs from gate B12.', status: 'warning' })"
|
|
39
|
+
>
|
|
40
|
+
Toast with label
|
|
41
|
+
</sonic-button>
|
|
42
|
+
</template>
|
|
43
|
+
</sonic-code>
|
|
44
|
+
|
|
45
|
+
## HTML in text
|
|
46
|
+
|
|
47
|
+
**`text`** and **`label`** accept HTML strings. A link or form control in **`text`** turns on **`preserve`** automatically.
|
|
48
|
+
|
|
49
|
+
<sonic-code>
|
|
50
|
+
<template>
|
|
51
|
+
<sonic-button
|
|
52
|
+
onclick="SonicToast.add({ text: 'Message with <strong>HTML</strong> and an <a href="#">action link</a>', status: 'info' })"
|
|
53
|
+
>
|
|
54
|
+
Toast with HTML
|
|
55
|
+
</sonic-button>
|
|
56
|
+
</template>
|
|
57
|
+
</sonic-code>
|
|
58
|
+
|
|
59
|
+
## Preserve
|
|
60
|
+
|
|
61
|
+
Toasts hide after 6 seconds; the timer pauses on hover and focus. **`preserve`** keeps the toast until the user closes it.
|
|
62
|
+
|
|
63
|
+
<sonic-code>
|
|
64
|
+
<template>
|
|
65
|
+
<sonic-button
|
|
66
|
+
onclick="SonicToast.add({ text: 'Turbulence ahead: please fasten your seat belt', status: 'info', preserve: true })"
|
|
67
|
+
>
|
|
68
|
+
Persistent toast
|
|
69
|
+
</sonic-button>
|
|
70
|
+
</template>
|
|
71
|
+
</sonic-code>
|
|
72
|
+
|
|
73
|
+
## Dismiss forever
|
|
74
|
+
|
|
75
|
+
With **`dismissForever`** and a stable **`id`**, closing the toast is stored in `localStorage` and later `add()` calls with that `id` are ignored. A toast identical to one already shown (ignoring `id`) is never added twice.
|
|
76
|
+
|
|
77
|
+
<sonic-code>
|
|
78
|
+
<template>
|
|
79
|
+
<sonic-button
|
|
80
|
+
onclick="SonicToast.add({ id: 'welcome-toast', label: 'Welcome', text: 'Close me and I will not come back after a reload.', status: 'info', dismissForever: true })"
|
|
81
|
+
>
|
|
82
|
+
Dismiss forever
|
|
83
|
+
</sonic-button>
|
|
84
|
+
</template>
|
|
85
|
+
</sonic-code>
|
|
86
|
+
|
|
87
|
+
## Ghost
|
|
88
|
+
|
|
89
|
+
**`ghost`** renders a semi-transparent, non-interactive toast, for example for a background task.
|
|
90
|
+
|
|
91
|
+
<sonic-code>
|
|
92
|
+
<template>
|
|
93
|
+
<sonic-button
|
|
94
|
+
onclick="SonicToast.add({ text: 'Syncing in the background', status: 'info', ghost: true })"
|
|
95
|
+
>
|
|
96
|
+
Ghost toast
|
|
97
|
+
</sonic-button>
|
|
98
|
+
</template>
|
|
99
|
+
</sonic-code>
|
|
100
|
+
|
|
101
|
+
## Removing toasts
|
|
102
|
+
|
|
103
|
+
Static helpers clear the stack from script, for example after navigation. **`removeAll()`** keeps ghost toasts; **`removeTemporaryItems()`** keeps preserved ones.
|
|
104
|
+
|
|
105
|
+
<sonic-code>
|
|
106
|
+
<template>
|
|
107
|
+
<div class="flex flex-wrap gap-2">
|
|
108
|
+
<sonic-button onclick="SonicToast.add({ text: 'Temporary success', status: 'success' })">Add success</sonic-button>
|
|
109
|
+
<sonic-button onclick="SonicToast.add({ text: 'Temporary error', status: 'error' })">Add error</sonic-button>
|
|
110
|
+
<sonic-button onclick="SonicToast.add({ text: 'Persistent info', status: 'info', preserve: true })">Add persistent</sonic-button>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="flex flex-wrap gap-2 mt-3">
|
|
113
|
+
<sonic-button variant="outline" onclick="SonicToast.removeItemsByStatus('success')">Remove success</sonic-button>
|
|
114
|
+
<sonic-button variant="outline" onclick="SonicToast.removeTemporaryItems()">Remove temporary</sonic-button>
|
|
115
|
+
<sonic-button variant="outline" onclick="SonicToast.removeAll()">Remove all</sonic-button>
|
|
116
|
+
</div>
|
|
117
|
+
</template>
|
|
118
|
+
</sonic-code>
|
|
119
|
+
|
|
120
|
+
Inside an iframe, toasts are forwarded to the parent window's stack when the parent also loads Concorde.
|
|
121
|
+
|
|
122
|
+
## API reference
|
|
123
|
+
|
|
124
|
+
Options of **`SonicToast.add(options)`**:
|
|
125
|
+
|
|
126
|
+
| Option | Values | Description |
|
|
127
|
+
|----------|---------|-------------|
|
|
128
|
+
| `text` | string · Lit template | Body, required; HTML strings allowed |
|
|
129
|
+
| `label` | string · Lit template | Heading above `text` |
|
|
130
|
+
| `title` | string · Lit template | Deprecated alias of `label` |
|
|
131
|
+
| `status` | `success` · `error` · `warning` · `info` (default neutral) | Color and icon; `error` gets `role="alert"`, others `role="status"` |
|
|
132
|
+
| `id` | string · number (default timestamp) | Identifier for `removeItemById` and `dismissForever` |
|
|
133
|
+
| `preserve` | boolean | No auto-hide; forced when `text` contains a link or control |
|
|
134
|
+
| `ghost` | boolean | Semi-transparent and non-interactive; kept by `removeAll` |
|
|
135
|
+
| `dismissForever` | boolean | Remember the dismissal in `localStorage`; needs a stable `id` |
|
|
136
|
+
| `styleSheet` | `CSSResult` · `CSSStyleSheet` · array | Extra styles adopted by the toast |
|
|
137
|
+
| `useSlot` | boolean | Legacy: render `text` in the light DOM |
|
|
138
|
+
|
|
139
|
+
| Method | Description |
|
|
140
|
+
|--------|-------------|
|
|
141
|
+
| `SonicToast.add(options)` | Show a toast; returns the stored config, or `null` when skipped |
|
|
142
|
+
| `SonicToast.removeAll()` | Remove every toast except ghosts |
|
|
143
|
+
| `SonicToast.removeItemsByStatus(status)` | Remove toasts with this `status` |
|
|
144
|
+
| `SonicToast.removeItemById(id)` | Remove one toast |
|
|
145
|
+
| `SonicToast.removeTemporaryItems()` | Remove toasts without `preserve` |
|
|
146
|
+
|
|
147
|
+
`sonic-toast` and `sonic-toast-item` are created by `add()`; do not write them in markup. `sonic-toast-message-subscriber` shows a toast for each `{ type: "public", content, status }` entry of its `messages` property.
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
# Tooltip
|
|
2
|
+
|
|
3
|
+
**`sonic-tooltip`** shows a short `label` in a bubble when the trigger in the default slot is hovered or receives focus. With no `placement`, the bubble sits on `top`, centered. An empty `label` hides the bubble, like `disabled`.
|
|
4
|
+
|
|
5
|
+
## Basic example
|
|
6
|
+
|
|
7
|
+
<sonic-code>
|
|
8
|
+
<template>
|
|
9
|
+
<sonic-tooltip label="Cruising at Mach 2.04">
|
|
10
|
+
<sonic-button variant="outline">Hover me</sonic-button>
|
|
11
|
+
</sonic-tooltip>
|
|
12
|
+
</template>
|
|
13
|
+
</sonic-code>
|
|
14
|
+
|
|
15
|
+
## Placement
|
|
16
|
+
|
|
17
|
+
`top` · `bottom` · `left` · `right` set the side. Add `-start` or `-end` to align the bubble with an edge of the trigger instead of its center. The bubble is repositioned while open to stay in the viewport.
|
|
18
|
+
|
|
19
|
+
<sonic-code>
|
|
20
|
+
<template>
|
|
21
|
+
<div class="flex flex-wrap gap-3">
|
|
22
|
+
<sonic-tooltip placement="top" label="top"><sonic-button minWidth="9rem">top</sonic-button></sonic-tooltip>
|
|
23
|
+
<sonic-tooltip placement="top-start" label="top-start"><sonic-button minWidth="9rem">top-start</sonic-button></sonic-tooltip>
|
|
24
|
+
<sonic-tooltip placement="top-end" label="top-end"><sonic-button minWidth="9rem">top-end</sonic-button></sonic-tooltip>
|
|
25
|
+
<sonic-tooltip placement="bottom" label="bottom"><sonic-button minWidth="9rem">bottom</sonic-button></sonic-tooltip>
|
|
26
|
+
<sonic-tooltip placement="bottom-start" label="bottom-start"><sonic-button minWidth="9rem">bottom-start</sonic-button></sonic-tooltip>
|
|
27
|
+
<sonic-tooltip placement="bottom-end" label="bottom-end"><sonic-button minWidth="9rem">bottom-end</sonic-button></sonic-tooltip>
|
|
28
|
+
<sonic-tooltip placement="left" label="left"><sonic-button minWidth="9rem">left</sonic-button></sonic-tooltip>
|
|
29
|
+
<sonic-tooltip placement="left-start" label="left-start"><sonic-button minWidth="9rem">left-start</sonic-button></sonic-tooltip>
|
|
30
|
+
<sonic-tooltip placement="left-end" label="left-end"><sonic-button minWidth="9rem">left-end</sonic-button></sonic-tooltip>
|
|
31
|
+
<sonic-tooltip placement="right" label="right"><sonic-button minWidth="9rem">right</sonic-button></sonic-tooltip>
|
|
32
|
+
<sonic-tooltip placement="right-start" label="right-start"><sonic-button minWidth="9rem">right-start</sonic-button></sonic-tooltip>
|
|
33
|
+
<sonic-tooltip placement="right-end" label="right-end"><sonic-button minWidth="9rem">right-end</sonic-button></sonic-tooltip>
|
|
34
|
+
</div>
|
|
35
|
+
</template>
|
|
36
|
+
</sonic-code>
|
|
37
|
+
|
|
38
|
+
## Multiline label
|
|
39
|
+
|
|
40
|
+
Line breaks in `label` (a real newline or ` `) are kept. Each line is trimmed and the bubble wraps at `18rem`.
|
|
41
|
+
|
|
42
|
+
<sonic-code>
|
|
43
|
+
<template>
|
|
44
|
+
<sonic-tooltip label="Gate B12 Boarding at 08:15">
|
|
45
|
+
<sonic-button variant="outline">Multiline label</sonic-button>
|
|
46
|
+
</sonic-tooltip>
|
|
47
|
+
</template>
|
|
48
|
+
</sonic-code>
|
|
49
|
+
|
|
50
|
+
## Focusable
|
|
51
|
+
|
|
52
|
+
Set `focusable` when the trigger is not focusable itself (text, icon): the host gets `tabindex="0"` so keyboard users can open the tooltip. The bubble uses `popover="hint"`; without Popover API support, the label falls back to a native `title` on one line.
|
|
53
|
+
|
|
54
|
+
<sonic-code>
|
|
55
|
+
<template>
|
|
56
|
+
<sonic-tooltip
|
|
57
|
+
focusable
|
|
58
|
+
label="The Concorde made its first transatlantic crossing on September 26, 1973"
|
|
59
|
+
>
|
|
60
|
+
<sonic-icon library="iconoir" name="chat-bubble-question"></sonic-icon>
|
|
61
|
+
Focus or hover this text
|
|
62
|
+
</sonic-tooltip>
|
|
63
|
+
</template>
|
|
64
|
+
</sonic-code>
|
|
65
|
+
|
|
66
|
+
## Disabled
|
|
67
|
+
|
|
68
|
+
`disabled` never shows the bubble and sets `tabindex="-1"` on the host.
|
|
69
|
+
|
|
70
|
+
<sonic-code>
|
|
71
|
+
<template>
|
|
72
|
+
<sonic-tooltip disabled label="Not shown">
|
|
73
|
+
<sonic-button>Tooltip disabled</sonic-button>
|
|
74
|
+
</sonic-tooltip>
|
|
75
|
+
</template>
|
|
76
|
+
</sonic-code>
|
|
77
|
+
|
|
78
|
+
## API reference
|
|
79
|
+
|
|
80
|
+
| Attribute | Values | Description |
|
|
81
|
+
|----------|---------|-------------|
|
|
82
|
+
| `label` | string | Tooltip text; empty or whitespace-only hides the bubble |
|
|
83
|
+
| `placement` | `top` (default) · `bottom` · `left` · `right`, each with optional `-start` · `-end` | Side and alignment relative to the trigger |
|
|
84
|
+
| `disabled` | boolean | Never show the bubble; sets `tabindex="-1"` on the host |
|
|
85
|
+
| `focusable` | boolean | Sets `tabindex="0"` on the host so the tooltip opens on keyboard focus |
|
|
86
|
+
|
|
87
|
+
| Slot | Description |
|
|
88
|
+
|------|-------------|
|
|
89
|
+
| *(default)* | Trigger content |
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# @ancestorAttribute
|
|
2
|
+
|
|
3
|
+
Copies the value of an attribute from the nearest element that carries it (the host itself, then its ancestors, across shadow roots) into a class property. Use it to pick up a scope such as `dataProvider` without passing it down by hand, typically to feed a dynamic key of [@subscribe](/docs/decorators/subscribe).
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
<sonic-code language="typescript">
|
|
8
|
+
<template>
|
|
9
|
+
import { ancestorAttribute } from "@supersoniks/concorde/decorators";
|
|
10
|
+
|
|
11
|
+
@ancestorAttribute("dataProvider")
|
|
12
|
+
dataProvider: string | null = null;
|
|
13
|
+
</template>
|
|
14
|
+
</sonic-code>
|
|
15
|
+
|
|
16
|
+
## Read once at connect
|
|
17
|
+
|
|
18
|
+
By default the value is read once, just before the component's `connectedCallback`, and never updated. The closest element with the attribute wins. If no ancestor has it, the property keeps its initial value.
|
|
19
|
+
|
|
20
|
+
<sonic-code>
|
|
21
|
+
<template>
|
|
22
|
+
<div dataProvider="flights.CN001" gate="B12">
|
|
23
|
+
<docs-demo-sources for="demo-ancestor-attribute"></docs-demo-sources>
|
|
24
|
+
<demo-ancestor-attribute></demo-ancestor-attribute>
|
|
25
|
+
</div>
|
|
26
|
+
</template>
|
|
27
|
+
</sonic-code>
|
|
28
|
+
|
|
29
|
+
An attribute present without a value (`<div gate>`) resolves to `""`. A camelCase name also matches its lowercase form (`dataProvider` and `dataprovider`).
|
|
30
|
+
|
|
31
|
+
## Follow DOM changes
|
|
32
|
+
|
|
33
|
+
With `{ dynamic: true }`, the property stays in sync while the component is connected: when an ancestor changes the attribute, when a closer ancestor gains or loses it, and when the component is moved. When no ancestor has the attribute, the property becomes `null`. Add `@state()` so Lit re-renders on each assignment.
|
|
34
|
+
|
|
35
|
+
<sonic-code language="typescript">
|
|
36
|
+
<template>
|
|
37
|
+
@ancestorAttribute("dataProvider", { dynamic: true })
|
|
38
|
+
@state()
|
|
39
|
+
dataProvider: string | null = null;
|
|
40
|
+
</template>
|
|
41
|
+
</sonic-code>
|
|
42
|
+
|
|
43
|
+
Change the parent or outer value, insert a closer wrapper, or remove an attribute: the child always shows the nearest one.
|
|
44
|
+
|
|
45
|
+
<sonic-code>
|
|
46
|
+
<template>
|
|
47
|
+
<docs-demo-sources for="demo-ancestor-attribute-dynamic-section"></docs-demo-sources>
|
|
48
|
+
<demo-ancestor-attribute-dynamic-section></demo-ancestor-attribute-dynamic-section>
|
|
49
|
+
</template>
|
|
50
|
+
</sonic-code>
|
|
51
|
+
|
|
52
|
+
Keys of [@subscribe](/docs/decorators/subscribe) and [@bind](/docs/decorators/bind) that use the property as a placeholder (`"${dataProvider}"`) are re-resolved on each change.
|
|
53
|
+
|
|
54
|
+
## API reference
|
|
55
|
+
|
|
56
|
+
| Argument | Type | Description |
|
|
57
|
+
|----------|------|-------------|
|
|
58
|
+
| `attributeName` | `string` | Attribute to look up on the host, then on its ancestors |
|
|
59
|
+
| `options.dynamic` | `boolean` (default `false`) | Keep the property in sync with attribute changes and reparenting until disconnect; assigns `null` when no ancestor has the attribute |
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# @autoSubscribe
|
|
2
|
+
|
|
3
|
+
Legacy decorator that re-runs a method whenever one of the store values it reads is assigned. For new code, prefer [@subscribe](/docs/decorators/subscribe) with a [`DataProviderKey`](/docs/misc/dataProviderKey): dependencies are explicit and typed.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
<sonic-code language="typescript">
|
|
8
|
+
<template>
|
|
9
|
+
import { autoSubscribe } from "@supersoniks/concorde/decorators";
|
|
10
|
+
import { get } from "@supersoniks/concorde/utils";
|
|
11
|
+
|
|
12
|
+
@autoSubscribe()
|
|
13
|
+
updateDisplay() {
|
|
14
|
+
this.total = get(passengersKey) + get(crewKey);
|
|
15
|
+
}
|
|
16
|
+
</template>
|
|
17
|
+
</sonic-code>
|
|
18
|
+
|
|
19
|
+
## Tracked reads
|
|
20
|
+
|
|
21
|
+
The method runs once after `connectedCallback`. Every store value read during that run becomes a dependency; assigning any of them runs the method again. Write the result to a `@state()` property (or call `requestUpdate()`) so the component re-renders.
|
|
22
|
+
|
|
23
|
+
<sonic-code>
|
|
24
|
+
<template>
|
|
25
|
+
<docs-demo-sources for="demo-auto-subscribe"></docs-demo-sources>
|
|
26
|
+
<demo-auto-subscribe></demo-auto-subscribe>
|
|
27
|
+
</template>
|
|
28
|
+
</sonic-code>
|
|
29
|
+
|
|
30
|
+
## Notes
|
|
31
|
+
|
|
32
|
+
- Several assignments in the same task trigger a single re-run (batched with `queueMicrotask`).
|
|
33
|
+
- Keep reads unconditional: a value read only behind a condition becomes a dependency the first time that branch runs.
|
|
34
|
+
- Subscriptions are removed in `disconnectedCallback`.
|
|
35
|
+
|
|
36
|
+
## API reference
|
|
37
|
+
|
|
38
|
+
| Argument | Type | Description |
|
|
39
|
+
|----------|------|-------------|
|
|
40
|
+
| none | | `@autoSubscribe()` takes no argument; apply it to a method of a custom element |
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# @bind
|
|
2
|
+
|
|
3
|
+
Keeps a class property in sync with a path of the DataProvider store, in both directions when needed. Pass a dot-notation string or a [DataProviderKey](/docs/misc/dataProviderKey); add `{ reflect: true }` to push local writes back to the store. For read-only sync prefer [@subscribe](/docs/decorators/subscribe), and see [Data flow](/docs/getting-started/dataFlow) for the overall model.
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
<sonic-code language="typescript">
|
|
8
|
+
<template>
|
|
9
|
+
import { bind } from "@supersoniks/concorde/decorators";
|
|
10
|
+
|
|
11
|
+
@bind("flight.gate")
|
|
12
|
+
@state()
|
|
13
|
+
gate = "";
|
|
14
|
+
</template>
|
|
15
|
+
</sonic-code>
|
|
16
|
+
|
|
17
|
+
## Basic usage
|
|
18
|
+
|
|
19
|
+
The first path segment is the data provider id, the rest is dot notation (array items use a numeric index: `passengers.0`). The property updates each time the store value changes. Add `@state()` so Lit re-renders.
|
|
20
|
+
|
|
21
|
+
<sonic-code>
|
|
22
|
+
<template>
|
|
23
|
+
<docs-demo-sources for="demo-bind"></docs-demo-sources>
|
|
24
|
+
<demo-bind></demo-bind>
|
|
25
|
+
</template>
|
|
26
|
+
</sonic-code>
|
|
27
|
+
|
|
28
|
+
## Typed key
|
|
29
|
+
|
|
30
|
+
With a `DataProviderKey<T>`, TypeScript checks that the property type matches `T` at that path.
|
|
31
|
+
|
|
32
|
+
<sonic-code language="typescript">
|
|
33
|
+
<template>
|
|
34
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
35
|
+
|
|
36
|
+
type Flight = { flight: string; gate: string; boarded: number };
|
|
37
|
+
const flightKey = new DataProviderKey<Flight>("flight");
|
|
38
|
+
|
|
39
|
+
@bind(flightKey.boarded, { reflect: true })
|
|
40
|
+
@state()
|
|
41
|
+
boarded = 0;
|
|
42
|
+
</template>
|
|
43
|
+
</sonic-code>
|
|
44
|
+
|
|
45
|
+
## Reflect
|
|
46
|
+
|
|
47
|
+
By default (`reflect: false`) the binding is one-way: assigning the property does not touch the store. With `reflect: true`, each assignment calls `set()` on the publisher, so every other subscriber sees the new value. An internal guard prevents update loops.
|
|
48
|
+
|
|
49
|
+
<sonic-code>
|
|
50
|
+
<template>
|
|
51
|
+
<docs-demo-sources for="demo-bind-reflect"></docs-demo-sources>
|
|
52
|
+
<demo-bind-reflect></demo-bind-reflect>
|
|
53
|
+
</template>
|
|
54
|
+
</sonic-code>
|
|
55
|
+
|
|
56
|
+
## Dynamic path
|
|
57
|
+
|
|
58
|
+
Placeholders such as `${index}` are resolved from properties of the same component, and `@bind` re-subscribes when they change. Write them in a plain string, not a backtick template literal. While a placeholder is `null` or `undefined` the binding is inactive; `{ skipEmptyPlaceholder: true }` also waits on `""`. Full rules: [Dynamic paths](/docs/misc/dynamic-path).
|
|
59
|
+
|
|
60
|
+
<sonic-code>
|
|
61
|
+
<template>
|
|
62
|
+
<docs-demo-sources for="demo-bind-dynamic"></docs-demo-sources>
|
|
63
|
+
<demo-bind-dynamic></demo-bind-dynamic>
|
|
64
|
+
</template>
|
|
65
|
+
</sonic-code>
|
|
66
|
+
|
|
67
|
+
## Lifecycle
|
|
68
|
+
|
|
69
|
+
The decorator subscribes in `connectedCallback` and unsubscribes in `disconnectedCallback`. It works on any element with that lifecycle (`LitElement`, the `Subscriber` mixin).
|
|
70
|
+
|
|
71
|
+
## API reference
|
|
72
|
+
|
|
73
|
+
| Argument | Type | Description |
|
|
74
|
+
|----------|------|-------------|
|
|
75
|
+
| `path` | `string` or `DataProviderKey<T>` | Store path to bind. Supports `${prop}` placeholders |
|
|
76
|
+
| `options.reflect` | `boolean` (default `false`) | Write local assignments back to the store |
|
|
77
|
+
| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
# @get
|
|
2
|
+
|
|
3
|
+
`@get(endpoint)` runs an HTTP GET on an [Endpoint](/docs/misc/endpoint) and stores the full `ApiResult<T>` in a property, or passes it to a method. It runs again when the endpoint's placeholders or the API configuration change, and on demand through `refetch`. For writes, see [@post](/docs/decorators/post), [@put](/docs/decorators/put) and [@patch](/docs/decorators/patch).
|
|
4
|
+
|
|
5
|
+
## Import
|
|
6
|
+
|
|
7
|
+
<sonic-code language="typescript">
|
|
8
|
+
<template>
|
|
9
|
+
import { get, Endpoint, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
10
|
+
|
|
11
|
+
type FlightBoard = { flights: Flight[] };
|
|
12
|
+
const departuresEndpoint = new Endpoint<FlightBoard>("flights?direction=departures");
|
|
13
|
+
|
|
14
|
+
@get(departuresEndpoint)
|
|
15
|
+
@state()
|
|
16
|
+
departures?: ApiResult<FlightBoard>;
|
|
17
|
+
</template>
|
|
18
|
+
</sonic-code>
|
|
19
|
+
|
|
20
|
+
## Property
|
|
21
|
+
|
|
22
|
+
The property is `undefined` until the first response, then holds `result` (typed `T`), `response` (the HTTP response) and `request`. It is reset to `undefined` when the component disconnects.
|
|
23
|
+
|
|
24
|
+
Without a configuration key, `serviceURL` and the token are read from the HTML scope: place the component under an element that sets them (see [API configuration](/docs/misc/api-configuration)). The GET waits until `serviceURL` is available.
|
|
25
|
+
|
|
26
|
+
<sonic-code>
|
|
27
|
+
<template>
|
|
28
|
+
<docs-demo-sources for="demo-api-get"></docs-demo-sources>
|
|
29
|
+
<demo-api-get></demo-api-get>
|
|
30
|
+
</template>
|
|
31
|
+
</sonic-code>
|
|
32
|
+
|
|
33
|
+
## Method
|
|
34
|
+
|
|
35
|
+
Decorate a method to receive the `ApiResult<T>` after each GET instead of storing it.
|
|
36
|
+
|
|
37
|
+
<sonic-code language="typescript">
|
|
38
|
+
<template>
|
|
39
|
+
@get(departuresEndpoint)
|
|
40
|
+
onDepartures(payload?: ApiResult<FlightBoard>) {
|
|
41
|
+
this.boarding = payload?.result?.flights.filter((f) => f.status === "boarding") ?? [];
|
|
42
|
+
}
|
|
43
|
+
</template>
|
|
44
|
+
</sonic-code>
|
|
45
|
+
|
|
46
|
+
<sonic-code>
|
|
47
|
+
<template>
|
|
48
|
+
<docs-demo-sources for="demo-api-get-method"></docs-demo-sources>
|
|
49
|
+
<demo-api-get-method></demo-api-get-method>
|
|
50
|
+
</template>
|
|
51
|
+
</sonic-code>
|
|
52
|
+
|
|
53
|
+
## Configuration key
|
|
54
|
+
|
|
55
|
+
Pass a `DataProviderKey<APIConfiguration>` as the second argument to read the configuration from the store instead of the HTML scope. Any change to that publisher runs the GET again.
|
|
56
|
+
|
|
57
|
+
<sonic-code language="typescript">
|
|
58
|
+
<template>
|
|
59
|
+
import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
60
|
+
import type { APIConfiguration } from "@supersoniks/concorde/utils/api";
|
|
61
|
+
|
|
62
|
+
const flightsApi = new DataProviderKey<APIConfiguration>("flightsApi");
|
|
63
|
+
|
|
64
|
+
@get(departuresEndpoint, flightsApi)
|
|
65
|
+
@state()
|
|
66
|
+
departures?: ApiResult<FlightBoard>;
|
|
67
|
+
</template>
|
|
68
|
+
</sonic-code>
|
|
69
|
+
|
|
70
|
+
## Dynamic endpoint
|
|
71
|
+
|
|
72
|
+
`${prop}` placeholders in the endpoint resolve from properties of the same component; each change runs a new GET. While a placeholder is `null` or `undefined`, no request is sent and the property is `undefined`. Rules: [Dynamic paths](/docs/misc/dynamic-path).
|
|
73
|
+
|
|
74
|
+
<sonic-code language="typescript">
|
|
75
|
+
<template>
|
|
76
|
+
const boardEndpoint = new Endpoint<FlightBoard, { direction: string }>(
|
|
77
|
+
"flights?direction=${direction}",
|
|
78
|
+
);
|
|
79
|
+
|
|
80
|
+
@property() direction = "departures";
|
|
81
|
+
|
|
82
|
+
@get(boardEndpoint, flightsApi)
|
|
83
|
+
@state()
|
|
84
|
+
board?: ApiResult<FlightBoard>;
|
|
85
|
+
</template>
|
|
86
|
+
</sonic-code>
|
|
87
|
+
|
|
88
|
+
<sonic-code>
|
|
89
|
+
<template>
|
|
90
|
+
<docs-demo-sources for="demo-api-get-configuration-key"></docs-demo-sources>
|
|
91
|
+
<demo-api-get-configuration-key></demo-api-get-configuration-key>
|
|
92
|
+
</template>
|
|
93
|
+
</sonic-code>
|
|
94
|
+
|
|
95
|
+
## Refetch
|
|
96
|
+
|
|
97
|
+
Keep the decorator in a constant to reuse it. `refetch(component)` runs the GET for that instance only and resolves with the new `ApiResult<T>` (or `undefined`).
|
|
98
|
+
|
|
99
|
+
<sonic-code language="typescript">
|
|
100
|
+
<template>
|
|
101
|
+
const departuresGet = get(departuresEndpoint);
|
|
102
|
+
|
|
103
|
+
@departuresGet
|
|
104
|
+
@state()
|
|
105
|
+
departures?: ApiResult<FlightBoard>;
|
|
106
|
+
|
|
107
|
+
async refresh() {
|
|
108
|
+
await departuresGet.refetch(this);
|
|
109
|
+
}
|
|
110
|
+
</template>
|
|
111
|
+
</sonic-code>
|
|
112
|
+
|
|
113
|
+
`@refetch(handle)` does the same around a method. By default the GET runs **after** the method (and after its Promise, if it returns one); use `{ when: "before" }` to run it first. The method call resolves once the GET is done.
|
|
114
|
+
|
|
115
|
+
<sonic-code language="typescript">
|
|
116
|
+
<template>
|
|
117
|
+
import { refetch } from "@supersoniks/concorde/decorators";
|
|
118
|
+
|
|
119
|
+
@refetch(departuresGet)
|
|
120
|
+
async showArrivals() {
|
|
121
|
+
this.direction = "arrivals";
|
|
122
|
+
}
|
|
123
|
+
</template>
|
|
124
|
+
</sonic-code>
|
|
125
|
+
|
|
126
|
+
## Polling and triggers
|
|
127
|
+
|
|
128
|
+
`refetchEveryMs` runs the GET again that many milliseconds after each response (default `0`: off). `triggerKey` runs it whenever another component calls `invalidate()` on that publisher.
|
|
129
|
+
|
|
130
|
+
<sonic-code language="typescript">
|
|
131
|
+
<template>
|
|
132
|
+
import { dp } from "@supersoniks/concorde/utils";
|
|
133
|
+
|
|
134
|
+
const boardRefresh = new DataProviderKey<number>("boardRefresh");
|
|
135
|
+
|
|
136
|
+
@get(departuresEndpoint, { refetchEveryMs: 30000, triggerKey: boardRefresh })
|
|
137
|
+
@state()
|
|
138
|
+
departures?: ApiResult<FlightBoard>;
|
|
139
|
+
|
|
140
|
+
// anywhere else
|
|
141
|
+
dp(boardRefresh).invalidate();
|
|
142
|
+
</template>
|
|
143
|
+
</sonic-code>
|
|
144
|
+
|
|
145
|
+
## API reference
|
|
146
|
+
|
|
147
|
+
| Argument | Type | Description |
|
|
148
|
+
|----------|------|-------------|
|
|
149
|
+
| `endpoint` | `Endpoint<T, U>` | Path relative to `serviceURL`. `U` lists the host properties used by `${…}` placeholders |
|
|
150
|
+
| `configurationKey` | `DataProviderKey<APIConfiguration>` (optional) | Read the configuration from the store instead of the HTML scope |
|
|
151
|
+
| `options.refetchEveryMs` | `number` (default `0`) | Polling interval after each response; `0` disables it |
|
|
152
|
+
| `options.triggerKey` | `DataProviderKey<unknown>` | Publisher whose `invalidate()` runs the GET again |
|
|
153
|
+
| `options.skipEmptyPlaceholder` | `boolean` (default `false`) | Treat a placeholder resolved to `""` as not ready |
|
|
154
|
+
|
|
155
|
+
`options` is the second argument, or the third when a `configurationKey` is passed. The returned decorator exposes `refetch(component): Promise<ApiResult<T> | undefined>`.
|
|
156
|
+
|
|
157
|
+
| `@refetch` argument | Type | Description |
|
|
158
|
+
|---------------------|------|-------------|
|
|
159
|
+
| `handle` | value returned by `get(…)` | GET to run |
|
|
160
|
+
| `options.when` | `"before"` or `"after"` (default `"after"`) | Run the GET before or after the method |
|