@supersoniks/concorde 5.1.0 → 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/.claude/launch.json +15 -0
- package/.claude/vite.http.config.mjs +7 -0
- package/.taste-skill/after/desktop-fold.jpg +0 -0
- package/.taste-skill/after/desktop-page-01.jpg +0 -0
- package/.taste-skill/after/desktop-page-02.jpg +0 -0
- package/.taste-skill/after/desktop-page-03.jpg +0 -0
- package/.taste-skill/after/mobile-fold.jpg +0 -0
- package/.taste-skill/after/mobile-page-01.jpg +0 -0
- package/.taste-skill/after/report.json +4103 -0
- package/.taste-skill/after/tablet-fold.jpg +0 -0
- package/.taste-skill/after/tablet-page-01.jpg +0 -0
- package/.taste-skill/after/tablet-page-02.jpg +0 -0
- package/.taste-skill/before/desktop-fold.jpg +0 -0
- package/.taste-skill/before/desktop-page-01.jpg +0 -0
- package/.taste-skill/before/desktop-page-02.jpg +0 -0
- package/.taste-skill/before/mobile-fold.jpg +0 -0
- package/.taste-skill/before/mobile-page-01.jpg +0 -0
- package/.taste-skill/before/report.json +2556 -0
- package/.taste-skill/before/tablet-fold.jpg +0 -0
- package/.taste-skill/before/tablet-page-01.jpg +0 -0
- package/.taste-skill/direction.json +510 -0
- package/.taste-skill/notes.md +84 -0
- package/.taste-skill/prod/desktop-fold.jpg +0 -0
- package/.taste-skill/prod/desktop-page-01.jpg +0 -0
- package/.taste-skill/prod/desktop-page-02.jpg +0 -0
- package/.taste-skill/prod/desktop-page-03.jpg +0 -0
- package/.taste-skill/prod/mobile-fold.jpg +0 -0
- package/.taste-skill/prod/mobile-page-01.jpg +0 -0
- package/.taste-skill/prod/mobile-page-02.jpg +0 -0
- package/.taste-skill/prod/report.json +1973 -0
- package/.taste-skill/prod/tablet-fold.jpg +0 -0
- package/.taste-skill/prod/tablet-page-01.jpg +0 -0
- package/.taste-skill/prod/tablet-page-02.jpg +0 -0
- package/.tmp-cem/custom-elements.json +2013 -2013
- package/AUDIT.md +228 -0
- package/PLAN-AMELIORATION.md +220 -0
- 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 +16 -16
- package/concorde-core.es.js +235 -233
- package/dist/concorde-core.bundle.js +16 -16
- package/dist/concorde-core.es.js +235 -233
- package/dist/img/archive/concorde-001-2cv.webp +0 -0
- package/dist/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
- package/dist/img/archive/concorde-red-arrows-2002.webm +0 -0
- package/dist/img/archive/credits.json +28 -0
- package/docs/.htaccess +75 -0
- package/docs/404.html +15 -0
- package/docs/404.md +5 -0
- package/docs/assets/index-BgG6FFPt.js +11765 -0
- 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/{crawl/core → core}/components/functional/subscriber/subscriber.html +6 -5
- 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/{crawl/core → core}/components/ui/menu/menu.html +189 -116
- 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/{crawl/docs/_getting-started → docs/getting-started}/ai-agents.html +12 -11
- 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/components.md +5 -0
- package/docs/{crawl/docs/_getting-started → docs/getting-started}/create-a-component.html +11 -14
- package/docs/{src/docs/_getting-started → docs/getting-started}/create-a-component.md +3 -6
- package/docs/{crawl/docs/_core-concept → docs/getting-started}/dataFlow.html +26 -29
- package/docs/{src/docs/_core-concept → 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/{crawl/docs/_getting-started → docs/getting-started}/my-first-component.html +13 -22
- package/docs/{src/docs/_getting-started → 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/{src/docs/_getting-started → docs/docs/getting-started}/theming.md +2 -2
- package/docs/docs/index.html +99 -0
- package/docs/{crawl/docs/_misc → docs/misc}/api-configuration.html +18 -18
- package/docs/{src/docs/_misc → docs/misc}/api-configuration.md +10 -12
- package/docs/{crawl/docs/_misc → docs/misc}/dataProviderKey.html +12 -11
- package/{src/docs/_misc → docs/docs/misc}/dataProviderKey.md +4 -4
- package/docs/{crawl/docs/_misc → docs/misc}/docs-mock-api.html +25 -28
- package/docs/{src/docs/_misc → docs/misc}/docs-mock-api.md +12 -13
- package/docs/{crawl/docs/_misc → docs/misc}/dynamic-path.html +16 -15
- package/{src/docs/_misc → docs/docs/misc}/dynamic-path.md +8 -8
- package/docs/{crawl/docs/_misc → docs/misc}/endpoint.html +16 -15
- package/{src/docs/_misc → docs/docs/misc}/endpoint.md +8 -8
- package/docs/{crawl/docs/_misc → docs/misc}/html-integration.html +12 -15
- package/docs/{src/docs/_misc → docs/misc}/html-integration.md +4 -5
- package/docs/docs-mock-api-sw.js +60 -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 +96 -67
- package/docs/index.md +22 -0
- package/docs/llms-full.txt +3329 -3295
- package/docs/llms.txt +94 -92
- package/docs/robots.txt +11 -10
- package/docs/sitemap.xml +78 -78
- package/docs/src/core/components/functional/date/date.md +91 -231
- package/docs/src/core/components/functional/fetch/fetch.md +66 -83
- package/docs/src/core/components/functional/if/if.md +28 -3
- package/docs/src/core/components/functional/jsonata/jsonata.md +42 -37
- package/docs/src/core/components/functional/list/list.md +99 -43
- package/docs/src/core/components/functional/mix/mix.md +31 -26
- package/docs/src/core/components/functional/queue/queue.md +40 -61
- package/docs/src/core/components/functional/router/router.md +64 -65
- 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/example.json +19 -86
- package/docs/src/core/components/functional/sdui/sdui-extension-points.md +94 -0
- package/docs/src/core/components/functional/sdui/sdui.md +196 -245
- package/docs/src/core/components/functional/states/states.md +86 -61
- package/docs/src/core/components/functional/submit/submit.md +64 -72
- package/docs/src/core/components/functional/translation/translation.md +38 -0
- package/docs/src/core/components/functional/value/value.md +34 -22
- package/docs/src/core/components/ui/alert/alert.md +139 -74
- package/docs/src/core/components/ui/alert-messages/alert-messages.md +85 -0
- package/docs/src/core/components/ui/badge/badge.md +137 -83
- package/docs/src/core/components/ui/button/button.md +139 -105
- package/docs/src/core/components/ui/captcha/captcha.md +50 -6
- package/docs/src/core/components/ui/card/card.md +183 -65
- package/docs/src/core/components/ui/divider/divider.md +104 -13
- package/docs/src/core/components/ui/form/checkbox/checkbox.md +90 -42
- package/docs/src/core/components/ui/form/fieldset/fieldset.md +135 -103
- package/docs/src/core/components/ui/form/form-actions/form-actions.md +71 -50
- package/docs/src/core/components/ui/form/form-layout/form-layout.md +99 -34
- package/docs/src/core/components/ui/form/input/input.md +95 -95
- package/docs/src/core/components/ui/form/radio/radio.md +55 -34
- package/docs/src/core/components/ui/form/select/select.md +60 -45
- package/docs/src/core/components/ui/form/switch/switch.md +57 -34
- package/docs/src/core/components/ui/form/textarea/textarea.md +55 -38
- package/docs/src/core/components/ui/group/group.md +49 -47
- package/docs/src/core/components/ui/icon/icon.md +132 -43
- package/docs/src/core/components/ui/image/image.md +132 -72
- package/docs/src/core/components/ui/link/link.md +46 -8
- package/docs/src/core/components/ui/loader/loader.md +55 -23
- package/docs/src/core/components/ui/menu/menu.md +155 -114
- package/docs/src/core/components/ui/modal/modal.md +154 -62
- package/docs/src/core/components/ui/pop/pop.md +185 -65
- package/docs/src/core/components/ui/progress/progress.md +76 -30
- package/docs/src/core/components/ui/table/table.md +146 -334
- package/docs/src/core/components/ui/theme/theme.md +97 -0
- package/docs/src/core/components/ui/toast/toast.md +80 -99
- package/docs/src/core/components/ui/tooltip/tooltip.md +52 -45
- 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 → getting-started}/ai-agents.md +3 -3
- package/docs/src/docs/getting-started/components.md +5 -0
- package/{src/docs/_getting-started → docs/src/docs/getting-started}/create-a-component.md +3 -6
- package/{src/docs/_core-concept → docs/src/docs/getting-started}/dataFlow.md +17 -18
- package/docs/src/docs/getting-started/installation.md +36 -0
- package/{src/docs/_getting-started → docs/src/docs/getting-started}/my-first-component.md +5 -14
- package/docs/src/docs/getting-started/start.md +35 -0
- package/docs/src/docs/getting-started/theming.md +253 -0
- package/{src/docs/_misc → docs/src/docs/misc}/api-configuration.md +10 -12
- package/docs/src/docs/{_misc → misc}/dataProviderKey.md +4 -4
- package/{src/docs/_misc → docs/src/docs/misc}/docs-mock-api.md +12 -13
- package/docs/src/docs/{_misc → misc}/dynamic-path.md +8 -8
- package/docs/src/docs/{_misc → misc}/endpoint.md +8 -8
- package/{src/docs/_misc → docs/src/docs/misc}/html-integration.md +4 -5
- package/docs/src/docs/search/docs-search.json +3729 -2949
- package/docs/src/tsconfig.json +176 -5
- package/index.html +94 -67
- package/package.json +11 -4
- package/public/docs-mock-api-sw.js +58 -223
- package/public/docs-mock-api-sw.js.map +4 -4
- package/public/img/archive/concorde-001-2cv.webp +0 -0
- package/public/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
- package/public/img/archive/concorde-red-arrows-2002.webm +0 -0
- package/public/img/archive/credits.json +28 -0
- 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/scripts/post-build.mjs +0 -0
- 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/if/if.ts +0 -0
- package/src/core/components/functional/jsonata/jsonata.md +42 -37
- package/src/core/components/functional/list/list.demo.ts +0 -0
- 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/router/router.ts +0 -0
- package/src/core/components/functional/sdui/SDUIDescriptorTransformer.ts +0 -0
- 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/sdui/types.ts +0 -0
- 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/subscriber/subscriber.ts +0 -0
- package/src/core/components/functional/translation/translation.md +38 -0
- package/src/core/components/functional/value/value.md +34 -22
- package/src/core/components/functional/value/value.ts +0 -0
- package/src/core/components/ui/_css/size.ts +0 -0
- 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/altchaStyles.ts +0 -0
- 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/modal/modal.ts +14 -11
- 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/mixins/Subscriber.ts +0 -0
- package/src/core/utils/DataBindObserver.ts +0 -0
- package/src/core/utils/LocationHandler.spec.ts +80 -0
- package/src/core/utils/LocationHandler.ts +5 -9
- package/src/core/utils/Objects.ts +0 -0
- package/src/core/utils/route.ts +0 -0
- package/src/docs/code.ts +88 -75
- package/src/docs/components/docs-demo-sources.ts +70 -147
- package/src/docs/components/docs-lit-demo.ts +20 -40
- 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 +6 -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-boarding-pass-demo.ts +134 -0
- 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 +33 -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/example/users.ts +0 -0
- 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 +240 -71
- package/src/docs/home/catalog.ts +44 -0
- package/src/docs/home/home.ts +520 -0
- package/src/docs/home/mach-stage.ts +389 -0
- package/src/docs/layout.ts +12 -11
- 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/components-index.ts +56 -0
- package/src/docs/navigation/navigation.ts +219 -232
- package/src/docs/navigation/pager.ts +67 -0
- package/src/docs/navigation/toc.ts +101 -0
- package/src/docs/search/docs-search.json +2419 -4374
- package/src/docs/search/markdown-renderer.ts +33 -7
- package/src/docs/search/page.ts +9 -6
- package/src/docs/search/search.ts +154 -122
- package/src/docs/shiki/index.ts +109 -0
- package/src/docs/tailwind/css/base/scrollbar.css +22 -0
- package/src/docs/tailwind/css/base/theme.css +96 -0
- package/src/docs/tailwind/css/base/typography.css +4 -0
- package/src/docs/tailwind/css/docs/boarding-pass.css +65 -0
- package/src/docs/tailwind/css/docs/content.css +32 -0
- package/src/docs/tailwind/css/docs/page.css +10 -0
- package/src/docs/tailwind/css/docs.css +9 -0
- package/src/docs/tailwind/css/home/hero.css +210 -0
- package/src/docs/tailwind/css/home/motion.css +84 -0
- package/src/docs/tailwind/css/home/sections.css +416 -0
- package/src/docs/tailwind/css/tailwind.css +7 -185
- package/src/tsconfig.json +23 -2
- package/src/tsconfig.tsbuildinfo +1 -1
- package/tailwind.config.js +8 -4
- package/vite.config.mts +11 -2
- package/.agents/skills/concorde-component-docs/SKILL.md +0 -194
- package/.github/workflows/ci.yml +0 -21
- package/.github-export-ignore +0 -30
- package/CONTRIBUTING.md +0 -59
- package/DEV.md +0 -54
- package/LICENSE +0 -21
- package/OPEN_SOURCE_CHECKPOINT.md +0 -133
- package/concorde-3d.bundle.js +0 -3960
- package/concorde-3d.es.js +0 -33433
- package/concorde-hugging-face-infer.bundle.js +0 -32
- package/concorde-hugging-face-infer.es.js +0 -2952
- package/concorde-interactive.bundle.js +0 -1157
- package/concorde-interactive.es.js +0 -10734
- package/concorde-shader.bundle.js +0 -116
- package/concorde-shader.es.js +0 -8353
- package/concorde-webgpu.bundle.js +0 -307
- package/concorde-webgpu.es.js +0 -8627
- package/docs/assets/index-D8MVWqY6.js +0 -12251
- package/docs/assets/index-DiD0qYvE.css +0 -1
- package/docs/crawl/core/components/functional/date/date.html +0 -190
- package/docs/crawl/core/components/functional/fetch/fetch.html +0 -109
- package/docs/crawl/core/components/functional/if/if.html +0 -27
- package/docs/crawl/core/components/functional/jsonata/jsonata.html +0 -79
- package/docs/crawl/core/components/functional/list/list.html +0 -70
- package/docs/crawl/core/components/functional/mix/mix.html +0 -45
- package/docs/crawl/core/components/functional/queue/queue.html +0 -96
- package/docs/crawl/core/components/functional/router/router.html +0 -106
- package/docs/crawl/core/components/functional/sdui/sdui.html +0 -269
- package/docs/crawl/core/components/functional/states/states.html +0 -66
- package/docs/crawl/core/components/functional/submit/submit.html +0 -160
- package/docs/crawl/core/components/functional/value/value.html +0 -51
- package/docs/crawl/core/components/ui/alert/alert.html +0 -110
- package/docs/crawl/core/components/ui/alert-messages/alert-messages.html +0 -23
- package/docs/crawl/core/components/ui/badge/badge.html +0 -119
- package/docs/crawl/core/components/ui/button/button.html +0 -149
- package/docs/crawl/core/components/ui/captcha/captcha.html +0 -30
- package/docs/crawl/core/components/ui/card/card.html +0 -99
- package/docs/crawl/core/components/ui/divider/divider.html +0 -58
- package/docs/crawl/core/components/ui/form/checkbox/checkbox.html +0 -73
- package/docs/crawl/core/components/ui/form/fieldset/fieldset.html +0 -135
- package/docs/crawl/core/components/ui/form/form-actions/form-actions.html +0 -79
- package/docs/crawl/core/components/ui/form/form-layout/form-layout.html +0 -62
- package/docs/crawl/core/components/ui/form/input/input.html +0 -109
- package/docs/crawl/core/components/ui/form/input-autocomplete/input-autocomplete.html +0 -38
- package/docs/crawl/core/components/ui/form/radio/radio.html +0 -56
- package/docs/crawl/core/components/ui/form/select/select.html +0 -73
- package/docs/crawl/core/components/ui/form/switch/switch.html +0 -56
- package/docs/crawl/core/components/ui/form/textarea/textarea.html +0 -59
- package/docs/crawl/core/components/ui/group/group.html +0 -82
- package/docs/crawl/core/components/ui/icon/icon.html +0 -133
- package/docs/crawl/core/components/ui/image/image.html +0 -110
- package/docs/crawl/core/components/ui/link/link.html +0 -42
- package/docs/crawl/core/components/ui/loader/loader.html +0 -50
- package/docs/crawl/core/components/ui/modal/modal.html +0 -117
- package/docs/crawl/core/components/ui/pop/pop.html +0 -102
- package/docs/crawl/core/components/ui/progress/progress.html +0 -58
- package/docs/crawl/core/components/ui/table/table.html +0 -413
- package/docs/crawl/core/components/ui/toast/toast.html +0 -122
- package/docs/crawl/core/components/ui/tooltip/tooltip.html +0 -79
- package/docs/crawl/docs/_core-concept/overview.html +0 -66
- package/docs/crawl/docs/_core-concept/subscriber.html +0 -75
- package/docs/crawl/docs/_decorators/ancestor-attribute.html +0 -116
- package/docs/crawl/docs/_decorators/auto-subscribe.html +0 -202
- package/docs/crawl/docs/_decorators/bind.html +0 -141
- package/docs/crawl/docs/_decorators/get.html +0 -149
- package/docs/crawl/docs/_decorators/handle.html +0 -165
- package/docs/crawl/docs/_decorators/on-assign.html +0 -355
- package/docs/crawl/docs/_decorators/patch.html +0 -78
- package/docs/crawl/docs/_decorators/post.html +0 -139
- package/docs/crawl/docs/_decorators/publish.html +0 -61
- package/docs/crawl/docs/_decorators/put.html +0 -78
- package/docs/crawl/docs/_decorators/subscribe.html +0 -109
- package/docs/crawl/docs/_decorators/wait-for-ancestors.html +0 -137
- package/docs/crawl/docs/_directives/sub.html +0 -93
- package/docs/crawl/docs/_getting-started/concorde-manual-install.html +0 -100
- package/docs/crawl/docs/_getting-started/concorde-outside.html +0 -58
- package/docs/crawl/docs/_getting-started/my-first-subscriber.html +0 -110
- package/docs/crawl/docs/_getting-started/pubsub.html +0 -62
- package/docs/crawl/docs/_getting-started/start.html +0 -76
- package/docs/crawl/docs/_getting-started/theming.html +0 -85
- package/docs/crawl/docs/_misc/formelement-subscriber-removal.html +0 -138
- package/docs/crawl/hubs/decorators.html +0 -547
- package/docs/crawl/hubs/form-components.html +0 -359
- package/docs/crawl/hubs/remote-data.html +0 -452
- package/docs/crawl/index.html +0 -101
- package/docs/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +0 -29
- package/docs/src/docs/_core-concept/overview.md +0 -57
- package/docs/src/docs/_core-concept/subscriber.md +0 -75
- package/docs/src/docs/_decorators/ancestor-attribute.md +0 -127
- package/docs/src/docs/_decorators/auto-subscribe.md +0 -202
- package/docs/src/docs/_decorators/bind.md +0 -167
- package/docs/src/docs/_decorators/get.md +0 -162
- package/docs/src/docs/_decorators/handle.md +0 -175
- package/docs/src/docs/_decorators/on-assign.md +0 -390
- package/docs/src/docs/_decorators/patch.md +0 -70
- package/docs/src/docs/_decorators/post.md +0 -146
- package/docs/src/docs/_decorators/publish.md +0 -55
- package/docs/src/docs/_decorators/put.md +0 -70
- package/docs/src/docs/_decorators/subscribe.md +0 -100
- package/docs/src/docs/_decorators/wait-for-ancestors.md +0 -163
- package/docs/src/docs/_directives/sub.md +0 -91
- package/docs/src/docs/_getting-started/concorde-manual-install.md +0 -133
- package/docs/src/docs/_getting-started/concorde-outside.md +0 -33
- package/docs/src/docs/_getting-started/my-first-subscriber.md +0 -120
- package/docs/src/docs/_getting-started/pubsub.md +0 -37
- package/docs/src/docs/_getting-started/start.md +0 -47
- package/docs/src/docs/_getting-started/theming.md +0 -91
- package/docs/src/docs/_misc/formelement-subscriber-removal.md +0 -115
- package/docs/src/tsconfig.declarations.json +0 -22
- package/docs/src/tsconfig.emit.json +0 -23
- package/gitlab/job_github_mirror.sh +0 -39
- package/scripts/github-export.mjs +0 -150
- package/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +0 -29
- package/src/css.d.ts +0 -19
- 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/prism/index.ts +0 -6
- package/src/docs/prism/prism.css +0 -158
- package/src/docs/prism/prism.js +0 -1022
- package/src/tsconfig.declarations.json +0 -22
- package/src/tsconfig.emit.json +0 -23
|
@@ -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,61 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/auto-subscribe" data-doc-id="docs/decorators/auto-subscribe">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>@autoSubscribe — Concorde by Supersoniks</title>
|
|
7
|
+
<meta name="description" content="Legacy decorator that re-runs a method whenever one of the store values it reads is assigned. For new code, prefer @subscribe with a DataProviderKey: dependencies are explicit and typed.">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/auto-subscribe, auto-subscribe, @autoSubscribe, decorator, autoSubscribe, DataProviderKey, connectedCallback, @state(), requestUpdate(), queueMicrotask, disconnectedCallback, @autoSubscribe()">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/decorators/auto-subscribe">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/auto-subscribe">
|
|
11
|
+
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/auto-subscribe.md">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header>
|
|
15
|
+
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/auto-subscribe">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
+
</header>
|
|
17
|
+
<main>
|
|
18
|
+
<article>
|
|
19
|
+
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @autoSubscribe</strong>. Legacy decorator that re-runs a method whenever one of the store values it reads is assigned. For new code, prefer @subscribe with a DataProviderKey: dependencies are explicit and typed. <span>Doc ID: <code>docs/decorators/auto-subscribe</code>. Keywords: Concorde, supersoniks, docs/decorators/auto-subscribe, auto-subscribe, @autoSubscribe, decorator, autoSubscribe, DataProviderKey, connectedCallback, @state(), requestUpdate(), queueMicrotask, disconnectedCallback, @autoSubscribe(). URL: <a href="https://concorde.supersoniks.org/docs/decorators/auto-subscribe">https://concorde.supersoniks.org/docs/decorators/auto-subscribe</a>.</span></p>
|
|
20
|
+
<h1 id="autosubscribe">@autoSubscribe</h1>
|
|
21
|
+
<p>Legacy decorator that re-runs a method whenever one of the store values it reads is assigned. For new code, prefer <a href="/docs/decorators/subscribe">@subscribe</a> with a <a href="/docs/misc/dataProviderKey"><code>DataProviderKey</code></a>: dependencies are explicit and typed.</p>
|
|
22
|
+
<h2 id="import">Import</h2>
|
|
23
|
+
<pre><code class="language-typescript">import { autoSubscribe } from "@supersoniks/concorde/decorators";
|
|
24
|
+
import { get } from "@supersoniks/concorde/utils";
|
|
25
|
+
|
|
26
|
+
@autoSubscribe()
|
|
27
|
+
updateDisplay() {
|
|
28
|
+
this.total = get(passengersKey) + get(crewKey);
|
|
29
|
+
}
|
|
30
|
+
</code></pre>
|
|
31
|
+
<h2 id="tracked-reads">Tracked reads</h2>
|
|
32
|
+
<p>The method runs once after <code>connectedCallback</code>. Every store value read during that run becomes a dependency; assigning any of them runs the method again. Write the result to a <code>@state()</code> property (or call <code>requestUpdate()</code>) so the component re-renders.</p>
|
|
33
|
+
<pre><code><docs-demo-sources for="demo-auto-subscribe"></docs-demo-sources>
|
|
34
|
+
<demo-auto-subscribe></demo-auto-subscribe>
|
|
35
|
+
</code></pre>
|
|
36
|
+
<h2 id="notes">Notes</h2>
|
|
37
|
+
<ul>
|
|
38
|
+
<li>Several assignments in the same task trigger a single re-run (batched with <code>queueMicrotask</code>).</li>
|
|
39
|
+
<li>Keep reads unconditional: a value read only behind a condition becomes a dependency the first time that branch runs.</li>
|
|
40
|
+
<li>Subscriptions are removed in <code>disconnectedCallback</code>.</li>
|
|
41
|
+
</ul>
|
|
42
|
+
<h2 id="api-reference">API reference</h2>
|
|
43
|
+
<table>
|
|
44
|
+
<thead>
|
|
45
|
+
<tr>
|
|
46
|
+
<th>Argument</th>
|
|
47
|
+
<th>Type</th>
|
|
48
|
+
<th>Description</th>
|
|
49
|
+
</tr>
|
|
50
|
+
</thead>
|
|
51
|
+
<tbody><tr>
|
|
52
|
+
<td>none</td>
|
|
53
|
+
<td></td>
|
|
54
|
+
<td><code>@autoSubscribe()</code> takes no argument; apply it to a method of a custom element</td>
|
|
55
|
+
</tr>
|
|
56
|
+
</tbody></table>
|
|
57
|
+
|
|
58
|
+
</article>
|
|
59
|
+
</main>
|
|
60
|
+
</body>
|
|
61
|
+
</html>
|
|
@@ -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,86 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/bind" data-doc-id="docs/decorators/bind">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>@bind — Concorde by Supersoniks</title>
|
|
7
|
+
<meta name="description" content="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; add { reflect: true } to push local writes back t">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/bind, bind, @bind, decorator, { reflect: true }, passengers.0, @state(), DataProviderKey, reflect: false, reflect: true, set(), ${index}, null">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/decorators/bind">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/bind">
|
|
11
|
+
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/bind.md">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header>
|
|
15
|
+
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/bind">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
+
</header>
|
|
17
|
+
<main>
|
|
18
|
+
<article>
|
|
19
|
+
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @bind</strong>. 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; add { reflect: true } to push local writes back t <span>Doc ID: <code>docs/decorators/bind</code>. Keywords: Concorde, supersoniks, docs/decorators/bind, bind, @bind, decorator, { reflect: true }, passengers.0, @state(), DataProviderKey, reflect: false, reflect: true, set(), ${index}, null. URL: <a href="https://concorde.supersoniks.org/docs/decorators/bind">https://concorde.supersoniks.org/docs/decorators/bind</a>.</span></p>
|
|
20
|
+
<h1 id="bind">@bind</h1>
|
|
21
|
+
<p>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 <a href="/docs/misc/dataProviderKey">DataProviderKey</a>; add <code>{ reflect: true }</code> to push local writes back to the store. For read-only sync prefer <a href="/docs/decorators/subscribe">@subscribe</a>, and see <a href="/docs/getting-started/dataFlow">Data flow</a> for the overall model.</p>
|
|
22
|
+
<h2 id="import">Import</h2>
|
|
23
|
+
<pre><code class="language-typescript">import { bind } from "@supersoniks/concorde/decorators";
|
|
24
|
+
|
|
25
|
+
@bind("flight.gate")
|
|
26
|
+
@state()
|
|
27
|
+
gate = "";
|
|
28
|
+
</code></pre>
|
|
29
|
+
<h2 id="basic-usage">Basic usage</h2>
|
|
30
|
+
<p>The first path segment is the data provider id, the rest is dot notation (array items use a numeric index: <code>passengers.0</code>). The property updates each time the store value changes. Add <code>@state()</code> so Lit re-renders.</p>
|
|
31
|
+
<pre><code><docs-demo-sources for="demo-bind"></docs-demo-sources>
|
|
32
|
+
<demo-bind></demo-bind>
|
|
33
|
+
</code></pre>
|
|
34
|
+
<h2 id="typed-key">Typed key</h2>
|
|
35
|
+
<p>With a <code>DataProviderKey<T></code>, TypeScript checks that the property type matches <code>T</code> at that path.</p>
|
|
36
|
+
<pre><code class="language-typescript">import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
37
|
+
|
|
38
|
+
type Flight = { flight: string; gate: string; boarded: number };
|
|
39
|
+
const flightKey = new DataProviderKey&lt;Flight&gt;("flight");
|
|
40
|
+
|
|
41
|
+
@bind(flightKey.boarded, { reflect: true })
|
|
42
|
+
@state()
|
|
43
|
+
boarded = 0;
|
|
44
|
+
</code></pre>
|
|
45
|
+
<h2 id="reflect">Reflect</h2>
|
|
46
|
+
<p>By default (<code>reflect: false</code>) the binding is one-way: assigning the property does not touch the store. With <code>reflect: true</code>, each assignment calls <code>set()</code> on the publisher, so every other subscriber sees the new value. An internal guard prevents update loops.</p>
|
|
47
|
+
<pre><code><docs-demo-sources for="demo-bind-reflect"></docs-demo-sources>
|
|
48
|
+
<demo-bind-reflect></demo-bind-reflect>
|
|
49
|
+
</code></pre>
|
|
50
|
+
<h2 id="dynamic-path">Dynamic path</h2>
|
|
51
|
+
<p>Placeholders such as <code>${index}</code> are resolved from properties of the same component, and <code>@bind</code> re-subscribes when they change. Write them in a plain string, not a backtick template literal. While a placeholder is <code>null</code> or <code>undefined</code> the binding is inactive; <code>{ skipEmptyPlaceholder: true }</code> also waits on <code>""</code>. Full rules: <a href="/docs/misc/dynamic-path">Dynamic paths</a>.</p>
|
|
52
|
+
<pre><code><docs-demo-sources for="demo-bind-dynamic"></docs-demo-sources>
|
|
53
|
+
<demo-bind-dynamic></demo-bind-dynamic>
|
|
54
|
+
</code></pre>
|
|
55
|
+
<h2 id="lifecycle">Lifecycle</h2>
|
|
56
|
+
<p>The decorator subscribes in <code>connectedCallback</code> and unsubscribes in <code>disconnectedCallback</code>. It works on any element with that lifecycle (<code>LitElement</code>, the <code>Subscriber</code> mixin).</p>
|
|
57
|
+
<h2 id="api-reference">API reference</h2>
|
|
58
|
+
<table>
|
|
59
|
+
<thead>
|
|
60
|
+
<tr>
|
|
61
|
+
<th>Argument</th>
|
|
62
|
+
<th>Type</th>
|
|
63
|
+
<th>Description</th>
|
|
64
|
+
</tr>
|
|
65
|
+
</thead>
|
|
66
|
+
<tbody><tr>
|
|
67
|
+
<td><code>path</code></td>
|
|
68
|
+
<td><code>string</code> or <code>DataProviderKey<T></code></td>
|
|
69
|
+
<td>Store path to bind. Supports <code>${prop}</code> placeholders</td>
|
|
70
|
+
</tr>
|
|
71
|
+
<tr>
|
|
72
|
+
<td><code>options.reflect</code></td>
|
|
73
|
+
<td><code>boolean</code> (default <code>false</code>)</td>
|
|
74
|
+
<td>Write local assignments back to the store</td>
|
|
75
|
+
</tr>
|
|
76
|
+
<tr>
|
|
77
|
+
<td><code>options.skipEmptyPlaceholder</code></td>
|
|
78
|
+
<td><code>boolean</code> (default <code>false</code>)</td>
|
|
79
|
+
<td>Treat a placeholder resolved to <code>""</code> as not ready</td>
|
|
80
|
+
</tr>
|
|
81
|
+
</tbody></table>
|
|
82
|
+
|
|
83
|
+
</article>
|
|
84
|
+
</main>
|
|
85
|
+
</body>
|
|
86
|
+
</html>
|
|
@@ -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,166 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/get" data-doc-id="docs/decorators/get">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>@get — Concorde by Supersoniks</title>
|
|
7
|
+
<meta name="description" content="@get(endpoint) runs an HTTP GET on an 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,">
|
|
8
|
+
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/get, get, @get, decorator, @get(endpoint), ApiResult, refetch, undefined, result, ), , (the HTTP response) and , . It is reset to , serviceURL">
|
|
9
|
+
<meta name="concorde-doc-id" content="docs/decorators/get">
|
|
10
|
+
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/get">
|
|
11
|
+
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/get.md">
|
|
12
|
+
</head>
|
|
13
|
+
<body>
|
|
14
|
+
<header>
|
|
15
|
+
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/docs/decorators/get">same URL (interactive)</a> · <a href="/llms.txt">llms.txt</a></p>
|
|
16
|
+
</header>
|
|
17
|
+
<main>
|
|
18
|
+
<article>
|
|
19
|
+
<p class="doc-lead" id="doc-summary"><strong>Concorde decorator — @get</strong>. @get(endpoint) runs an HTTP GET on an 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, <span>Doc ID: <code>docs/decorators/get</code>. Keywords: Concorde, supersoniks, docs/decorators/get, get, @get, decorator, @get(endpoint), ApiResult, refetch, undefined, result, ), , (the HTTP response) and , . It is reset to , serviceURL. URL: <a href="https://concorde.supersoniks.org/docs/decorators/get">https://concorde.supersoniks.org/docs/decorators/get</a>.</span></p>
|
|
20
|
+
<h1 id="get">@get</h1>
|
|
21
|
+
<p><code>@get(endpoint)</code> runs an HTTP GET on an <a href="/docs/misc/endpoint">Endpoint</a> and stores the full <code>ApiResult<T></code> 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 <code>refetch</code>. For writes, see <a href="/docs/decorators/post">@post</a>, <a href="/docs/decorators/put">@put</a> and <a href="/docs/decorators/patch">@patch</a>.</p>
|
|
22
|
+
<h2 id="import">Import</h2>
|
|
23
|
+
<pre><code class="language-typescript">import { get, Endpoint, type ApiResult } from "@supersoniks/concorde/decorators";
|
|
24
|
+
|
|
25
|
+
type FlightBoard = { flights: Flight[] };
|
|
26
|
+
const departuresEndpoint = new Endpoint&lt;FlightBoard&gt;("flights?direction=departures");
|
|
27
|
+
|
|
28
|
+
@get(departuresEndpoint)
|
|
29
|
+
@state()
|
|
30
|
+
departures?: ApiResult&lt;FlightBoard&gt;;
|
|
31
|
+
</code></pre>
|
|
32
|
+
<h2 id="property">Property</h2>
|
|
33
|
+
<p>The property is <code>undefined</code> until the first response, then holds <code>result</code> (typed <code>T</code>), <code>response</code> (the HTTP response) and <code>request</code>. It is reset to <code>undefined</code> when the component disconnects.</p>
|
|
34
|
+
<p>Without a configuration key, <code>serviceURL</code> and the token are read from the HTML scope: place the component under an element that sets them (see <a href="/docs/misc/api-configuration">API configuration</a>). The GET waits until <code>serviceURL</code> is available.</p>
|
|
35
|
+
<pre><code><docs-demo-sources for="demo-api-get"></docs-demo-sources>
|
|
36
|
+
<demo-api-get></demo-api-get>
|
|
37
|
+
</code></pre>
|
|
38
|
+
<h2 id="method">Method</h2>
|
|
39
|
+
<p>Decorate a method to receive the <code>ApiResult<T></code> after each GET instead of storing it.</p>
|
|
40
|
+
<pre><code class="language-typescript">@get(departuresEndpoint)
|
|
41
|
+
onDepartures(payload?: ApiResult&lt;FlightBoard&gt;) {
|
|
42
|
+
this.boarding = payload?.result?.flights.filter((f) =&gt; f.status === "boarding") ?? [];
|
|
43
|
+
}
|
|
44
|
+
</code></pre>
|
|
45
|
+
<pre><code><docs-demo-sources for="demo-api-get-method"></docs-demo-sources>
|
|
46
|
+
<demo-api-get-method></demo-api-get-method>
|
|
47
|
+
</code></pre>
|
|
48
|
+
<h2 id="configuration-key">Configuration key</h2>
|
|
49
|
+
<p>Pass a <code>DataProviderKey<APIConfiguration></code> 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.</p>
|
|
50
|
+
<pre><code class="language-typescript">import { DataProviderKey } from "@supersoniks/concorde/dataProviderKey";
|
|
51
|
+
import type { APIConfiguration } from "@supersoniks/concorde/utils/api";
|
|
52
|
+
|
|
53
|
+
const flightsApi = new DataProviderKey&lt;APIConfiguration&gt;("flightsApi");
|
|
54
|
+
|
|
55
|
+
@get(departuresEndpoint, flightsApi)
|
|
56
|
+
@state()
|
|
57
|
+
departures?: ApiResult&lt;FlightBoard&gt;;
|
|
58
|
+
</code></pre>
|
|
59
|
+
<h2 id="dynamic-endpoint">Dynamic endpoint</h2>
|
|
60
|
+
<p><code>${prop}</code> placeholders in the endpoint resolve from properties of the same component; each change runs a new GET. While a placeholder is <code>null</code> or <code>undefined</code>, no request is sent and the property is <code>undefined</code>. Rules: <a href="/docs/misc/dynamic-path">Dynamic paths</a>.</p>
|
|
61
|
+
<pre><code class="language-typescript">const boardEndpoint = new Endpoint&lt;FlightBoard, { direction: string }&gt;(
|
|
62
|
+
"flights?direction=${direction}",
|
|
63
|
+
);
|
|
64
|
+
|
|
65
|
+
@property() direction = "departures";
|
|
66
|
+
|
|
67
|
+
@get(boardEndpoint, flightsApi)
|
|
68
|
+
@state()
|
|
69
|
+
board?: ApiResult&lt;FlightBoard&gt;;
|
|
70
|
+
</code></pre>
|
|
71
|
+
<pre><code><docs-demo-sources for="demo-api-get-configuration-key"></docs-demo-sources>
|
|
72
|
+
<demo-api-get-configuration-key></demo-api-get-configuration-key>
|
|
73
|
+
</code></pre>
|
|
74
|
+
<h2 id="refetch">Refetch</h2>
|
|
75
|
+
<p>Keep the decorator in a constant to reuse it. <code>refetch(component)</code> runs the GET for that instance only and resolves with the new <code>ApiResult<T></code> (or <code>undefined</code>).</p>
|
|
76
|
+
<pre><code class="language-typescript">const departuresGet = get(departuresEndpoint);
|
|
77
|
+
|
|
78
|
+
@departuresGet
|
|
79
|
+
@state()
|
|
80
|
+
departures?: ApiResult&lt;FlightBoard&gt;;
|
|
81
|
+
|
|
82
|
+
async refresh() {
|
|
83
|
+
await departuresGet.refetch(this);
|
|
84
|
+
}
|
|
85
|
+
</code></pre>
|
|
86
|
+
<p><code>@refetch(handle)</code> does the same around a method. By default the GET runs <strong>after</strong> the method (and after its Promise, if it returns one); use <code>{ when: "before" }</code> to run it first. The method call resolves once the GET is done.</p>
|
|
87
|
+
<pre><code class="language-typescript">import { refetch } from "@supersoniks/concorde/decorators";
|
|
88
|
+
|
|
89
|
+
@refetch(departuresGet)
|
|
90
|
+
async showArrivals() {
|
|
91
|
+
this.direction = "arrivals";
|
|
92
|
+
}
|
|
93
|
+
</code></pre>
|
|
94
|
+
<h2 id="polling-and-triggers">Polling and triggers</h2>
|
|
95
|
+
<p><code>refetchEveryMs</code> runs the GET again that many milliseconds after each response (default <code>0</code>: off). <code>triggerKey</code> runs it whenever another component calls <code>invalidate()</code> on that publisher.</p>
|
|
96
|
+
<pre><code class="language-typescript">import { dp } from "@supersoniks/concorde/utils";
|
|
97
|
+
|
|
98
|
+
const boardRefresh = new DataProviderKey&lt;number&gt;("boardRefresh");
|
|
99
|
+
|
|
100
|
+
@get(departuresEndpoint, { refetchEveryMs: 30000, triggerKey: boardRefresh })
|
|
101
|
+
@state()
|
|
102
|
+
departures?: ApiResult&lt;FlightBoard&gt;;
|
|
103
|
+
|
|
104
|
+
// anywhere else
|
|
105
|
+
dp(boardRefresh).invalidate();
|
|
106
|
+
</code></pre>
|
|
107
|
+
<h2 id="api-reference">API reference</h2>
|
|
108
|
+
<table>
|
|
109
|
+
<thead>
|
|
110
|
+
<tr>
|
|
111
|
+
<th>Argument</th>
|
|
112
|
+
<th>Type</th>
|
|
113
|
+
<th>Description</th>
|
|
114
|
+
</tr>
|
|
115
|
+
</thead>
|
|
116
|
+
<tbody><tr>
|
|
117
|
+
<td><code>endpoint</code></td>
|
|
118
|
+
<td><code>Endpoint<T, U></code></td>
|
|
119
|
+
<td>Path relative to <code>serviceURL</code>. <code>U</code> lists the host properties used by <code>${…}</code> placeholders</td>
|
|
120
|
+
</tr>
|
|
121
|
+
<tr>
|
|
122
|
+
<td><code>configurationKey</code></td>
|
|
123
|
+
<td><code>DataProviderKey<APIConfiguration></code> (optional)</td>
|
|
124
|
+
<td>Read the configuration from the store instead of the HTML scope</td>
|
|
125
|
+
</tr>
|
|
126
|
+
<tr>
|
|
127
|
+
<td><code>options.refetchEveryMs</code></td>
|
|
128
|
+
<td><code>number</code> (default <code>0</code>)</td>
|
|
129
|
+
<td>Polling interval after each response; <code>0</code> disables it</td>
|
|
130
|
+
</tr>
|
|
131
|
+
<tr>
|
|
132
|
+
<td><code>options.triggerKey</code></td>
|
|
133
|
+
<td><code>DataProviderKey<unknown></code></td>
|
|
134
|
+
<td>Publisher whose <code>invalidate()</code> runs the GET again</td>
|
|
135
|
+
</tr>
|
|
136
|
+
<tr>
|
|
137
|
+
<td><code>options.skipEmptyPlaceholder</code></td>
|
|
138
|
+
<td><code>boolean</code> (default <code>false</code>)</td>
|
|
139
|
+
<td>Treat a placeholder resolved to <code>""</code> as not ready</td>
|
|
140
|
+
</tr>
|
|
141
|
+
</tbody></table>
|
|
142
|
+
<p><code>options</code> is the second argument, or the third when a <code>configurationKey</code> is passed. The returned decorator exposes <code>refetch(component): Promise<ApiResult<T> | undefined></code>.</p>
|
|
143
|
+
<table>
|
|
144
|
+
<thead>
|
|
145
|
+
<tr>
|
|
146
|
+
<th><code>@refetch</code> argument</th>
|
|
147
|
+
<th>Type</th>
|
|
148
|
+
<th>Description</th>
|
|
149
|
+
</tr>
|
|
150
|
+
</thead>
|
|
151
|
+
<tbody><tr>
|
|
152
|
+
<td><code>handle</code></td>
|
|
153
|
+
<td>value returned by <code>get(…)</code></td>
|
|
154
|
+
<td>GET to run</td>
|
|
155
|
+
</tr>
|
|
156
|
+
<tr>
|
|
157
|
+
<td><code>options.when</code></td>
|
|
158
|
+
<td><code>"before"</code> or <code>"after"</code> (default <code>"after"</code>)</td>
|
|
159
|
+
<td>Run the GET before or after the method</td>
|
|
160
|
+
</tr>
|
|
161
|
+
</tbody></table>
|
|
162
|
+
|
|
163
|
+
</article>
|
|
164
|
+
</main>
|
|
165
|
+
</body>
|
|
166
|
+
</html>
|