@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,397 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html>
|
|
2
|
-
<html lang="en" data-doc-url="https://concorde.supersoniks.org/core/components/functional/sdui" data-doc-id="core/components/functional/sdui/sdui">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<title>SDUI — Concorde by Supersoniks</title>
|
|
7
|
-
<meta name="description" content="sonic-sdui builds an interface from a JSON descriptor (server-driven UI). Pass the descriptor through props, or add fetch and an endpoint to load it like Fetch. It renders in the light DOM with displa">
|
|
8
|
-
<meta name="keywords" content="Concorde, supersoniks, core/components/functional/sdui/sdui, sdui, SDUI, functional component, sonic-sdui, web component, props, fetch, display: contents, nodes, tagName, div, attributes, textContent">
|
|
9
|
-
<meta name="concorde-doc-id" content="core/components/functional/sdui/sdui">
|
|
10
|
-
<link rel="canonical" href="https://concorde.supersoniks.org/core/components/functional/sdui">
|
|
11
|
-
<link rel="alternate" type="text/markdown" href="https://concorde.supersoniks.org/core/components/functional/sdui.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/functional/sdui">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 functional component — SDUI</strong>. sonic-sdui builds an interface from a JSON descriptor (server-driven UI). Pass the descriptor through props, or add fetch and an endpoint to load it like Fetch. It renders in the light DOM with displa <span>Doc ID: <code>core/components/functional/sdui/sdui</code>. Keywords: Concorde, supersoniks, core/components/functional/sdui/sdui, sdui, SDUI, functional component, sonic-sdui, web component, props, fetch, display: contents, nodes, tagName, div, attributes, textContent. URL: <a href="https://concorde.supersoniks.org/core/components/functional/sdui">https://concorde.supersoniks.org/core/components/functional/sdui</a>.</span></p>
|
|
20
|
-
<h1 id="sdui">SDUI</h1>
|
|
21
|
-
<p><strong><code>sonic-sdui</code></strong> builds an interface from a JSON descriptor (server-driven UI). Pass the descriptor through <code>props</code>, or add <code>fetch</code> and an endpoint to load it like <a href="/core/components/functional/fetch">Fetch</a>. It renders in the light DOM with <code>display: contents</code>, so an empty instance does not affect layout.</p>
|
|
22
|
-
<h2 id="basic-example">Basic example</h2>
|
|
23
|
-
<p>Each entry of <code>nodes</code> becomes an element: <code>tagName</code> (default <code>div</code>) · <code>attributes</code> · <code>textContent</code> · nested <code>nodes</code>.</p>
|
|
24
|
-
<pre><code><sonic-sdui
|
|
25
|
-
dataProvider="sdui-basic-example"
|
|
26
|
-
props='{
|
|
27
|
-
"nodes":[{
|
|
28
|
-
"tagName":"div",
|
|
29
|
-
"attributes":{ "class":"flex items-center gap-2" },
|
|
30
|
-
"nodes":[
|
|
31
|
-
{ "tagName":"strong", "textContent":"CN 001 · CDG → JFK" },
|
|
32
|
-
{ "tagName":"sonic-badge", "attributes":{ "type":"warning" }, "textContent":"Delayed" }
|
|
33
|
-
]
|
|
34
|
-
}]
|
|
35
|
-
}'
|
|
36
|
-
></sonic-sdui>
|
|
37
|
-
</code></pre>
|
|
38
|
-
<h2 id="fetching-a-descriptor">Fetching a descriptor</h2>
|
|
39
|
-
<p>Fetching is off by default: add the boolean <code>fetch</code> attribute, then configure <code>serviceURL</code> / <code>endPoint</code> / <code>dataProvider</code> as on <a href="/core/components/functional/fetch">Fetch</a>. Invalidating the publisher or changing the endpoint reloads the interface.</p>
|
|
40
|
-
<pre><code><sonic-sdui fetch dataProvider="sdui-fetch-example" endPoint="/src/core/components/functional/sdui/example.json"></sonic-sdui>
|
|
41
|
-
</code></pre>
|
|
42
|
-
<h2 id="html-content">HTML content</h2>
|
|
43
|
-
<p><code>markup</code> builds the node from an HTML string, <code>innerHTML</code> appends HTML inside the element, and <code>prefix</code> / <code>suffix</code> wrap it. Prefer <code>textContent</code> for anything coming from user data.</p>
|
|
44
|
-
<pre><code><sonic-sdui
|
|
45
|
-
dataProvider="sdui-html-example"
|
|
46
|
-
props='{
|
|
47
|
-
"nodes":[
|
|
48
|
-
{ "markup":"Cruising at &lt;sonic-badge&gt;Mach 2.04&lt;/sonic-badge&gt;" },
|
|
49
|
-
{ "tagName":"p", "prefix":"&lt;hr&gt;", "innerHTML":"Altitude: &lt;b&gt;60,000 ft&lt;/b&gt;" }
|
|
50
|
-
]
|
|
51
|
-
}'
|
|
52
|
-
></sonic-sdui>
|
|
53
|
-
</code></pre>
|
|
54
|
-
<h2 id="library">Library</h2>
|
|
55
|
-
<p>A node with <code>libraryKey</code> uses a library entry as its model, then adds its own attributes and children. In the model, <code>contentElementSelector</code> sets where those children go. The descriptor <code>library</code> is merged over a default library of form fields (<code>textfield</code> · <code>email</code> · <code>password</code> · <code>date</code> · <code>select</code> · <code>checkbox</code> · <code>radio</code> · <code>textarea</code> · <code>button</code> · <code>submit</code> · <code>fieldset</code>…, see <code>default-library.json</code>). The <code>library</code> attribute replaces it with a JSON file loaded from a URL.</p>
|
|
56
|
-
<pre><code><sonic-sdui
|
|
57
|
-
dataProvider="sdui-library-example"
|
|
58
|
-
props='{
|
|
59
|
-
"library":{
|
|
60
|
-
"flightCard":{
|
|
61
|
-
"tagName":"sonic-card",
|
|
62
|
-
"attributes":{ "class":"block max-w-sm" },
|
|
63
|
-
"nodes":[{ "tagName":"div", "attributes":{ "class":"text-sm" } }],
|
|
64
|
-
"contentElementSelector":"div"
|
|
65
|
-
}
|
|
66
|
-
},
|
|
67
|
-
"nodes":[
|
|
68
|
-
{ "libraryKey":"flightCard", "nodes":[{ "tagName":"span", "textContent":"CN 001 · Gate C4" }] },
|
|
69
|
-
{ "libraryKey":"email", "attributes":{ "label":"Passenger email", "name":"email", "class":"block mt-4 max-w-sm" } }
|
|
70
|
-
]
|
|
71
|
-
}'
|
|
72
|
-
></sonic-sdui>
|
|
73
|
-
</code></pre>
|
|
74
|
-
<h2 id="child-placement">Child placement</h2>
|
|
75
|
-
<p>A child with <code>parentElementSelector</code> is appended to the first element matching that selector inside its parent, instead of the parent itself. It has no effect on top-level nodes.</p>
|
|
76
|
-
<pre><code><sonic-sdui
|
|
77
|
-
dataProvider="sdui-parent-selector-example"
|
|
78
|
-
props='{
|
|
79
|
-
"nodes":[{
|
|
80
|
-
"nodes":[
|
|
81
|
-
{ "tagName":"strong", "textContent":"Departures" },
|
|
82
|
-
{ "tagName":"ul" },
|
|
83
|
-
{ "tagName":"li", "parentElementSelector":"ul", "textContent":"CN 001 · CDG → JFK" },
|
|
84
|
-
{ "tagName":"li", "parentElementSelector":"ul", "textContent":"CN 003 · LHR → JFK" }
|
|
85
|
-
]
|
|
86
|
-
}]
|
|
87
|
-
}'
|
|
88
|
-
></sonic-sdui>
|
|
89
|
-
</code></pre>
|
|
90
|
-
<h2 id="actions">Actions</h2>
|
|
91
|
-
<p>A node with <code>action: { name, context? }</code> makes a click on its element dispatch an <code>sdui-action</code> event from <code>sonic-sdui</code>. <code>detail</code> is <code>{ name, context, sourceNodeId? }</code>, where <code>sourceNodeId</code> is the node <code>nodeId</code>. The event bubbles and is composed, so a page shell can listen once for every node. Form posting stays with <a href="/core/components/functional/submit">Submit</a>.</p>
|
|
92
|
-
<pre><code><sonic-sdui
|
|
93
|
-
id="sdui-action-example"
|
|
94
|
-
dataProvider="sdui-action-example"
|
|
95
|
-
props='{
|
|
96
|
-
"nodes":[{
|
|
97
|
-
"tagName":"sonic-button",
|
|
98
|
-
"nodeId":"check-in",
|
|
99
|
-
"textContent":"Check in",
|
|
100
|
-
"action":{ "name":"check-in", "context":{ "flight":"CN 001" } }
|
|
101
|
-
}]
|
|
102
|
-
}'
|
|
103
|
-
></sonic-sdui>
|
|
104
|
-
</code></pre>
|
|
105
|
-
<pre><code class="language-typescript">document.querySelector("#sdui-action-example")?.addEventListener("sdui-action", (e) => {
|
|
106
|
-
const { name, context, sourceNodeId } = (e as CustomEvent).detail;
|
|
107
|
-
});
|
|
108
|
-
</code></pre>
|
|
109
|
-
<h2 id="safe-profile">Safe profile</h2>
|
|
110
|
-
<p>With <code>profile="safe"</code>, the descriptor cannot inject HTML or scripts: <code>js</code> URLs are not loaded, and nodes using <code>markup</code> / <code>innerHTML</code> / <code>prefix</code> / <code>suffix</code> (directly or through their library model) are skipped with a <code>console.warn</code>. <code>textContent</code>, attributes and actions still work. Without the attribute, everything is rendered.</p>
|
|
111
|
-
<pre><code><sonic-sdui
|
|
112
|
-
profile="safe"
|
|
113
|
-
dataProvider="sdui-safe-example"
|
|
114
|
-
props='{
|
|
115
|
-
"nodes":[
|
|
116
|
-
{ "tagName":"p", "textContent":"Gate C4 · Boarding at 10:40" },
|
|
117
|
-
{ "innerHTML":"&lt;b&gt;Skipped: HTML is refused&lt;/b&gt;" }
|
|
118
|
-
]
|
|
119
|
-
}'
|
|
120
|
-
></sonic-sdui>
|
|
121
|
-
</code></pre>
|
|
122
|
-
<p>To check a descriptor before rendering it, <code>validateSafeDescriptor(descriptor)</code> from <code>@supersoniks/concorde/sdui-safe</code> returns the violations as <code>{ path, field, message }[]</code> without side effects.</p>
|
|
123
|
-
<h2 id="partial-rendering">Partial rendering</h2>
|
|
124
|
-
<p>Declare nodes once in <code>nodeById</code> and reference them with <code>childNodeIds</code>. With the boolean <code>partial</code>, a missing id renders an empty placeholder (<code>data-sdui-placeholder</code> · <code>aria-hidden</code> · <code>display: contents</code>) so the node can arrive later. Without it, the missing child is skipped with a <code>console.warn</code>.</p>
|
|
125
|
-
<pre><code><sonic-sdui
|
|
126
|
-
partial
|
|
127
|
-
dataProvider="sdui-partial-example"
|
|
128
|
-
props='{
|
|
129
|
-
"nodes":[{ "tagName":"div", "childNodeIds":["flight", "gate"] }],
|
|
130
|
-
"nodeById":{
|
|
131
|
-
"flight":{ "tagName":"strong", "textContent":"CN 001 · CDG → JFK" }
|
|
132
|
-
}
|
|
133
|
-
}'
|
|
134
|
-
></sonic-sdui>
|
|
135
|
-
</code></pre>
|
|
136
|
-
<h2 id="incremental-updates">Incremental updates</h2>
|
|
137
|
-
<p><code>upsertNode</code> · <code>removeNode</code> · <code>setData</code> patch the rendered interface without a full rebuild, so sibling nodes keep their state (focus, input values). A node needs a <code>nodeId</code> to be updated. The first operation switches the component to incremental mode, where <code>props</code> changes are ignored until <code>endIncremental()</code>. To drive it from data, set <code>opsDataProvider</code>: each value assigned to that publisher (<code>SDUIOp</code> or <code>SDUIOp[]</code>) goes through <code>applyOp</code>.</p>
|
|
138
|
-
<pre><code><sonic-sdui
|
|
139
|
-
id="sdui-ops-example"
|
|
140
|
-
dataProvider="sdui-ops-example"
|
|
141
|
-
props='{
|
|
142
|
-
"nodes":[
|
|
143
|
-
{ "nodeId":"cn001", "tagName":"p", "textContent":"CN 001 · CDG → JFK · On time" },
|
|
144
|
-
{ "nodeId":"cn003", "tagName":"p", "textContent":"CN 003 · LHR → JFK · Boarding" }
|
|
145
|
-
]
|
|
146
|
-
}'
|
|
147
|
-
></sonic-sdui>
|
|
148
|
-
<sonic-button size="sm" onclick="document.getElementById('sdui-ops-example').upsertNode({ nodeId: 'cn001', tagName: 'p', textContent: 'CN 001 · CDG → JFK · Delayed 20 min' })">Delay CN 001</sonic-button>
|
|
149
|
-
<sonic-button size="sm" variant="outline" onclick="document.getElementById('sdui-ops-example').removeNode('cn003')">Remove CN 003</sonic-button>
|
|
150
|
-
</code></pre>
|
|
151
|
-
<h2 id="transformations">Transformations</h2>
|
|
152
|
-
<p>The <code>transformation</code> attribute points to a JSON file applied to the descriptor before rendering. Its <code>library</code> is merged into the descriptor library; each entry of <code>transforms</code> runs an action on the nodes matching <code>patterns</code>.</p>
|
|
153
|
-
<pre><code class="language-typescript">{
|
|
154
|
-
"transforms": [
|
|
155
|
-
{ "action": "remap", "patterns": [{ "libraryKey": "textfield" }], "ui": { "tagName": "sonic-input", "attributes": { "size": "lg" } } },
|
|
156
|
-
{ "action": "insert", "after": { "libraryKey": "email" }, "ui": { "tagName": "p", "textContent": "Boarding pass sent by email" } }
|
|
157
|
-
]
|
|
158
|
-
}
|
|
159
|
-
</code></pre>
|
|
160
|
-
<table>
|
|
161
|
-
<thead>
|
|
162
|
-
<tr>
|
|
163
|
-
<th>Action</th>
|
|
164
|
-
<th>Effect</th>
|
|
165
|
-
</tr>
|
|
166
|
-
</thead>
|
|
167
|
-
<tbody><tr>
|
|
168
|
-
<td><code>remap</code></td>
|
|
169
|
-
<td>Replaces each matched node with <code>ui</code>, keeping its attributes, content and children unless <code>ui</code> redefines them</td>
|
|
170
|
-
</tr>
|
|
171
|
-
<tr>
|
|
172
|
-
<td><code>unwrap</code></td>
|
|
173
|
-
<td>Replaces each matched node with its children</td>
|
|
174
|
-
</tr>
|
|
175
|
-
<tr>
|
|
176
|
-
<td><code>wrap</code></td>
|
|
177
|
-
<td>Groups the matched nodes into the <code>ui</code> node</td>
|
|
178
|
-
</tr>
|
|
179
|
-
<tr>
|
|
180
|
-
<td><code>delete</code></td>
|
|
181
|
-
<td>Removes the matched nodes</td>
|
|
182
|
-
</tr>
|
|
183
|
-
<tr>
|
|
184
|
-
<td><code>insert</code></td>
|
|
185
|
-
<td>Inserts <code>ui</code> relative to the node matched by <code>before</code> · <code>after</code> · <code>in</code></td>
|
|
186
|
-
</tr>
|
|
187
|
-
<tr>
|
|
188
|
-
<td><code>move</code></td>
|
|
189
|
-
<td>Moves the matched nodes next to the node matched by <code>before</code> or <code>after</code></td>
|
|
190
|
-
</tr>
|
|
191
|
-
</tbody></table>
|
|
192
|
-
<h2 id="wrapped-descriptor">Wrapped descriptor</h2>
|
|
193
|
-
<p>When the descriptor is one key of a larger payload, set <code>sduiKey</code> to that key. Set <code>messagesKey</code> to render the toast messages found at that key with <code>sonic-toast-message-subscriber</code> (<code>{ content, status, type }</code> items).</p>
|
|
194
|
-
<pre><code><sonic-sdui
|
|
195
|
-
sduiKey="ui"
|
|
196
|
-
dataProvider="sdui-key-example"
|
|
197
|
-
props='{
|
|
198
|
-
"flight":"CN 001",
|
|
199
|
-
"ui":{ "nodes":[{ "tagName":"p", "textContent":"Weather warning: turbulence expected over the Atlantic" }] }
|
|
200
|
-
}'
|
|
201
|
-
></sonic-sdui>
|
|
202
|
-
</code></pre>
|
|
203
|
-
<h2 id="component-catalog">Component catalog</h2>
|
|
204
|
-
<p>The package ships a JSON catalog of every custom element (<code>tag</code>; <code>props</code> with attribute / type / allowed values / default; slots and events), generated at build time for descriptor authors and tools. It has no runtime cost. Elements with thin annotations are listed in <code>component-catalog.gaps.json</code>.</p>
|
|
205
|
-
<pre><code class="language-typescript">import catalog from "@supersoniks/concorde/sdui/component-catalog.json";
|
|
206
|
-
</code></pre>
|
|
207
|
-
<h2 id="playground">Playground</h2>
|
|
208
|
-
<p>Edit the descriptor and leave the field to render it.</p>
|
|
209
|
-
<pre><code><sonic-textarea
|
|
210
|
-
rows="8"
|
|
211
|
-
onChange="SonicPublisherManager.get('sdui-playground').set(JSON.parse(this.value))"
|
|
212
|
-
value='{"nodes":[{"tagName":"sonic-badge", "attributes":{"type":"success"}, "textContent":"CN 001 landed"}]}'
|
|
213
|
-
></sonic-textarea>
|
|
214
|
-
<sonic-sdui dataProvider="sdui-playground" props='{"nodes":[{"tagName":"sonic-badge", "attributes":{"type":"success"}, "textContent":"CN 001 landed"}]}'></sonic-sdui>
|
|
215
|
-
</code></pre>
|
|
216
|
-
<h2 id="api-reference">API reference</h2>
|
|
217
|
-
<table>
|
|
218
|
-
<thead>
|
|
219
|
-
<tr>
|
|
220
|
-
<th>Attribute</th>
|
|
221
|
-
<th>Values</th>
|
|
222
|
-
<th>Description</th>
|
|
223
|
-
</tr>
|
|
224
|
-
</thead>
|
|
225
|
-
<tbody><tr>
|
|
226
|
-
<td><code>dataProvider</code></td>
|
|
227
|
-
<td>string</td>
|
|
228
|
-
<td>Publisher holding the descriptor. Required</td>
|
|
229
|
-
</tr>
|
|
230
|
-
<tr>
|
|
231
|
-
<td><code>props</code></td>
|
|
232
|
-
<td><code>SDUIDescriptor</code> (JSON)</td>
|
|
233
|
-
<td>Descriptor to render</td>
|
|
234
|
-
</tr>
|
|
235
|
-
<tr>
|
|
236
|
-
<td><code>fetch</code></td>
|
|
237
|
-
<td>boolean</td>
|
|
238
|
-
<td>Loads the descriptor from <code>serviceURL</code> + <code>endPoint</code> (or <code>dataProvider</code>). Other request attributes as on <a href="/core/components/functional/fetch">Fetch</a></td>
|
|
239
|
-
</tr>
|
|
240
|
-
<tr>
|
|
241
|
-
<td><code>sduiKey</code></td>
|
|
242
|
-
<td>string</td>
|
|
243
|
-
<td>Reads the descriptor from <code>props[sduiKey]</code></td>
|
|
244
|
-
</tr>
|
|
245
|
-
<tr>
|
|
246
|
-
<td><code>messagesKey</code></td>
|
|
247
|
-
<td>string</td>
|
|
248
|
-
<td>Path in <code>props</code> of the toast messages to display</td>
|
|
249
|
-
</tr>
|
|
250
|
-
<tr>
|
|
251
|
-
<td><code>profile</code></td>
|
|
252
|
-
<td><code>safe</code></td>
|
|
253
|
-
<td>Refuses <code>js</code> / <code>markup</code> / <code>innerHTML</code> / <code>prefix</code> / <code>suffix</code>. Unset by default</td>
|
|
254
|
-
</tr>
|
|
255
|
-
<tr>
|
|
256
|
-
<td><code>partial</code></td>
|
|
257
|
-
<td>boolean</td>
|
|
258
|
-
<td>Renders a placeholder for missing <code>childNodeIds</code></td>
|
|
259
|
-
</tr>
|
|
260
|
-
<tr>
|
|
261
|
-
<td><code>library</code></td>
|
|
262
|
-
<td>URL</td>
|
|
263
|
-
<td>JSON library that replaces the descriptor library</td>
|
|
264
|
-
</tr>
|
|
265
|
-
<tr>
|
|
266
|
-
<td><code>transformation</code></td>
|
|
267
|
-
<td>URL</td>
|
|
268
|
-
<td>JSON transform description applied before rendering</td>
|
|
269
|
-
</tr>
|
|
270
|
-
<tr>
|
|
271
|
-
<td><code>opsDataProvider</code></td>
|
|
272
|
-
<td>string</td>
|
|
273
|
-
<td>Publisher whose assigned values are passed to <code>applyOp</code></td>
|
|
274
|
-
</tr>
|
|
275
|
-
</tbody></table>
|
|
276
|
-
<table>
|
|
277
|
-
<thead>
|
|
278
|
-
<tr>
|
|
279
|
-
<th>Descriptor key</th>
|
|
280
|
-
<th>Description</th>
|
|
281
|
-
</tr>
|
|
282
|
-
</thead>
|
|
283
|
-
<tbody><tr>
|
|
284
|
-
<td><code>nodes</code></td>
|
|
285
|
-
<td>Root nodes</td>
|
|
286
|
-
</tr>
|
|
287
|
-
<tr>
|
|
288
|
-
<td><code>nodeById</code></td>
|
|
289
|
-
<td>Flat registry of nodes for <code>childNodeIds</code></td>
|
|
290
|
-
</tr>
|
|
291
|
-
<tr>
|
|
292
|
-
<td><code>library</code></td>
|
|
293
|
-
<td>Node models by key, merged over the default library</td>
|
|
294
|
-
</tr>
|
|
295
|
-
<tr>
|
|
296
|
-
<td><code>js</code> / <code>css</code></td>
|
|
297
|
-
<td>Script and stylesheet URLs to load (<code>js</code> refused in safe profile)</td>
|
|
298
|
-
</tr>
|
|
299
|
-
</tbody></table>
|
|
300
|
-
<table>
|
|
301
|
-
<thead>
|
|
302
|
-
<tr>
|
|
303
|
-
<th>Node field</th>
|
|
304
|
-
<th>Description</th>
|
|
305
|
-
</tr>
|
|
306
|
-
</thead>
|
|
307
|
-
<tbody><tr>
|
|
308
|
-
<td><code>tagName</code></td>
|
|
309
|
-
<td>Element tag (default <code>div</code>)</td>
|
|
310
|
-
</tr>
|
|
311
|
-
<tr>
|
|
312
|
-
<td><code>attributes</code></td>
|
|
313
|
-
<td>Attribute name → value (objects are serialized to JSON)</td>
|
|
314
|
-
</tr>
|
|
315
|
-
<tr>
|
|
316
|
-
<td><code>nodes</code></td>
|
|
317
|
-
<td>Child nodes</td>
|
|
318
|
-
</tr>
|
|
319
|
-
<tr>
|
|
320
|
-
<td><code>childNodeIds</code></td>
|
|
321
|
-
<td>Child <code>nodeId</code>s resolved from <code>nodeById</code> or the tree</td>
|
|
322
|
-
</tr>
|
|
323
|
-
<tr>
|
|
324
|
-
<td><code>textContent</code></td>
|
|
325
|
-
<td>Plain text. Ignored when the node has children</td>
|
|
326
|
-
</tr>
|
|
327
|
-
<tr>
|
|
328
|
-
<td><code>markup</code> · <code>innerHTML</code> · <code>prefix</code> · <code>suffix</code></td>
|
|
329
|
-
<td>HTML strings (refused in safe profile)</td>
|
|
330
|
-
</tr>
|
|
331
|
-
<tr>
|
|
332
|
-
<td><code>libraryKey</code></td>
|
|
333
|
-
<td>Library entry used as the model</td>
|
|
334
|
-
</tr>
|
|
335
|
-
<tr>
|
|
336
|
-
<td><code>contentElementSelector</code></td>
|
|
337
|
-
<td>In a library model: where children are appended</td>
|
|
338
|
-
</tr>
|
|
339
|
-
<tr>
|
|
340
|
-
<td><code>parentElementSelector</code></td>
|
|
341
|
-
<td>Appends the node to a matching element of its parent</td>
|
|
342
|
-
</tr>
|
|
343
|
-
<tr>
|
|
344
|
-
<td><code>nodeId</code></td>
|
|
345
|
-
<td>Logical id for actions, <code>childNodeIds</code> and incremental updates (rendered as <code>data-sdui-node-id</code>)</td>
|
|
346
|
-
</tr>
|
|
347
|
-
<tr>
|
|
348
|
-
<td><code>action</code></td>
|
|
349
|
-
<td><code>{ name, context? }</code> dispatched as <code>sdui-action</code> on click</td>
|
|
350
|
-
</tr>
|
|
351
|
-
</tbody></table>
|
|
352
|
-
<table>
|
|
353
|
-
<thead>
|
|
354
|
-
<tr>
|
|
355
|
-
<th>Method</th>
|
|
356
|
-
<th>Description</th>
|
|
357
|
-
</tr>
|
|
358
|
-
</thead>
|
|
359
|
-
<tbody><tr>
|
|
360
|
-
<td><code>upsertNode(node, parentId?, index?)</code></td>
|
|
361
|
-
<td>Adds or replaces a node by <code>nodeId</code></td>
|
|
362
|
-
</tr>
|
|
363
|
-
<tr>
|
|
364
|
-
<td><code>removeNode(nodeId)</code></td>
|
|
365
|
-
<td>Removes a node</td>
|
|
366
|
-
</tr>
|
|
367
|
-
<tr>
|
|
368
|
-
<td><code>setData(path, value)</code></td>
|
|
369
|
-
<td>Sets a publisher path (<code>form.email</code>), absolute or relative to <code>dataProvider</code></td>
|
|
370
|
-
</tr>
|
|
371
|
-
<tr>
|
|
372
|
-
<td><code>applyOp(op)</code></td>
|
|
373
|
-
<td>Runs an <code>SDUIOp</code>: <code>upsertNode</code> · <code>removeNode</code> · <code>setData</code></td>
|
|
374
|
-
</tr>
|
|
375
|
-
<tr>
|
|
376
|
-
<td><code>endIncremental()</code></td>
|
|
377
|
-
<td>Leaves incremental mode; the next <code>props</code> change rebuilds everything</td>
|
|
378
|
-
</tr>
|
|
379
|
-
</tbody></table>
|
|
380
|
-
<table>
|
|
381
|
-
<thead>
|
|
382
|
-
<tr>
|
|
383
|
-
<th>Event</th>
|
|
384
|
-
<th>Detail</th>
|
|
385
|
-
</tr>
|
|
386
|
-
</thead>
|
|
387
|
-
<tbody><tr>
|
|
388
|
-
<td><code>sdui-action</code></td>
|
|
389
|
-
<td><code>{ name, context, sourceNodeId? }</code></td>
|
|
390
|
-
</tr>
|
|
391
|
-
</tbody></table>
|
|
392
|
-
<p>No slots.</p>
|
|
393
|
-
|
|
394
|
-
</article>
|
|
395
|
-
</main>
|
|
396
|
-
</body>
|
|
397
|
-
</html>
|