@supersoniks/concorde 5.1.2 → 5.1.3-immutable.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/skills/concorde-docs/SKILL.md +1 -1
- package/.claude/skills +1 -0
- package/.github/workflows/ci.yml +21 -0
- package/.github-export-ignore +30 -0
- package/CONTRIBUTING.md +59 -0
- package/DEV.md +54 -0
- package/LICENSE +21 -0
- package/OPEN_SOURCE_CHECKPOINT.md +133 -0
- package/README.md +1 -1
- package/ai/README.md +29 -41
- package/ai/skills/concorde/SKILL.md +54 -324
- package/ai/skills/concorde/rules/composition.md +32 -0
- package/ai/skills/concorde/rules/data.md +47 -0
- package/ai/skills/concorde/rules/http.md +25 -0
- package/ai/skills/concorde/rules/lists-forms.md +35 -0
- package/ai/skills/concorde/rules/styling.md +46 -0
- package/ai/skills/concorde/rules/troubleshooting.md +45 -0
- package/build-infos.json +1 -1
- package/concorde-core.bundle.js +177 -177
- package/concorde-core.es.js +4993 -4833
- package/custom-elements-manifest.public.config.mjs +8 -0
- package/{.tmp-cem/custom-elements.json → custom-elements.json} +11722 -8868
- package/dist/concorde-core.bundle.js +177 -177
- package/dist/concorde-core.es.js +4993 -4833
- package/dist/docs-mock-api-sw.js +58 -223
- package/dist/docs-mock-api-sw.js.map +4 -4
- package/dist/img/og-concorde.jpg +0 -0
- package/dist/robots.txt +11 -10
- package/docs/assets/index-CD4WyL6o.css +1 -0
- package/docs/assets/index-D_alEsng.js +12122 -0
- package/docs/crawl/core/components/functional/date/date.html +190 -0
- package/docs/crawl/core/components/functional/fetch/fetch.html +109 -0
- package/docs/crawl/core/components/functional/if/if.html +27 -0
- package/docs/crawl/core/components/functional/jsonata/jsonata.html +79 -0
- package/docs/crawl/core/components/functional/list/list.html +70 -0
- package/docs/crawl/core/components/functional/mix/mix.html +45 -0
- package/docs/crawl/core/components/functional/queue/queue.html +96 -0
- package/docs/crawl/core/components/functional/router/router.html +106 -0
- package/docs/{core → crawl/core}/components/functional/sdui/sdui-extension-points.html +8 -9
- package/docs/crawl/core/components/functional/sdui/sdui.html +368 -0
- package/docs/crawl/core/components/functional/states/states.html +66 -0
- package/docs/crawl/core/components/functional/submit/submit.html +160 -0
- package/docs/{core → crawl/core}/components/functional/subscriber/subscriber.html +5 -6
- package/docs/crawl/core/components/functional/value/value.html +51 -0
- package/docs/{core → crawl/core}/components/ui/alert/alert.html +63 -53
- package/docs/{core → crawl/core}/components/ui/alert-messages/alert-messages.html +5 -6
- package/docs/{core → crawl/core}/components/ui/badge/badge.html +33 -33
- package/docs/crawl/core/components/ui/button/button.html +150 -0
- package/docs/crawl/core/components/ui/captcha/captcha.html +112 -0
- package/docs/{core → crawl/core}/components/ui/card/card.html +11 -12
- package/docs/{core → crawl/core}/components/ui/divider/divider.html +14 -14
- package/docs/crawl/core/components/ui/form/checkbox/checkbox.html +73 -0
- package/docs/crawl/core/components/ui/form/fieldset/fieldset.html +266 -0
- package/docs/{core → crawl/core}/components/ui/form/form-actions/form-actions.html +23 -23
- package/docs/crawl/core/components/ui/form/form-layout/form-layout.html +121 -0
- package/docs/crawl/core/components/ui/form/input/input.html +109 -0
- package/docs/crawl/core/components/ui/form/input-autocomplete/input-autocomplete.html +38 -0
- package/docs/crawl/core/components/ui/form/radio/radio.html +56 -0
- package/docs/crawl/core/components/ui/form/select/select.html +73 -0
- package/docs/crawl/core/components/ui/form/switch/switch.html +56 -0
- package/docs/crawl/core/components/ui/form/textarea/textarea.html +59 -0
- package/docs/crawl/core/components/ui/group/group.html +104 -0
- package/docs/{core → crawl/core}/components/ui/icon/icon.html +9 -10
- package/docs/crawl/core/components/ui/image/image.html +298 -0
- package/docs/{core → crawl/core}/components/ui/link/link.html +11 -12
- package/docs/crawl/core/components/ui/loader/loader.html +124 -0
- package/docs/{core → crawl/core}/components/ui/menu/menu.html +33 -34
- package/docs/crawl/core/components/ui/modal/modal.html +342 -0
- package/docs/crawl/core/components/ui/pop/pop.html +296 -0
- package/docs/{core → crawl/core}/components/ui/progress/progress.html +7 -8
- package/docs/crawl/core/components/ui/table/table.html +545 -0
- package/docs/crawl/core/components/ui/theme/theme.html +131 -0
- package/docs/crawl/core/components/ui/toast/toast.html +233 -0
- package/docs/crawl/core/components/ui/tooltip/tooltip.html +140 -0
- package/docs/{docs/getting-started → crawl/docs/_core-concept}/dataFlow.html +29 -26
- package/docs/crawl/docs/_core-concept/overview.html +66 -0
- package/docs/crawl/docs/_core-concept/subscriber.html +75 -0
- package/docs/crawl/docs/_decorators/ancestor-attribute.html +117 -0
- package/docs/crawl/docs/_decorators/auto-subscribe.html +202 -0
- package/docs/crawl/docs/_decorators/bind.html +141 -0
- package/docs/crawl/docs/_decorators/get.html +149 -0
- package/docs/crawl/docs/_decorators/handle.html +165 -0
- package/docs/crawl/docs/_decorators/on-assign.html +355 -0
- package/docs/crawl/docs/_decorators/patch.html +78 -0
- package/docs/crawl/docs/_decorators/post.html +139 -0
- package/docs/crawl/docs/_decorators/publish.html +61 -0
- package/docs/crawl/docs/_decorators/put.html +78 -0
- package/docs/crawl/docs/_decorators/subscribe.html +109 -0
- package/docs/crawl/docs/_decorators/wait-for-ancestors.html +137 -0
- package/docs/crawl/docs/_directives/sub.html +93 -0
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/ai-agents.html +11 -12
- package/docs/crawl/docs/_getting-started/concorde-manual-install.html +100 -0
- package/docs/crawl/docs/_getting-started/concorde-outside.html +58 -0
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/create-a-component.html +14 -11
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/my-first-component.html +22 -13
- package/docs/crawl/docs/_getting-started/my-first-subscriber.html +110 -0
- package/docs/crawl/docs/_getting-started/pubsub.html +62 -0
- package/docs/crawl/docs/_getting-started/start.html +76 -0
- package/docs/{docs/getting-started → crawl/docs/_getting-started}/theming.html +9 -10
- package/docs/{docs/misc → crawl/docs/_misc}/api-configuration.html +18 -18
- package/docs/{docs/misc → crawl/docs/_misc}/dataProviderKey.html +11 -12
- package/docs/{docs/misc → crawl/docs/_misc}/docs-mock-api.html +28 -25
- package/docs/{docs/misc → crawl/docs/_misc}/dynamic-path.html +15 -16
- package/docs/{docs/misc → crawl/docs/_misc}/endpoint.html +15 -16
- package/docs/crawl/docs/_misc/formelement-subscriber-removal.html +138 -0
- package/docs/{docs/misc → crawl/docs/_misc}/html-integration.html +15 -12
- package/docs/crawl/hubs/decorators.html +547 -0
- package/docs/crawl/hubs/form-components.html +381 -0
- package/docs/crawl/hubs/remote-data.html +452 -0
- package/docs/crawl/index.html +103 -0
- package/docs/docs-mock-api-sw.js +223 -58
- package/docs/docs-mock-api-sw.js.map +4 -4
- package/docs/index.html +68 -95
- package/docs/llms-full.txt +3610 -2231
- package/docs/llms.txt +86 -94
- package/docs/robots.txt +10 -11
- package/docs/sitemap.xml +84 -78
- package/docs/src/core/components/functional/date/date.md +231 -91
- package/docs/src/core/components/functional/fetch/fetch.md +83 -66
- package/docs/src/core/components/functional/if/if.md +3 -28
- package/docs/src/core/components/functional/jsonata/jsonata.md +37 -42
- package/docs/src/core/components/functional/list/list.md +43 -99
- package/docs/src/core/components/functional/mix/mix.md +26 -31
- package/docs/src/core/components/functional/queue/queue.md +61 -40
- package/docs/src/core/components/functional/router/router.md +65 -64
- package/docs/src/core/components/functional/sdui/component-catalog.gaps.json +1 -1
- package/docs/src/core/components/functional/sdui/component-catalog.json +1 -1
- package/docs/src/core/components/functional/sdui/example.json +86 -19
- package/docs/src/core/components/functional/sdui/sdui-extension-points.md +1 -1
- package/docs/src/core/components/functional/sdui/sdui.md +358 -187
- package/docs/src/core/components/functional/states/states.md +61 -86
- package/docs/src/core/components/functional/submit/submit.md +72 -64
- package/docs/src/core/components/functional/value/value.md +22 -34
- package/docs/src/core/components/ui/alert/alert.md +58 -48
- package/docs/src/core/components/ui/badge/badge.md +34 -27
- package/docs/src/core/components/ui/button/button.md +106 -139
- package/docs/src/core/components/ui/captcha/captcha.md +32 -17
- package/docs/src/core/components/ui/card/card.md +6 -6
- package/docs/src/core/components/ui/divider/divider.md +11 -8
- package/docs/src/core/components/ui/form/checkbox/checkbox.md +42 -90
- package/docs/src/core/components/ui/form/fieldset/fieldset.md +75 -31
- package/docs/src/core/components/ui/form/form-actions/form-actions.md +16 -14
- package/docs/src/core/components/ui/form/form-layout/form-layout.md +29 -19
- package/docs/src/core/components/ui/form/input/input.md +95 -95
- package/docs/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +29 -0
- package/docs/src/core/components/ui/form/radio/radio.md +34 -55
- package/docs/src/core/components/ui/form/select/select.md +45 -60
- package/docs/src/core/components/ui/form/switch/switch.md +34 -57
- package/docs/src/core/components/ui/form/textarea/textarea.md +38 -55
- package/docs/src/core/components/ui/group/group.md +33 -35
- package/docs/src/core/components/ui/icon/icon.md +4 -4
- package/docs/src/core/components/ui/image/image.md +107 -41
- package/docs/src/core/components/ui/link/link.md +6 -6
- package/docs/src/core/components/ui/loader/loader.md +55 -30
- package/docs/src/core/components/ui/menu/menu.md +27 -27
- package/docs/src/core/components/ui/modal/modal.md +96 -72
- package/docs/src/core/components/ui/pop/pop.md +158 -80
- package/docs/src/core/components/ui/progress/progress.md +2 -2
- package/docs/src/core/components/ui/table/table.md +255 -91
- package/docs/src/core/components/ui/theme/theme.md +36 -11
- package/docs/src/core/components/ui/toast/toast.md +117 -48
- package/docs/src/core/components/ui/tooltip/tooltip.md +62 -27
- package/docs/{docs/getting-started → src/docs/_core-concept}/dataFlow.md +18 -17
- package/docs/src/docs/_core-concept/overview.md +57 -0
- package/docs/src/docs/_core-concept/subscriber.md +75 -0
- package/docs/src/docs/_decorators/ancestor-attribute.md +128 -0
- package/docs/src/docs/_decorators/auto-subscribe.md +202 -0
- package/docs/src/docs/_decorators/bind.md +167 -0
- package/docs/src/docs/_decorators/get.md +162 -0
- package/docs/src/docs/_decorators/handle.md +175 -0
- package/docs/src/docs/_decorators/on-assign.md +390 -0
- package/docs/src/docs/_decorators/patch.md +70 -0
- package/docs/src/docs/_decorators/post.md +146 -0
- package/docs/src/docs/_decorators/publish.md +55 -0
- package/docs/src/docs/_decorators/put.md +70 -0
- package/docs/src/docs/_decorators/subscribe.md +100 -0
- package/docs/src/docs/_decorators/wait-for-ancestors.md +163 -0
- package/docs/src/docs/_directives/sub.md +91 -0
- package/docs/src/docs/{getting-started → _getting-started}/ai-agents.md +3 -3
- package/docs/src/docs/_getting-started/concorde-manual-install.md +133 -0
- package/docs/src/docs/_getting-started/concorde-outside.md +33 -0
- package/docs/{docs/getting-started → src/docs/_getting-started}/create-a-component.md +6 -3
- package/docs/src/docs/{getting-started → _getting-started}/my-first-component.md +14 -5
- package/docs/src/docs/_getting-started/my-first-subscriber.md +120 -0
- package/docs/src/docs/_getting-started/pubsub.md +37 -0
- package/docs/src/docs/{getting-started → _getting-started}/start.md +13 -1
- package/docs/src/docs/{getting-started → _getting-started}/theming.md +2 -2
- package/docs/src/docs/{misc → _misc}/api-configuration.md +12 -10
- package/docs/src/docs/{misc → _misc}/dataProviderKey.md +4 -4
- package/docs/{docs/misc → src/docs/_misc}/docs-mock-api.md +13 -12
- package/docs/{docs/misc → src/docs/_misc}/dynamic-path.md +8 -8
- package/docs/{docs/misc → src/docs/_misc}/endpoint.md +8 -8
- package/docs/src/docs/_misc/formelement-subscriber-removal.md +115 -0
- package/docs/{docs/misc → src/docs/_misc}/html-integration.md +5 -4
- package/docs/src/docs/search/docs-search.json +4375 -2420
- package/docs/src/tsconfig.declarations.json +22 -0
- package/docs/src/tsconfig.emit.json +23 -0
- package/docs/src/tsconfig.json +2 -23
- package/gitlab/job_github_mirror.sh +39 -0
- package/index.html +89 -0
- package/package.json +22 -4
- package/public/img/og-concorde.jpg +0 -0
- package/scripts/ai-init.mjs +104 -379
- package/scripts/ai-init.test.mjs +81 -239
- package/scripts/docs-markdown-vite-plugin.ts +11 -5
- package/scripts/docs-public-url.mjs +6 -0
- package/scripts/docs.htaccess +7 -0
- package/scripts/generate-cem.mjs +244 -0
- package/scripts/generate-cem.test.mjs +122 -0
- package/scripts/generate-crawl-docs.mjs +29 -5
- package/scripts/generate-sdui-catalog.mjs +11 -10
- package/scripts/github-export.mjs +150 -0
- package/scripts/post-build-docs.js +3 -0
- package/scripts/post-build.mjs +0 -0
- package/scripts/pre-publish.mjs +2 -1
- package/scripts/site-pages.mjs +212 -0
- package/scripts/site-pages.test.mjs +116 -0
- package/site-pages/about.md +22 -0
- package/site-pages/privacy.md +32 -0
- package/src/core/components/functional/date/date.md +1 -1
- package/src/core/components/functional/example/example.ts +3 -1
- package/src/core/components/functional/if/if.ts +0 -0
- package/src/core/components/functional/list/list.demo.ts +0 -0
- package/src/core/components/functional/list/list.md +6 -2
- package/src/core/components/functional/list/list.ts +17 -4
- package/src/core/components/functional/mix/mix.md +0 -0
- package/src/core/components/functional/router/router.demo.ts +0 -0
- 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 +2 -2
- package/src/core/components/functional/sdui/example.json +0 -0
- package/src/core/components/functional/sdui/sdui-immutable.spec.ts +74 -0
- package/src/core/components/functional/sdui/sdui.ts +33 -8
- package/src/core/components/functional/sdui/types.ts +0 -0
- package/src/core/components/functional/states/states.ts +0 -0
- package/src/core/components/functional/submit/submit.spec.ts +60 -0
- package/src/core/components/functional/submit/submit.ts +6 -3
- package/src/core/components/functional/subscriber/subscriber.ts +0 -0
- package/src/core/components/functional/value/value.md +0 -0
- 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/captcha/altchaStyles.ts +0 -0
- package/src/core/components/ui/card/card.md +1 -1
- package/src/core/components/ui/form/input/input.md +19 -1
- package/src/core/components/ui/form/input/input.ts +8 -2
- package/src/core/components/ui/form/radio/radio.md +14 -0
- package/src/core/components/ui/image/image.md +17 -17
- package/src/core/components/ui/modal/modal.md +2 -2
- package/src/core/decorators/subscriber/bind.ts +9 -14
- package/src/core/decorators/subscriber/subscribe.ts +15 -9
- package/src/core/decorators/subscriber/subscribe.type-test.ts +14 -5
- package/src/core/mixins/Subscriber.ts +0 -0
- package/src/core/utils/DataBindObserver.ts +0 -0
- package/src/core/utils/Objects.ts +0 -0
- package/src/core/utils/PublisherProxy.ts +166 -125
- package/src/core/utils/deepReadonly.spec.ts +66 -0
- package/src/core/utils/deepReadonly.ts +71 -0
- package/src/core/utils/immutableValue.spec.ts +54 -0
- package/src/core/utils/immutableValue.ts +102 -0
- package/src/core/utils/nestedDotForm.spec.ts +88 -0
- package/src/core/utils/publisherImmutable.spec.ts +76 -0
- package/src/core/utils/route.ts +0 -0
- package/src/core/utils/strictGet.spec.ts +61 -0
- package/src/core/utils/strictGet.ts +102 -0
- package/src/css.d.ts +19 -0
- package/src/docs/components/docs-demo-sources.ts +3 -3
- package/src/docs/decorators/bind.md +23 -24
- package/src/docs/docs-location.spec.ts +10 -0
- package/src/docs/docs-location.ts +10 -0
- package/src/docs/example/decorators-demo-bind-demos.ts +11 -28
- package/src/docs/example/docs-toggle-demos.ts +1 -1
- package/src/docs/example/users.ts +0 -0
- package/src/docs/getting-started/ai-agents.md +29 -55
- package/src/docs/getting-started/dataFlow.md +2 -2
- package/src/docs/home/home.ts +3 -1
- package/src/docs/misc/publisher-get-immutability-docs-crawl.json +902 -0
- package/src/docs/misc/publisher-get-immutability-docs-recheck.json +13 -0
- package/src/docs/misc/publisher-get-immutability-study.md +229 -0
- package/src/docs/navigation/navigation.ts +5 -1
- package/src/docs/search/docs-search.json +358 -58
- package/src/docs/search/markdown-renderer.ts +6 -1
- package/src/docs/tailwind/css/docs/content.css +4 -5
- package/src/tsconfig.declarations.json +22 -0
- package/src/tsconfig.emit.json +23 -0
- package/src/tsconfig.json +53 -5
- package/src/tsconfig.tsbuildinfo +1 -1
- 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 +0 -4103
- 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 +0 -2556
- package/.taste-skill/before/tablet-fold.jpg +0 -0
- package/.taste-skill/before/tablet-page-01.jpg +0 -0
- package/.taste-skill/direction.json +0 -510
- package/.taste-skill/notes.md +0 -84
- 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 +0 -1973
- 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/AUDIT.md +0 -228
- package/PLAN-AMELIORATION.md +0 -220
- package/PLAN-DOCS-AGENTS.md +0 -80
- package/ai/AGENTS.md +0 -56
- package/ai/cursor/rules/concorde-menu.mdc +0 -15
- package/ai/cursor/rules/concorde-scope.mdc +0 -14
- package/ai/cursor/rules/concorde-theme.mdc +0 -13
- package/ai/cursor/rules/concorde.mdc +0 -66
- package/ai/jetbrains/rules/concorde.md +0 -53
- package/ai/skills/concorde-get-set-dp/SKILL.md +0 -194
- package/ai/skills/concorde-imports/SKILL.md +0 -78
- package/ai/skills/concorde-menu/SKILL.md +0 -74
- package/ai/skills/concorde-scope/SKILL.md +0 -70
- package/ai/skills/concorde-theme/SKILL.md +0 -57
- package/docs/.htaccess +0 -75
- package/docs/404.html +0 -15
- package/docs/404.md +0 -5
- package/docs/assets/index-BgG6FFPt.js +0 -11765
- package/docs/assets/index-x89XINSG.css +0 -1
- package/docs/core/components/functional/date/date.html +0 -211
- package/docs/core/components/functional/date/date.md +0 -150
- package/docs/core/components/functional/fetch/fetch.html +0 -180
- package/docs/core/components/functional/fetch/fetch.md +0 -108
- package/docs/core/components/functional/if/if.html +0 -65
- package/docs/core/components/functional/if/if.md +0 -34
- package/docs/core/components/functional/jsonata/jsonata.html +0 -110
- package/docs/core/components/functional/jsonata/jsonata.md +0 -61
- package/docs/core/components/functional/list/list.html +0 -198
- package/docs/core/components/functional/list/list.md +0 -121
- package/docs/core/components/functional/mix/mix.html +0 -78
- package/docs/core/components/functional/mix/mix.md +0 -46
- package/docs/core/components/functional/queue/queue.html +0 -155
- package/docs/core/components/functional/queue/queue.md +0 -51
- package/docs/core/components/functional/router/router.html +0 -154
- package/docs/core/components/functional/router/router.md +0 -93
- package/docs/core/components/functional/sdui/sdui-extension-points.md +0 -94
- package/docs/core/components/functional/sdui/sdui.html +0 -397
- package/docs/core/components/functional/sdui/sdui.md +0 -307
- package/docs/core/components/functional/states/states.html +0 -141
- package/docs/core/components/functional/states/states.md +0 -112
- package/docs/core/components/functional/submit/submit.html +0 -178
- package/docs/core/components/functional/submit/submit.md +0 -106
- package/docs/core/components/functional/subscriber/subscriber.md +0 -91
- package/docs/core/components/functional/translation/translation.html +0 -60
- package/docs/core/components/functional/translation/translation.md +0 -38
- package/docs/core/components/functional/value/value.html +0 -81
- package/docs/core/components/functional/value/value.md +0 -47
- package/docs/core/components/ui/alert/alert.md +0 -186
- package/docs/core/components/ui/alert-messages/alert-messages.md +0 -85
- package/docs/core/components/ui/badge/badge.md +0 -181
- package/docs/core/components/ui/button/button.html +0 -309
- package/docs/core/components/ui/button/button.md +0 -216
- package/docs/core/components/ui/captcha/captcha.html +0 -80
- package/docs/core/components/ui/captcha/captcha.md +0 -56
- package/docs/core/components/ui/card/card.md +0 -215
- package/docs/core/components/ui/divider/divider.md +0 -126
- package/docs/core/components/ui/form/checkbox/checkbox.html +0 -200
- package/docs/core/components/ui/form/checkbox/checkbox.md +0 -125
- package/docs/core/components/ui/form/fieldset/fieldset.html +0 -238
- package/docs/core/components/ui/form/fieldset/fieldset.md +0 -161
- package/docs/core/components/ui/form/form-actions/form-actions.md +0 -98
- package/docs/core/components/ui/form/form-layout/form-layout.html +0 -115
- package/docs/core/components/ui/form/form-layout/form-layout.md +0 -109
- package/docs/core/components/ui/form/input/input.html +0 -235
- package/docs/core/components/ui/form/input/input.md +0 -142
- package/docs/core/components/ui/form/radio/radio.html +0 -144
- package/docs/core/components/ui/form/radio/radio.md +0 -78
- package/docs/core/components/ui/form/select/select.html +0 -178
- package/docs/core/components/ui/form/select/select.md +0 -86
- package/docs/core/components/ui/form/switch/switch.html +0 -146
- package/docs/core/components/ui/form/switch/switch.md +0 -80
- package/docs/core/components/ui/form/textarea/textarea.html +0 -162
- package/docs/core/components/ui/form/textarea/textarea.md +0 -82
- package/docs/core/components/ui/group/group.html +0 -113
- package/docs/core/components/ui/group/group.md +0 -77
- package/docs/core/components/ui/icon/icon.md +0 -214
- package/docs/core/components/ui/image/image.html +0 -194
- package/docs/core/components/ui/image/image.md +0 -167
- package/docs/core/components/ui/link/link.md +0 -81
- package/docs/core/components/ui/loader/loader.html +0 -114
- package/docs/core/components/ui/loader/loader.md +0 -87
- package/docs/core/components/ui/menu/menu.md +0 -370
- package/docs/core/components/ui/modal/modal.html +0 -324
- package/docs/core/components/ui/modal/modal.md +0 -211
- package/docs/core/components/ui/pop/pop.html +0 -250
- package/docs/core/components/ui/pop/pop.md +0 -216
- package/docs/core/components/ui/progress/progress.md +0 -109
- package/docs/core/components/ui/table/table.html +0 -333
- package/docs/core/components/ui/table/table.md +0 -267
- package/docs/core/components/ui/theme/theme.html +0 -116
- package/docs/core/components/ui/theme/theme.md +0 -97
- package/docs/core/components/ui/toast/toast.html +0 -185
- package/docs/core/components/ui/toast/toast.md +0 -147
- package/docs/core/components/ui/tooltip/tooltip.html +0 -112
- package/docs/core/components/ui/tooltip/tooltip.md +0 -89
- package/docs/docs/decorators/ancestor-attribute.html +0 -71
- package/docs/docs/decorators/ancestor-attribute.md +0 -59
- package/docs/docs/decorators/auto-subscribe.html +0 -61
- package/docs/docs/decorators/auto-subscribe.md +0 -40
- package/docs/docs/decorators/bind.html +0 -86
- package/docs/docs/decorators/bind.md +0 -77
- package/docs/docs/decorators/get.html +0 -166
- package/docs/docs/decorators/get.md +0 -160
- package/docs/docs/decorators/handle.html +0 -139
- package/docs/docs/decorators/handle.md +0 -119
- package/docs/docs/decorators/on-assign.html +0 -72
- package/docs/docs/decorators/on-assign.md +0 -63
- package/docs/docs/decorators/patch.html +0 -76
- package/docs/docs/decorators/patch.md +0 -44
- package/docs/docs/decorators/post.html +0 -150
- package/docs/docs/decorators/post.md +0 -134
- package/docs/docs/decorators/publish.html +0 -74
- package/docs/docs/decorators/publish.md +0 -56
- package/docs/docs/decorators/put.html +0 -83
- package/docs/docs/decorators/put.md +0 -51
- package/docs/docs/decorators/subscribe.html +0 -91
- package/docs/docs/decorators/subscribe.md +0 -87
- package/docs/docs/decorators/wait-for-ancestors.html +0 -82
- package/docs/docs/decorators/wait-for-ancestors.md +0 -76
- package/docs/docs/directives/sub.html +0 -79
- package/docs/docs/directives/sub.md +0 -75
- package/docs/docs/directives/t.html +0 -91
- package/docs/docs/directives/t.md +0 -73
- package/docs/docs/getting-started/ai-agents.md +0 -76
- package/docs/docs/getting-started/components.html +0 -27
- package/docs/docs/getting-started/components.md +0 -5
- package/docs/docs/getting-started/installation.html +0 -69
- package/docs/docs/getting-started/installation.md +0 -36
- package/docs/docs/getting-started/my-first-component.md +0 -227
- package/docs/docs/getting-started/start.html +0 -47
- package/docs/docs/getting-started/start.md +0 -35
- package/docs/docs/getting-started/theming.md +0 -253
- package/docs/docs/index.html +0 -99
- package/docs/docs/misc/api-configuration.md +0 -79
- package/docs/docs/misc/dataProviderKey.md +0 -168
- package/docs/hubs/decorators.html +0 -443
- package/docs/hubs/form-components.html +0 -404
- package/docs/hubs/remote-data.html +0 -371
- 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 +0 -28
- package/docs/index.md +0 -22
- package/docs/src/core/components/functional/translation/translation.md +0 -38
- package/docs/src/docs/decorators/ancestor-attribute.md +0 -59
- package/docs/src/docs/decorators/auto-subscribe.md +0 -40
- package/docs/src/docs/decorators/bind.md +0 -77
- package/docs/src/docs/decorators/get.md +0 -160
- package/docs/src/docs/decorators/handle.md +0 -119
- package/docs/src/docs/decorators/on-assign.md +0 -63
- package/docs/src/docs/decorators/patch.md +0 -44
- package/docs/src/docs/decorators/post.md +0 -134
- package/docs/src/docs/decorators/publish.md +0 -56
- package/docs/src/docs/decorators/put.md +0 -51
- package/docs/src/docs/decorators/subscribe.md +0 -87
- package/docs/src/docs/decorators/wait-for-ancestors.md +0 -76
- package/docs/src/docs/directives/sub.md +0 -75
- package/docs/src/docs/directives/t.md +0 -73
- package/docs/src/docs/getting-started/components.md +0 -5
- package/docs/src/docs/getting-started/create-a-component.md +0 -136
- package/docs/src/docs/getting-started/dataFlow.md +0 -87
- package/docs/src/docs/getting-started/installation.md +0 -36
- package/docs/src/docs/misc/docs-mock-api.md +0 -62
- package/docs/src/docs/misc/dynamic-path.md +0 -71
- package/docs/src/docs/misc/endpoint.md +0 -45
- package/docs/src/docs/misc/html-integration.md +0 -14
- /package/{docs → dist}/img/concorde/plane_01.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_02.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_03.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_04.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_05.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_06.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_07.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_08.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_09.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_10.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_11.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_12.jpg +0 -0
- /package/{docs → dist}/img/concorde/plane_13.jpg +0 -0
|
@@ -1,112 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/core/components/ui/tooltip" data-doc-id="core/components/ui/tooltip/tooltip">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>Tooltip — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="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, l">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, core/components/ui/tooltip/tooltip, tooltip, Tooltip, UI component, sonic-tooltip, web component, label, placement, top, disabled, bottom, left, right">
|
|
9
|
-
<meta name="concorde-doc-id" content="core/components/ui/tooltip/tooltip">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/core/components/ui/tooltip">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/core/components/ui/tooltip.md">
|
|
12
|
-
</head>
|
|
13
|
-
<body>
|
|
14
|
-
<header>
|
|
15
|
-
<p><a href="/docs/index.html">Concorde documentation</a> · <a href="https://concorde.supersoniks.org/core/components/ui/tooltip">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 UI component — Tooltip</strong>. 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, l <span>Doc ID: <code>core/components/ui/tooltip/tooltip</code>. Keywords: Concorde, supersoniks, core/components/ui/tooltip/tooltip, tooltip, Tooltip, UI component, sonic-tooltip, web component, label, placement, top, disabled, bottom, left, right. URL: <a href="https://concorde.supersoniks.org/core/components/ui/tooltip">https://concorde.supersoniks.org/core/components/ui/tooltip</a>.</span></p>
|
|
20
|
-
<h1 id="tooltip">Tooltip</h1>
|
|
21
|
-
<p><strong><code>sonic-tooltip</code></strong> shows a short <code>label</code> in a bubble when the trigger in the default slot is hovered or receives focus. With no <code>placement</code>, the bubble sits on <code>top</code>, centered. An empty <code>label</code> hides the bubble, like <code>disabled</code>.</p>
|
|
22
|
-
<h2 id="basic-example">Basic example</h2>
|
|
23
|
-
<pre><code><sonic-tooltip label="Cruising at Mach 2.04">
|
|
24
|
-
<sonic-button variant="outline">Hover me</sonic-button>
|
|
25
|
-
</sonic-tooltip>
|
|
26
|
-
</code></pre>
|
|
27
|
-
<h2 id="placement">Placement</h2>
|
|
28
|
-
<p><code>top</code> · <code>bottom</code> · <code>left</code> · <code>right</code> set the side. Add <code>-start</code> or <code>-end</code> 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.</p>
|
|
29
|
-
<pre><code><div class="flex flex-wrap gap-3">
|
|
30
|
-
<sonic-tooltip placement="top" label="top"><sonic-button minWidth="9rem">top</sonic-button></sonic-tooltip>
|
|
31
|
-
<sonic-tooltip placement="top-start" label="top-start"><sonic-button minWidth="9rem">top-start</sonic-button></sonic-tooltip>
|
|
32
|
-
<sonic-tooltip placement="top-end" label="top-end"><sonic-button minWidth="9rem">top-end</sonic-button></sonic-tooltip>
|
|
33
|
-
<sonic-tooltip placement="bottom" label="bottom"><sonic-button minWidth="9rem">bottom</sonic-button></sonic-tooltip>
|
|
34
|
-
<sonic-tooltip placement="bottom-start" label="bottom-start"><sonic-button minWidth="9rem">bottom-start</sonic-button></sonic-tooltip>
|
|
35
|
-
<sonic-tooltip placement="bottom-end" label="bottom-end"><sonic-button minWidth="9rem">bottom-end</sonic-button></sonic-tooltip>
|
|
36
|
-
<sonic-tooltip placement="left" label="left"><sonic-button minWidth="9rem">left</sonic-button></sonic-tooltip>
|
|
37
|
-
<sonic-tooltip placement="left-start" label="left-start"><sonic-button minWidth="9rem">left-start</sonic-button></sonic-tooltip>
|
|
38
|
-
<sonic-tooltip placement="left-end" label="left-end"><sonic-button minWidth="9rem">left-end</sonic-button></sonic-tooltip>
|
|
39
|
-
<sonic-tooltip placement="right" label="right"><sonic-button minWidth="9rem">right</sonic-button></sonic-tooltip>
|
|
40
|
-
<sonic-tooltip placement="right-start" label="right-start"><sonic-button minWidth="9rem">right-start</sonic-button></sonic-tooltip>
|
|
41
|
-
<sonic-tooltip placement="right-end" label="right-end"><sonic-button minWidth="9rem">right-end</sonic-button></sonic-tooltip>
|
|
42
|
-
</div>
|
|
43
|
-
</code></pre>
|
|
44
|
-
<h2 id="multiline-label">Multiline label</h2>
|
|
45
|
-
<p>Line breaks in <code>label</code> (a real newline or <code>&#10;</code>) are kept. Each line is trimmed and the bubble wraps at <code>18rem</code>.</p>
|
|
46
|
-
<pre><code><sonic-tooltip label="Gate B12&#10;Boarding at 08:15">
|
|
47
|
-
<sonic-button variant="outline">Multiline label</sonic-button>
|
|
48
|
-
</sonic-tooltip>
|
|
49
|
-
</code></pre>
|
|
50
|
-
<h2 id="focusable">Focusable</h2>
|
|
51
|
-
<p>Set <code>focusable</code> when the trigger is not focusable itself (text, icon): the host gets <code>tabindex="0"</code> so keyboard users can open the tooltip. The bubble uses <code>popover="hint"</code>; without Popover API support, the label falls back to a native <code>title</code> on one line.</p>
|
|
52
|
-
<pre><code><sonic-tooltip
|
|
53
|
-
focusable
|
|
54
|
-
label="The Concorde made its first transatlantic crossing on September 26, 1973"
|
|
55
|
-
>
|
|
56
|
-
<sonic-icon library="iconoir" name="chat-bubble-question"></sonic-icon>
|
|
57
|
-
Focus or hover this text
|
|
58
|
-
</sonic-tooltip>
|
|
59
|
-
</code></pre>
|
|
60
|
-
<h2 id="disabled">Disabled</h2>
|
|
61
|
-
<p><code>disabled</code> never shows the bubble and sets <code>tabindex="-1"</code> on the host.</p>
|
|
62
|
-
<pre><code><sonic-tooltip disabled label="Not shown">
|
|
63
|
-
<sonic-button>Tooltip disabled</sonic-button>
|
|
64
|
-
</sonic-tooltip>
|
|
65
|
-
</code></pre>
|
|
66
|
-
<h2 id="api-reference">API reference</h2>
|
|
67
|
-
<table>
|
|
68
|
-
<thead>
|
|
69
|
-
<tr>
|
|
70
|
-
<th>Attribute</th>
|
|
71
|
-
<th>Values</th>
|
|
72
|
-
<th>Description</th>
|
|
73
|
-
</tr>
|
|
74
|
-
</thead>
|
|
75
|
-
<tbody><tr>
|
|
76
|
-
<td><code>label</code></td>
|
|
77
|
-
<td>string</td>
|
|
78
|
-
<td>Tooltip text; empty or whitespace-only hides the bubble</td>
|
|
79
|
-
</tr>
|
|
80
|
-
<tr>
|
|
81
|
-
<td><code>placement</code></td>
|
|
82
|
-
<td><code>top</code> (default) · <code>bottom</code> · <code>left</code> · <code>right</code>, each with optional <code>-start</code> · <code>-end</code></td>
|
|
83
|
-
<td>Side and alignment relative to the trigger</td>
|
|
84
|
-
</tr>
|
|
85
|
-
<tr>
|
|
86
|
-
<td><code>disabled</code></td>
|
|
87
|
-
<td>boolean</td>
|
|
88
|
-
<td>Never show the bubble; sets <code>tabindex="-1"</code> on the host</td>
|
|
89
|
-
</tr>
|
|
90
|
-
<tr>
|
|
91
|
-
<td><code>focusable</code></td>
|
|
92
|
-
<td>boolean</td>
|
|
93
|
-
<td>Sets <code>tabindex="0"</code> on the host so the tooltip opens on keyboard focus</td>
|
|
94
|
-
</tr>
|
|
95
|
-
</tbody></table>
|
|
96
|
-
<table>
|
|
97
|
-
<thead>
|
|
98
|
-
<tr>
|
|
99
|
-
<th>Slot</th>
|
|
100
|
-
<th>Description</th>
|
|
101
|
-
</tr>
|
|
102
|
-
</thead>
|
|
103
|
-
<tbody><tr>
|
|
104
|
-
<td><em>(default)</em></td>
|
|
105
|
-
<td>Trigger content</td>
|
|
106
|
-
</tr>
|
|
107
|
-
</tbody></table>
|
|
108
|
-
|
|
109
|
-
</article>
|
|
110
|
-
</main>
|
|
111
|
-
</body>
|
|
112
|
-
</html>
|
|
@@ -1,89 +0,0 @@
|
|
|
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 |
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/docs/decorators/ancestor-attribute" data-doc-id="docs/decorators/ancestor-attribute">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>@ancestorAttribute — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="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 dataProvid">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, docs/decorators/ancestor-attribute, ancestor-attribute, @ancestorAttribute, decorator, ancestorAttribute, dataProvider, connectedCallback, , "", dataprovider, { dynamic: true }, null, @state(), "${dataProvider}"">
|
|
9
|
-
<meta name="concorde-doc-id" content="docs/decorators/ancestor-attribute">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/docs/decorators/ancestor-attribute">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/docs/decorators/ancestor-attribute.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/ancestor-attribute">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 — @ancestorAttribute</strong>. 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 dataProvid <span>Doc ID: <code>docs/decorators/ancestor-attribute</code>. Keywords: Concorde, supersoniks, docs/decorators/ancestor-attribute, ancestor-attribute, @ancestorAttribute, decorator, ancestorAttribute, dataProvider, connectedCallback, , "", dataprovider, { dynamic: true }, null, @state(), "${dataProvider}". URL: <a href="https://concorde.supersoniks.org/docs/decorators/ancestor-attribute">https://concorde.supersoniks.org/docs/decorators/ancestor-attribute</a>.</span></p>
|
|
20
|
-
<h1 id="ancestorattribute">@ancestorAttribute</h1>
|
|
21
|
-
<p>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 <code>dataProvider</code> without passing it down by hand, typically to feed a dynamic key of <a href="/docs/decorators/subscribe">@subscribe</a>.</p>
|
|
22
|
-
<h2 id="import">Import</h2>
|
|
23
|
-
<pre><code class="language-typescript">import { ancestorAttribute } from "@supersoniks/concorde/decorators";
|
|
24
|
-
|
|
25
|
-
@ancestorAttribute("dataProvider")
|
|
26
|
-
dataProvider: string | null = null;
|
|
27
|
-
</code></pre>
|
|
28
|
-
<h2 id="read-once-at-connect">Read once at connect</h2>
|
|
29
|
-
<p>By default the value is read once, just before the component's <code>connectedCallback</code>, and never updated. The closest element with the attribute wins. If no ancestor has it, the property keeps its initial value.</p>
|
|
30
|
-
<pre><code><div dataProvider="flights.CN001" gate="B12">
|
|
31
|
-
<docs-demo-sources for="demo-ancestor-attribute"></docs-demo-sources>
|
|
32
|
-
<demo-ancestor-attribute></demo-ancestor-attribute>
|
|
33
|
-
</div>
|
|
34
|
-
</code></pre>
|
|
35
|
-
<p>An attribute present without a value (<code><div gate></code>) resolves to <code>""</code>. A camelCase name also matches its lowercase form (<code>dataProvider</code> and <code>dataprovider</code>).</p>
|
|
36
|
-
<h2 id="follow-dom-changes">Follow DOM changes</h2>
|
|
37
|
-
<p>With <code>{ dynamic: true }</code>, 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 <code>null</code>. Add <code>@state()</code> so Lit re-renders on each assignment.</p>
|
|
38
|
-
<pre><code class="language-typescript">@ancestorAttribute("dataProvider", { dynamic: true })
|
|
39
|
-
@state()
|
|
40
|
-
dataProvider: string | null = null;
|
|
41
|
-
</code></pre>
|
|
42
|
-
<p>Change the parent or outer value, insert a closer wrapper, or remove an attribute: the child always shows the nearest one.</p>
|
|
43
|
-
<pre><code><docs-demo-sources for="demo-ancestor-attribute-dynamic-section"></docs-demo-sources>
|
|
44
|
-
<demo-ancestor-attribute-dynamic-section></demo-ancestor-attribute-dynamic-section>
|
|
45
|
-
</code></pre>
|
|
46
|
-
<p>Keys of <a href="/docs/decorators/subscribe">@subscribe</a> and <a href="/docs/decorators/bind">@bind</a> that use the property as a placeholder (<code>"${dataProvider}"</code>) are re-resolved on each change.</p>
|
|
47
|
-
<h2 id="api-reference">API reference</h2>
|
|
48
|
-
<table>
|
|
49
|
-
<thead>
|
|
50
|
-
<tr>
|
|
51
|
-
<th>Argument</th>
|
|
52
|
-
<th>Type</th>
|
|
53
|
-
<th>Description</th>
|
|
54
|
-
</tr>
|
|
55
|
-
</thead>
|
|
56
|
-
<tbody><tr>
|
|
57
|
-
<td><code>attributeName</code></td>
|
|
58
|
-
<td><code>string</code></td>
|
|
59
|
-
<td>Attribute to look up on the host, then on its ancestors</td>
|
|
60
|
-
</tr>
|
|
61
|
-
<tr>
|
|
62
|
-
<td><code>options.dynamic</code></td>
|
|
63
|
-
<td><code>boolean</code> (default <code>false</code>)</td>
|
|
64
|
-
<td>Keep the property in sync with attribute changes and reparenting until disconnect; assigns <code>null</code> when no ancestor has the attribute</td>
|
|
65
|
-
</tr>
|
|
66
|
-
</tbody></table>
|
|
67
|
-
|
|
68
|
-
</article>
|
|
69
|
-
</main>
|
|
70
|
-
</body>
|
|
71
|
-
</html>
|
|
@@ -1,59 +0,0 @@
|
|
|
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 |
|
|
@@ -1,61 +0,0 @@
|
|
|
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>
|
|
@@ -1,40 +0,0 @@
|
|
|
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 |
|
|
@@ -1,86 +0,0 @@
|
|
|
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>
|
|
@@ -1,77 +0,0 @@
|
|
|
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 |
|