@supersoniks/concorde 5.0.5 → 5.1.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/.claude/launch.json +15 -0
- package/.claude/vite.http.config.mjs +7 -0
- package/.taste-skill/after/desktop-fold.jpg +0 -0
- package/.taste-skill/after/desktop-page-01.jpg +0 -0
- package/.taste-skill/after/desktop-page-02.jpg +0 -0
- package/.taste-skill/after/desktop-page-03.jpg +0 -0
- package/.taste-skill/after/mobile-fold.jpg +0 -0
- package/.taste-skill/after/mobile-page-01.jpg +0 -0
- package/.taste-skill/after/report.json +4103 -0
- package/.taste-skill/after/tablet-fold.jpg +0 -0
- package/.taste-skill/after/tablet-page-01.jpg +0 -0
- package/.taste-skill/after/tablet-page-02.jpg +0 -0
- package/.taste-skill/before/desktop-fold.jpg +0 -0
- package/.taste-skill/before/desktop-page-01.jpg +0 -0
- package/.taste-skill/before/desktop-page-02.jpg +0 -0
- package/.taste-skill/before/mobile-fold.jpg +0 -0
- package/.taste-skill/before/mobile-page-01.jpg +0 -0
- package/.taste-skill/before/report.json +2556 -0
- package/.taste-skill/before/tablet-fold.jpg +0 -0
- package/.taste-skill/before/tablet-page-01.jpg +0 -0
- package/.taste-skill/direction.json +510 -0
- package/.taste-skill/notes.md +84 -0
- package/.taste-skill/prod/desktop-fold.jpg +0 -0
- package/.taste-skill/prod/desktop-page-01.jpg +0 -0
- package/.taste-skill/prod/desktop-page-02.jpg +0 -0
- package/.taste-skill/prod/desktop-page-03.jpg +0 -0
- package/.taste-skill/prod/mobile-fold.jpg +0 -0
- package/.taste-skill/prod/mobile-page-01.jpg +0 -0
- package/.taste-skill/prod/mobile-page-02.jpg +0 -0
- package/.taste-skill/prod/report.json +1973 -0
- package/.taste-skill/prod/tablet-fold.jpg +0 -0
- package/.taste-skill/prod/tablet-page-01.jpg +0 -0
- package/.taste-skill/prod/tablet-page-02.jpg +0 -0
- package/.tmp-cem/custom-elements.json +13705 -0
- package/AUDIT.md +228 -0
- package/PLAN-AMELIORATION.md +220 -0
- package/build-infos.json +1 -1
- package/concorde-core.bundle.js +196 -196
- package/concorde-core.es.js +3854 -3572
- package/custom-elements-manifest.config.mjs +14 -0
- package/dist/concorde-core.bundle.js +196 -196
- package/dist/concorde-core.es.js +3854 -3572
- package/dist/img/archive/concorde-001-2cv.webp +0 -0
- package/dist/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
- package/dist/img/archive/concorde-red-arrows-2002.webm +0 -0
- package/dist/img/archive/credits.json +28 -0
- package/docs/assets/index-Bb-_LRyY.js +12280 -0
- package/docs/index.html +1 -1
- package/index.html +27 -63
- package/package.json +44 -3
- package/public/img/archive/concorde-001-2cv.webp +0 -0
- package/public/img/archive/concorde-red-arrows-2002-poster.jpg +0 -0
- package/public/img/archive/concorde-red-arrows-2002.webm +0 -0
- package/public/img/archive/credits.json +28 -0
- package/scripts/generate-sdui-catalog.mjs +250 -0
- package/scripts/generate-sdui-catalog.spec.ts +91 -0
- package/scripts/pre-build.mjs +15 -0
- package/src/core/components/functional/fetch/fetch.md +2 -2
- package/src/core/components/functional/sdui/SDUIDescriptorTransformer.ts +5 -5
- package/src/core/components/functional/sdui/__fixtures__/descriptors.ts +251 -0
- package/src/core/components/functional/sdui/__snapshots__/sdui-action.spec.ts.snap +73 -0
- package/src/core/components/functional/sdui/__snapshots__/sdui-incremental.spec.ts.snap +50 -0
- package/src/core/components/functional/sdui/__snapshots__/sdui-partial.spec.ts.snap +50 -0
- package/src/core/components/functional/sdui/__snapshots__/sdui.regression.spec.ts.snap +461 -0
- package/src/core/components/functional/sdui/component-catalog.gaps.json +511 -0
- package/src/core/components/functional/sdui/component-catalog.json +3103 -0
- package/src/core/components/functional/sdui/component-catalog.spec.ts +23 -0
- package/src/core/components/functional/sdui/sdui-action.spec.ts +99 -0
- package/src/core/components/functional/sdui/sdui-dom-snapshot.ts +61 -0
- package/src/core/components/functional/sdui/sdui-extension-points.md +94 -0
- package/src/core/components/functional/sdui/sdui-incremental.spec.ts +137 -0
- package/src/core/components/functional/sdui/sdui-partial.spec.ts +83 -0
- package/src/core/components/functional/sdui/sdui-partial.ts +19 -0
- package/src/core/components/functional/sdui/sdui-safe.spec.ts +188 -0
- package/src/core/components/functional/sdui/sdui-safe.ts +100 -0
- package/src/core/components/functional/sdui/sdui.md +122 -0
- package/src/core/components/functional/sdui/sdui.regression.spec.ts +64 -0
- package/src/core/components/functional/sdui/sdui.ts +442 -34
- package/src/core/components/functional/sdui/types.ts +49 -0
- package/src/core/components/ui/modal/modal.ts +14 -11
- package/src/docs/_getting-started/components.md +5 -0
- package/src/docs/_getting-started/theming.md +2 -2
- package/src/docs/code.ts +88 -75
- package/src/docs/components/docs-demo-sources.ts +16 -8
- package/src/docs/components/docs-lit-demo.ts +19 -37
- package/src/docs/docs.ts +5 -0
- package/src/docs/example/docs-boarding-pass-demo.ts +134 -0
- package/src/docs/example/docs-provider-keys.ts +12 -0
- package/src/docs/header/header.ts +233 -69
- package/src/docs/home/catalog.ts +44 -0
- package/src/docs/home/home.ts +513 -0
- package/src/docs/home/mach-stage.ts +389 -0
- package/src/docs/layout.ts +3 -1
- package/src/docs/navigation/components-index.ts +56 -0
- package/src/docs/navigation/navigation.ts +240 -232
- package/src/docs/navigation/pager.ts +67 -0
- package/src/docs/navigation/toc.ts +98 -0
- package/src/docs/search/docs-search.json +330 -20
- package/src/docs/search/markdown-renderer.ts +11 -3
- package/src/docs/shiki/index.ts +109 -0
- package/src/docs/tailwind/css/base/scrollbar.css +22 -0
- package/src/docs/tailwind/css/base/theme.css +96 -0
- package/src/docs/tailwind/css/base/typography.css +4 -0
- package/src/docs/tailwind/css/docs/boarding-pass.css +65 -0
- package/src/docs/tailwind/css/docs/content.css +32 -0
- package/src/docs/tailwind/css/docs/page.css +10 -0
- package/src/docs/tailwind/css/docs.css +9 -0
- package/src/docs/tailwind/css/home/hero.css +210 -0
- package/src/docs/tailwind/css/home/motion.css +84 -0
- package/src/docs/tailwind/css/home/sections.css +416 -0
- package/src/docs/tailwind/css/tailwind.css +7 -185
- package/src/tsconfig.json +113 -2
- package/src/tsconfig.tsbuildinfo +1 -1
- package/tailwind.config.js +8 -4
- package/docs/assets/index-wVZpLVYW.js +0 -12122
- package/docs/crawl/core/components/functional/date/date.html +0 -190
- package/docs/crawl/core/components/functional/fetch/fetch.html +0 -109
- package/docs/crawl/core/components/functional/if/if.html +0 -27
- package/docs/crawl/core/components/functional/jsonata/jsonata.html +0 -79
- package/docs/crawl/core/components/functional/list/list.html +0 -70
- package/docs/crawl/core/components/functional/mix/mix.html +0 -45
- package/docs/crawl/core/components/functional/queue/queue.html +0 -96
- package/docs/crawl/core/components/functional/router/router.html +0 -106
- package/docs/crawl/core/components/functional/sdui/sdui.html +0 -269
- package/docs/crawl/core/components/functional/states/states.html +0 -66
- package/docs/crawl/core/components/functional/submit/submit.html +0 -160
- package/docs/crawl/core/components/functional/subscriber/subscriber.html +0 -67
- package/docs/crawl/core/components/functional/value/value.html +0 -51
- package/docs/crawl/core/components/ui/alert/alert.html +0 -211
- package/docs/crawl/core/components/ui/alert-messages/alert-messages.html +0 -131
- package/docs/crawl/core/components/ui/badge/badge.html +0 -197
- package/docs/crawl/core/components/ui/button/button.html +0 -150
- package/docs/crawl/core/components/ui/captcha/captcha.html +0 -112
- package/docs/crawl/core/components/ui/card/card.html +0 -253
- package/docs/crawl/core/components/ui/divider/divider.html +0 -144
- package/docs/crawl/core/components/ui/form/checkbox/checkbox.html +0 -73
- package/docs/crawl/core/components/ui/form/fieldset/fieldset.html +0 -266
- package/docs/crawl/core/components/ui/form/form-actions/form-actions.html +0 -122
- package/docs/crawl/core/components/ui/form/form-layout/form-layout.html +0 -121
- package/docs/crawl/core/components/ui/form/input/input.html +0 -109
- package/docs/crawl/core/components/ui/form/input-autocomplete/input-autocomplete.html +0 -38
- package/docs/crawl/core/components/ui/form/radio/radio.html +0 -56
- package/docs/crawl/core/components/ui/form/select/select.html +0 -73
- package/docs/crawl/core/components/ui/form/switch/switch.html +0 -56
- package/docs/crawl/core/components/ui/form/textarea/textarea.html +0 -59
- package/docs/crawl/core/components/ui/group/group.html +0 -104
- package/docs/crawl/core/components/ui/icon/icon.html +0 -222
- package/docs/crawl/core/components/ui/image/image.html +0 -298
- package/docs/crawl/core/components/ui/link/link.html +0 -100
- package/docs/crawl/core/components/ui/loader/loader.html +0 -124
- package/docs/crawl/core/components/ui/menu/menu.html +0 -394
- package/docs/crawl/core/components/ui/modal/modal.html +0 -342
- package/docs/crawl/core/components/ui/pop/pop.html +0 -296
- package/docs/crawl/core/components/ui/progress/progress.html +0 -131
- package/docs/crawl/core/components/ui/table/table.html +0 -545
- package/docs/crawl/core/components/ui/theme/theme.html +0 -131
- package/docs/crawl/core/components/ui/toast/toast.html +0 -233
- package/docs/crawl/core/components/ui/tooltip/tooltip.html +0 -140
- package/docs/crawl/docs/_core-concept/dataFlow.html +0 -177
- package/docs/crawl/docs/_core-concept/overview.html +0 -66
- package/docs/crawl/docs/_core-concept/subscriber.html +0 -75
- package/docs/crawl/docs/_decorators/ancestor-attribute.html +0 -117
- package/docs/crawl/docs/_decorators/auto-subscribe.html +0 -202
- package/docs/crawl/docs/_decorators/bind.html +0 -141
- package/docs/crawl/docs/_decorators/get.html +0 -149
- package/docs/crawl/docs/_decorators/handle.html +0 -165
- package/docs/crawl/docs/_decorators/on-assign.html +0 -355
- package/docs/crawl/docs/_decorators/patch.html +0 -78
- package/docs/crawl/docs/_decorators/post.html +0 -139
- package/docs/crawl/docs/_decorators/publish.html +0 -61
- package/docs/crawl/docs/_decorators/put.html +0 -78
- package/docs/crawl/docs/_decorators/subscribe.html +0 -109
- package/docs/crawl/docs/_decorators/wait-for-ancestors.html +0 -137
- package/docs/crawl/docs/_directives/sub.html +0 -93
- package/docs/crawl/docs/_getting-started/ai-agents.html +0 -173
- package/docs/crawl/docs/_getting-started/concorde-manual-install.html +0 -100
- package/docs/crawl/docs/_getting-started/concorde-outside.html +0 -58
- package/docs/crawl/docs/_getting-started/create-a-component.html +0 -111
- package/docs/crawl/docs/_getting-started/my-first-component.html +0 -189
- package/docs/crawl/docs/_getting-started/my-first-subscriber.html +0 -110
- package/docs/crawl/docs/_getting-started/pubsub.html +0 -62
- package/docs/crawl/docs/_getting-started/start.html +0 -76
- package/docs/crawl/docs/_getting-started/theming.html +0 -333
- package/docs/crawl/docs/_misc/api-configuration.html +0 -149
- package/docs/crawl/docs/_misc/dataProviderKey.html +0 -135
- package/docs/crawl/docs/_misc/docs-mock-api.html +0 -158
- package/docs/crawl/docs/_misc/dynamic-path.html +0 -180
- package/docs/crawl/docs/_misc/endpoint.html +0 -50
- package/docs/crawl/docs/_misc/formelement-subscriber-removal.html +0 -138
- package/docs/crawl/docs/_misc/html-integration.html +0 -48
- package/docs/crawl/hubs/decorators.html +0 -547
- package/docs/crawl/hubs/form-components.html +0 -381
- package/docs/crawl/hubs/remote-data.html +0 -452
- package/docs/crawl/index.html +0 -102
- package/docs/llms-full.txt +0 -7008
- package/docs/llms.txt +0 -97
- package/docs/sitemap.xml +0 -240
- package/docs/src/core/components/functional/date/date.md +0 -290
- package/docs/src/core/components/functional/fetch/fetch.md +0 -125
- package/docs/src/core/components/functional/if/if.md +0 -9
- package/docs/src/core/components/functional/jsonata/jsonata.md +0 -56
- package/docs/src/core/components/functional/list/list.md +0 -65
- package/docs/src/core/components/functional/mix/mix.md +0 -41
- package/docs/src/core/components/functional/queue/queue.md +0 -72
- package/docs/src/core/components/functional/router/router.md +0 -94
- package/docs/src/core/components/functional/sdui/default-library.json +0 -108
- package/docs/src/core/components/functional/sdui/example.json +0 -99
- package/docs/src/core/components/functional/sdui/sdui.md +0 -356
- package/docs/src/core/components/functional/states/states.md +0 -87
- package/docs/src/core/components/functional/submit/submit.md +0 -114
- package/docs/src/core/components/functional/subscriber/subscriber.md +0 -91
- package/docs/src/core/components/functional/value/value.md +0 -35
- package/docs/src/core/components/ui/alert/alert.md +0 -196
- package/docs/src/core/components/ui/alert-messages/alert-messages.md +0 -85
- package/docs/src/core/components/ui/badge/badge.md +0 -188
- package/docs/src/core/components/ui/button/button.md +0 -183
- package/docs/src/core/components/ui/captcha/captcha.md +0 -71
- package/docs/src/core/components/ui/card/card.md +0 -215
- package/docs/src/core/components/ui/divider/divider.md +0 -129
- package/docs/src/core/components/ui/form/checkbox/checkbox.md +0 -77
- package/docs/src/core/components/ui/form/fieldset/fieldset.md +0 -205
- package/docs/src/core/components/ui/form/form-actions/form-actions.md +0 -100
- package/docs/src/core/components/ui/form/form-layout/form-layout.md +0 -119
- package/docs/src/core/components/ui/form/input/input.md +0 -142
- package/docs/src/core/components/ui/form/input-autocomplete/input-autocomplete.md +0 -29
- package/docs/src/core/components/ui/form/radio/radio.md +0 -57
- package/docs/src/core/components/ui/form/select/select.md +0 -71
- package/docs/src/core/components/ui/form/switch/switch.md +0 -57
- package/docs/src/core/components/ui/form/textarea/textarea.md +0 -65
- package/docs/src/core/components/ui/group/group.md +0 -75
- package/docs/src/core/components/ui/icon/icon.md +0 -214
- package/docs/src/core/components/ui/icon/icons.json +0 -1
- package/docs/src/core/components/ui/image/image.md +0 -233
- package/docs/src/core/components/ui/link/link.md +0 -81
- package/docs/src/core/components/ui/loader/loader.md +0 -112
- package/docs/src/core/components/ui/menu/menu.md +0 -370
- package/docs/src/core/components/ui/modal/modal.md +0 -235
- package/docs/src/core/components/ui/pop/pop.md +0 -294
- package/docs/src/core/components/ui/progress/progress.md +0 -109
- package/docs/src/core/components/ui/table/table.md +0 -431
- package/docs/src/core/components/ui/theme/theme.md +0 -122
- package/docs/src/core/components/ui/toast/toast.md +0 -216
- package/docs/src/core/components/ui/tooltip/tooltip.md +0 -124
- package/docs/src/docs/_core-concept/dataFlow.md +0 -88
- package/docs/src/docs/_core-concept/overview.md +0 -57
- package/docs/src/docs/_core-concept/subscriber.md +0 -75
- package/docs/src/docs/_decorators/ancestor-attribute.md +0 -128
- package/docs/src/docs/_decorators/auto-subscribe.md +0 -202
- package/docs/src/docs/_decorators/bind.md +0 -167
- package/docs/src/docs/_decorators/get.md +0 -162
- package/docs/src/docs/_decorators/handle.md +0 -175
- package/docs/src/docs/_decorators/on-assign.md +0 -390
- package/docs/src/docs/_decorators/patch.md +0 -70
- package/docs/src/docs/_decorators/post.md +0 -146
- package/docs/src/docs/_decorators/publish.md +0 -55
- package/docs/src/docs/_decorators/put.md +0 -70
- package/docs/src/docs/_decorators/subscribe.md +0 -100
- package/docs/src/docs/_decorators/wait-for-ancestors.md +0 -163
- package/docs/src/docs/_directives/sub.md +0 -91
- package/docs/src/docs/_getting-started/ai-agents.md +0 -76
- package/docs/src/docs/_getting-started/concorde-manual-install.md +0 -133
- package/docs/src/docs/_getting-started/concorde-outside.md +0 -33
- package/docs/src/docs/_getting-started/create-a-component.md +0 -139
- package/docs/src/docs/_getting-started/my-first-component.md +0 -236
- package/docs/src/docs/_getting-started/my-first-subscriber.md +0 -120
- package/docs/src/docs/_getting-started/pubsub.md +0 -37
- package/docs/src/docs/_getting-started/start.md +0 -47
- package/docs/src/docs/_getting-started/theming.md +0 -253
- package/docs/src/docs/_misc/api-configuration.md +0 -81
- package/docs/src/docs/_misc/dataProviderKey.md +0 -168
- package/docs/src/docs/_misc/docs-mock-api.md +0 -63
- package/docs/src/docs/_misc/dynamic-path.md +0 -71
- package/docs/src/docs/_misc/endpoint.md +0 -45
- package/docs/src/docs/_misc/formelement-subscriber-removal.md +0 -115
- package/docs/src/docs/_misc/html-integration.md +0 -15
- package/docs/src/docs/search/docs-search.json +0 -12242
- package/docs/src/tag-list.json +0 -1
- package/docs/src/tsconfig-model.json +0 -23
- package/docs/src/tsconfig.json +0 -1242
- package/src/docs/prism/index.ts +0 -6
- package/src/docs/prism/prism.css +0 -158
- package/src/docs/prism/prism.js +0 -1022
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
# Legacy: My first subscriber component
|
|
2
|
-
|
|
3
|
-
> **New projects:** use [My first component](#docs/_getting-started/my-first-component.md/my-first-component) (`@ancestorAttribute`, `@subscribe` + `DataProviderKey`, `.items` on lists) and [Data flow](#docs/_core-concept/dataFlow.md/dataFlow). This page documents the **Subscriber mixin** used by older apps and core components.
|
|
4
|
-
|
|
5
|
-
Learn how to build a component with the **Subscriber** mixin, styled with Tailwind, filled from a DataProvider via automatic property mapping.
|
|
6
|
-
|
|
7
|
-
## Create a classic lit component
|
|
8
|
-
|
|
9
|
-
<sonic-code language="javascript" >
|
|
10
|
-
<template>
|
|
11
|
-
import { html, LitElement, nothing } from "lit";
|
|
12
|
-
import { customElement, property } from "lit/decorators.js";
|
|
13
|
-
@customElement("docs-user")
|
|
14
|
-
export class user extends LitElement {
|
|
15
|
-
@property({ type: String }) first_name = "";
|
|
16
|
-
@property({ type: String }) last_name = "";
|
|
17
|
-
@property({ type: String }) avatar = "";
|
|
18
|
-
@property({ type: String }) email = "";
|
|
19
|
-
render() {
|
|
20
|
-
return html`
|
|
21
|
-
<img src="${this.avatar}" /> <br>
|
|
22
|
-
${this.first_name} ${this.last_name} <br>
|
|
23
|
-
${this.email}`;
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
</template>
|
|
27
|
-
</sonic-code>
|
|
28
|
-
|
|
29
|
-
### Style with tailwind and ui components
|
|
30
|
-
|
|
31
|
-
<sonic-code language="javascript">
|
|
32
|
-
<template>
|
|
33
|
-
import { css, unsafeCSS } from "lit";
|
|
34
|
-
import tailwindImport from "./css/tailwind.css?inline";
|
|
35
|
-
export const tailwind = css`${unsafeCSS(tailwindImport)}`;
|
|
36
|
-
</template>
|
|
37
|
-
</sonic-code>
|
|
38
|
-
|
|
39
|
-
<sonic-code language="javascript">
|
|
40
|
-
<template>
|
|
41
|
-
import { html, LitElement } from "lit";
|
|
42
|
-
import { customElement, property } from "lit/decorators.js";
|
|
43
|
-
import { tailwind } from "../tailwind";
|
|
44
|
-
import '@supersoniks/concode/ui/image'
|
|
45
|
-
import '@supersoniks/concode/ui/button'
|
|
46
|
-
import '@supersoniks/concode/ui/icon'
|
|
47
|
-
@customElement("docs-user")
|
|
48
|
-
export class user extends LitElement {
|
|
49
|
-
static styles = [tailwind];
|
|
50
|
-
@property({ type: String }) first_name = "";
|
|
51
|
-
@property({ type: String }) last_name = "";
|
|
52
|
-
@property({ type: String }) avatar = "";
|
|
53
|
-
@property({ type: String }) email = "";
|
|
54
|
-
render() {
|
|
55
|
-
return html`<div class="flex items-center gap-3 p-2">
|
|
56
|
-
<sonic-image src=${this.avatar} rounded="md" ratio="1/1" class="w-16"></sonic-image>
|
|
57
|
-
<div>${this.first_name} <span class="font-bold">${this.last_name}</span></div>
|
|
58
|
-
<div class="text-sm text-neutral-400">${this.email}</div>
|
|
59
|
-
</div>`;
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
</template>
|
|
63
|
-
</sonic-code>
|
|
64
|
-
|
|
65
|
-
## Add Subscriber mixin
|
|
66
|
-
|
|
67
|
-
<sonic-code language="javascript">
|
|
68
|
-
<template>
|
|
69
|
-
import Subscriber from "@supersoniks/concorde/core/mixins/Subscriber";
|
|
70
|
-
@customElement("docs-user")
|
|
71
|
-
export class user extends Subscriber(LitElement) {
|
|
72
|
-
// properties auto-filled from DataProvider when names match
|
|
73
|
-
}
|
|
74
|
-
</template>
|
|
75
|
-
</sonic-code>
|
|
76
|
-
|
|
77
|
-
See [Legacy: Subscriber mixin](#docs/_core-concept/subscriber.md/subscriber).
|
|
78
|
-
|
|
79
|
-
## Autofill from a dataProvider
|
|
80
|
-
|
|
81
|
-
<sonic-code >
|
|
82
|
-
<template>
|
|
83
|
-
<docs-demo-sources for="list-users-fetch"></docs-demo-sources>
|
|
84
|
-
<div serviceURL="/docs-mock-api">
|
|
85
|
-
<sonic-fetch
|
|
86
|
-
serviceURL="/docs-mock-api"
|
|
87
|
-
dataProvider="api/users/3"
|
|
88
|
-
key="data">
|
|
89
|
-
<docs-user></docs-user>
|
|
90
|
-
</sonic-fetch>
|
|
91
|
-
</div>
|
|
92
|
-
</template>
|
|
93
|
-
</sonic-code>
|
|
94
|
-
|
|
95
|
-
<sonic-code >
|
|
96
|
-
<template>
|
|
97
|
-
<sonic-fetch
|
|
98
|
-
serviceURL="/docs-mock-api"
|
|
99
|
-
dataProvider="api/users/2"
|
|
100
|
-
key="data"></sonic-fetch>
|
|
101
|
-
<docs-user dataProvider="api/users/2" ></docs-user>
|
|
102
|
-
</template>
|
|
103
|
-
</sonic-code>
|
|
104
|
-
|
|
105
|
-
<sonic-code >
|
|
106
|
-
<template>
|
|
107
|
-
<div class="grid grid-cols-1 gap-4">
|
|
108
|
-
<form formDataProvider="userPreview" class="grid grid-cols-4 gap-3" >
|
|
109
|
-
<sonic-input label="First name" type="text" name="first_name" value="Paul" size="sm"></sonic-input>
|
|
110
|
-
<sonic-input label="Last name" type="text" name="last_name" value="Metrand" size="sm"></sonic-input>
|
|
111
|
-
<sonic-input class="col-span-2" label="email" type="text" name="email" value="paul@example.com" size="sm"></sonic-input>
|
|
112
|
-
<sonic-input label="Image url" type="text" name="avatar" value="https://i.pravatar.cc/150?u=paul" size="sm"></sonic-input>
|
|
113
|
-
</form>
|
|
114
|
-
<sonic-divider align="left">Preview before submit</sonic-divider>
|
|
115
|
-
<div dataProvider="userPreview">
|
|
116
|
-
<docs-user></docs-user>
|
|
117
|
-
</div>
|
|
118
|
-
</div>
|
|
119
|
-
</template>
|
|
120
|
-
</sonic-code>
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
# Legacy: Sharing data
|
|
2
|
-
|
|
3
|
-
> **New apps:** [Data flow](#docs/_core-concept/dataFlow.md/dataFlow) (`get` / `set` / `DataProviderKey`, decorators). This page documents the historical **Publisher** proxy API (`PublisherManager`, `publisher.set`, `onAssign`, …).
|
|
4
|
-
|
|
5
|
-
This section describes how data is shared between graphical and non-graphical components.
|
|
6
|
-
|
|
7
|
-
Graphical components should not reference each other directly — they stay decoupled via a **publish/subscribe** store.
|
|
8
|
-
|
|
9
|
-
## The Publisher
|
|
10
|
-
|
|
11
|
-
### Principle
|
|
12
|
-
|
|
13
|
-
* The **publisher** is a [JavaScript proxy](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) that holds data.<br>
|
|
14
|
-
Example: `{foo:{hello:["world"]}, bar:"baz"}`
|
|
15
|
-
|
|
16
|
-
* Accessing a property (`myPublisher.foo.hello`) returns another **publisher** for that segment.
|
|
17
|
-
|
|
18
|
-
* Missing properties create a publisher with internal data `null`, filled later.
|
|
19
|
-
|
|
20
|
-
* **Subscribers** listen via `onAssign`, `onInternalMutation`, template filling on the **Subscriber mixin**, etc.
|
|
21
|
-
|
|
22
|
-
* Updates use `publisher.set(...)` or nested assignment; changes propagate to subscribers.
|
|
23
|
-
|
|
24
|
-
❇️ Order of creation vs subscription theoretically does not matter.
|
|
25
|
-
|
|
26
|
-
### Methods
|
|
27
|
-
|
|
28
|
-
* **set** — replace internal value
|
|
29
|
-
<sonic-code language="javascript"><template>publisher.set({foo:{hello:["world"]}, bar:"baz"});</template></sonic-code>
|
|
30
|
-
|
|
31
|
-
* **get** — read internal value
|
|
32
|
-
<sonic-code language="javascript"><template>publisher.get()</template></sonic-code>
|
|
33
|
-
|
|
34
|
-
* **onAssign / offAssign** — react to `set`
|
|
35
|
-
<sonic-code language="javascript"><template>publisher.a.b.onAssign(console.log);</template></sonic-code>
|
|
36
|
-
|
|
37
|
-
Modern equivalent: `get` / `set` / `@handle` — see [Data flow](#docs/_core-concept/dataFlow.md/dataFlow).
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
# Introduction
|
|
2
|
-
|
|
3
|
-
## What is Concorde?
|
|
4
|
-
|
|
5
|
-
Based on **[lit.dev](https://lit.dev)**, Concorde is a collection of web components for shared apps and websites.
|
|
6
|
-
Build UIs without tying components to a specific host stack, while keeping visual consistency through the smallest set of CSS variables needed to define a theme.
|
|
7
|
-
|
|
8
|
-
## Why and use case
|
|
9
|
-
|
|
10
|
-
In 2022, Supersoniks needed a new ticketing stack for nearly 100 sites — mobile apps, modern sites, and legacy PHP without bundlers.
|
|
11
|
-
One composable web-component library replaced many one-off apps. Lit was chosen for broad runtime compatibility.
|
|
12
|
-
|
|
13
|
-
### Stack
|
|
14
|
-
|
|
15
|
-
* Lit
|
|
16
|
-
* TypeScript
|
|
17
|
-
* Vite
|
|
18
|
-
* Tailwind (starter kit, not required in the core package)
|
|
19
|
-
|
|
20
|
-
### Functional features
|
|
21
|
-
|
|
22
|
-
* **DataProvider** store (decorators, `get` / `set`)
|
|
23
|
-
* Forms (`formDataProvider`)
|
|
24
|
-
* Lists, queues, lazy loading
|
|
25
|
-
* Router, states, UI kit with status variants
|
|
26
|
-
|
|
27
|
-
## Learn Concorde
|
|
28
|
-
|
|
29
|
-
| Step | Page |
|
|
30
|
-
|------|------|
|
|
31
|
-
| 1 | [My first component](#docs/_getting-started/my-first-component.md/my-first-component) — Lit card, `@ancestorAttribute`, `@bind`, mock API |
|
|
32
|
-
| 2 | [Data flow](#docs/_core-concept/dataFlow.md/dataFlow) — Core concepts: decorators and APIs |
|
|
33
|
-
| 3 | [Local API demos](#docs/_misc/docs-mock-api.md/docs-mock-api) — offline `serviceURL` for this site (Misc) |
|
|
34
|
-
| 4 | [create-concorde-ts-starter](https://www.npmjs.com/package/@supersoniks/create-concorde-ts-starter) — **recommended** project kit (Vite, Tailwind, `yarn ai:sync`) |
|
|
35
|
-
| 5 | [AI agents (skills)](#docs/_getting-started/ai-agents.md/ai-agents) — `AGENTS.md`, Cursor / JetBrains rules |
|
|
36
|
-
|
|
37
|
-
Legacy (Subscriber mixin, Publisher API): **Legacy** section at the bottom of the sidebar.
|
|
38
|
-
|
|
39
|
-
## Start a new project
|
|
40
|
-
|
|
41
|
-
<sonic-code language="bash">
|
|
42
|
-
<template>
|
|
43
|
-
npx @supersoniks/create-concorde-ts-starter "project_name"
|
|
44
|
-
</template>
|
|
45
|
-
</sonic-code>
|
|
46
|
-
|
|
47
|
-
The starter runs **`yarn ai:sync`** for you. Details: [AI agents (skills)](#docs/_getting-started/ai-agents.md/ai-agents). Manual Vite setup: [Legacy: Manual installation](#docs/_getting-started/concorde-manual-install.md/concorde-manual-install).
|
|
@@ -1,253 +0,0 @@
|
|
|
1
|
-
# Customization
|
|
2
|
-
|
|
3
|
-
## Theme-first customization
|
|
4
|
-
|
|
5
|
-
Concorde components ship with **default styles** (fallback values in each component and in `<sonic-theme>`).
|
|
6
|
-
You do not need to define any CSS variables to get a usable UI.
|
|
7
|
-
|
|
8
|
-
To align the kit with your brand, override **only the essential theme tokens** on `<sonic-theme>`, on `:root`, or in a project stylesheet.
|
|
9
|
-
Concorde derives radius steps, button/input rounding, shadows, and most per-component layout from these primitives—**do not copy long lists of derived variables** unless you have a specific need.
|
|
10
|
-
|
|
11
|
-
<sonic-code language="html">
|
|
12
|
-
<template>
|
|
13
|
-
<sonic-theme color font class="block bg-base min-h-screen">
|
|
14
|
-
<!-- your app -->
|
|
15
|
-
</sonic-theme>
|
|
16
|
-
</template>
|
|
17
|
-
</sonic-code>
|
|
18
|
-
|
|
19
|
-
<sonic-code language="javascript">
|
|
20
|
-
<template>
|
|
21
|
-
import "@supersoniks/concorde/theme";
|
|
22
|
-
</template>
|
|
23
|
-
</sonic-code>
|
|
24
|
-
|
|
25
|
-
| Attribute | Effect |
|
|
26
|
-
|-----------|--------|
|
|
27
|
-
| *(omit)* \| `theme="custom"` | Default: core tokens + your `--sc-*`; no built-in light/dark palette |
|
|
28
|
-
| `theme="light"` \| `"dark"` \| `"auto"` | Opt-in presets; `auto` follows `prefers-color-scheme` |
|
|
29
|
-
| `class="bg-base block"` (Tailwind) | Page/surface background (`--sc-base`) |
|
|
30
|
-
| `color` | Text color (`--sc-base-content`) |
|
|
31
|
-
| `font` | Base font family/weight (`--sc-font-family-base`, etc.) |
|
|
32
|
-
|
|
33
|
-
Popovers, modals, and toasts mount under the nearest `<sonic-theme>`.
|
|
34
|
-
|
|
35
|
-
## Customization example
|
|
36
|
-
|
|
37
|
-
Example (full brand override on `<sonic-theme>` or `:root`). Set every essential token below; derived radii and shadows still come from the theme engine—only `--sc-rounded` is listed here.
|
|
38
|
-
|
|
39
|
-
<sonic-code language="css">
|
|
40
|
-
<template>
|
|
41
|
-
sonic-theme {
|
|
42
|
-
/* Semantic fills */
|
|
43
|
-
--sc-primary: #353429;
|
|
44
|
-
--sc-secondary: #f43f5e;
|
|
45
|
-
--sc-info: #7c3aed;
|
|
46
|
-
--sc-danger: #d71839;
|
|
47
|
-
--sc-warning: #f97316;
|
|
48
|
-
--sc-success: #10b981;
|
|
49
|
-
--sc-contrast: #111;
|
|
50
|
-
|
|
51
|
-
/* Text/icons on semantic fills */
|
|
52
|
-
--sc-primary-content: #fff;
|
|
53
|
-
--sc-secondary-content: #fff;
|
|
54
|
-
--sc-info-content: #fff;
|
|
55
|
-
--sc-danger-content: #fff;
|
|
56
|
-
--sc-warning-content: #fff;
|
|
57
|
-
--sc-success-content: #fff;
|
|
58
|
-
--sc-contrast-content: #fff;
|
|
59
|
-
|
|
60
|
-
/* Neutral fills */
|
|
61
|
-
--sc-base: #fff;
|
|
62
|
-
--sc-base-50: #f6f6f5;
|
|
63
|
-
--sc-base-100: #ededec;
|
|
64
|
-
--sc-base-200: #d7d7d4;
|
|
65
|
-
--sc-base-300: #c8c7c4;
|
|
66
|
-
--sc-base-400: #a8a7a2;
|
|
67
|
-
--sc-base-500: #94938c;
|
|
68
|
-
--sc-base-600: #76756c;
|
|
69
|
-
--sc-base-700: #59584e;
|
|
70
|
-
--sc-base-800: #47463b;
|
|
71
|
-
--sc-base-900: #353429;
|
|
72
|
-
|
|
73
|
-
/* Text/icons on neutral surfaces */
|
|
74
|
-
--sc-base-content: var(--sc-base-900);
|
|
75
|
-
|
|
76
|
-
/* Typography */
|
|
77
|
-
--sc-font-family-base: "Oswald", system-ui, -apple-system, "Segoe UI", Roboto,
|
|
78
|
-
"Helvetica Neue", Arial, sans-serif;
|
|
79
|
-
--sc-headings-font-family: "alternate-gothic-compressed", system-ui, sans-serif;
|
|
80
|
-
--sc-headings-line-height: 1.1;
|
|
81
|
-
--sc-headings-font-weight: bold;
|
|
82
|
-
--sc-headings-text-transform: none;
|
|
83
|
-
|
|
84
|
-
/* Shape (primitive only) */
|
|
85
|
-
--sc-rounded: 0;
|
|
86
|
-
|
|
87
|
-
/* Forms */
|
|
88
|
-
--sc-border-width: 0.2rem;
|
|
89
|
-
--sc-form-height: 2em;
|
|
90
|
-
--sc-input-bg: var(--sc-base);
|
|
91
|
-
--sc-input-color: var(--sc-base-content);
|
|
92
|
-
--sc-input-border-color: var(--sc-input-color);
|
|
93
|
-
--sc-input-active-bg: var(--sc-primary);
|
|
94
|
-
--sc-input-active-color: var(--sc-primary-content);
|
|
95
|
-
--sc-input-active-border-color: var(--sc-primary);
|
|
96
|
-
}
|
|
97
|
-
</template>
|
|
98
|
-
</sonic-code>
|
|
99
|
-
|
|
100
|
-
<sonic-button href="https://delanfranchi.github.io/concordecolors/"> Palette generator: concordecolors</sonic-button>
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
**Without these overrides**, components keep Concorde’s per-component fallbacks. Built-in light/dark palettes apply only when you set `theme="light"`, `theme="dark"`, or `theme="auto"`.
|
|
104
|
-
|
|
105
|
-
**What we intentionally avoid:** large public `--sc-alert-*` / `--sc-badge-*` APIs or `::part()` styling hooks on most components. Prefer attributes (`type`, `status`, `size`, …) and the theme tokens above.
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
## Only essential CSS variables (public theme API)
|
|
109
|
-
|
|
110
|
-
These are the **smallest set** we recommend customizing. Everything else should stay internal to the theme or to components (`--sc_*` private variables, attributes like `type`, `size`, `variant`).
|
|
111
|
-
|
|
112
|
-
### Surfaces and foreground
|
|
113
|
-
|
|
114
|
-
Tokens **without** a `-content` suffix are **fill / background** colors.
|
|
115
|
-
Tokens **with** `-content` are **text and icons** on top of the matching fill (solid buttons, badges, alerts, etc.).
|
|
116
|
-
|
|
117
|
-
#### Neutral fills
|
|
118
|
-
|
|
119
|
-
| Variable | Role |
|
|
120
|
-
|----------|------|
|
|
121
|
-
| `--sc-base` | Main surface / page background |
|
|
122
|
-
| `--sc-base-50` … `--sc-base-900` | Neutral scale (borders, subtle backgrounds, muted UI) |
|
|
123
|
-
|
|
124
|
-
#### Neutral foreground
|
|
125
|
-
|
|
126
|
-
| Variable | Role |
|
|
127
|
-
|----------|------|
|
|
128
|
-
| `--sc-base-content` | Default body text and icons on neutral surfaces |
|
|
129
|
-
|
|
130
|
-
#### Semantic fills
|
|
131
|
-
|
|
132
|
-
| Variable | Role |
|
|
133
|
-
|----------|------|
|
|
134
|
-
| `--sc-primary` | Primary actions, links, emphasis |
|
|
135
|
-
| `--sc-secondary` | Secondary brand accent (when used) |
|
|
136
|
-
| `--sc-info`, `--sc-success`, `--sc-warning`, `--sc-danger` | Status and feedback |
|
|
137
|
-
| `--sc-contrast` | High-contrast fills (e.g. on media) |
|
|
138
|
-
|
|
139
|
-
#### Semantic foreground
|
|
140
|
-
|
|
141
|
-
| Variable | Role |
|
|
142
|
-
|----------|------|
|
|
143
|
-
| `--sc-primary-content`, `--sc-secondary-content`, … | Text/icons on the matching semantic **fill** (`--sc-primary`, etc.) |
|
|
144
|
-
|
|
145
|
-
### Shape
|
|
146
|
-
|
|
147
|
-
| Variable | Role |
|
|
148
|
-
|----------|------|
|
|
149
|
-
| `--sc-rounded` | **Single primitive** corner radius; the theme computes `--sc-rounded-sm`, `--sc-btn-rounded`, `--sc-input-rounded`, etc. |
|
|
150
|
-
|
|
151
|
-
### Typography
|
|
152
|
-
|
|
153
|
-
| Variable | Role |
|
|
154
|
-
|----------|------|
|
|
155
|
-
| `--sc-font-family-base` | Body UI text |
|
|
156
|
-
| `--sc-font-weight-base`, `--sc-font-style-base` | Optional |
|
|
157
|
-
| `--sc-headings-font-family`, `--sc-headings-line-height`, `--sc-headings-font-weight`, `--sc-headings-text-transform` | Headings (modal titles, etc.) |
|
|
158
|
-
|
|
159
|
-
### Forms (only if you customize inputs globally)
|
|
160
|
-
|
|
161
|
-
Interactive controls expose a few extra **theme-level** tokens; prefer these over styling individual inputs from outside.
|
|
162
|
-
|
|
163
|
-
| Variable | Role |
|
|
164
|
-
|----------|------|
|
|
165
|
-
| `--sc-border-width` | Default border thickness |
|
|
166
|
-
| `--sc-form-height` | Control height |
|
|
167
|
-
| `--sc-input-bg`, `--sc-input-color`, `--sc-input-border-color` | Default field chrome |
|
|
168
|
-
| `--sc-input-active-bg`, `--sc-input-active-color`, `--sc-input-active-border-color` | Focus/active state |
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
## Tailwind in new components ?
|
|
173
|
-
|
|
174
|
-
Set <code>tailwind.config.js</code> to match concorde style token in your custom component.
|
|
175
|
-
|
|
176
|
-
<sonic-code language="js">
|
|
177
|
-
<template>
|
|
178
|
-
...
|
|
179
|
-
theme: {
|
|
180
|
-
borderRadius: {
|
|
181
|
-
DEFAULT: "var(--sc-rounded)",
|
|
182
|
-
none: "0",
|
|
183
|
-
sm: "var(--sc-rounded-sm)",
|
|
184
|
-
md: "var(--sc-rounded-md)",
|
|
185
|
-
lg: "var(--sc-rounded-lg)",
|
|
186
|
-
xl: "var(--sc-rounded-xl)",
|
|
187
|
-
full: "9999px",
|
|
188
|
-
},
|
|
189
|
-
boxShadow: {
|
|
190
|
-
DEFAULT: "var(--sc-shadow)",
|
|
191
|
-
none: "none",
|
|
192
|
-
sm: "var(--sc-shadow-sm)",
|
|
193
|
-
md: "var(--sc-shadow-md)",
|
|
194
|
-
lg: "var(--sc-shadow-lg)",
|
|
195
|
-
xl: "var(--sc-shadow-xl)",
|
|
196
|
-
},
|
|
197
|
-
colors: {
|
|
198
|
-
transparent: "transparent",
|
|
199
|
-
current: "currentColor",
|
|
200
|
-
content: "var(--sc-base-content)",
|
|
201
|
-
base: "var(--sc-base)",
|
|
202
|
-
neutral: {
|
|
203
|
-
0: "var(--sc-base)",
|
|
204
|
-
50: "var(--sc-base-50)",
|
|
205
|
-
100: "var(--sc-base-100)",
|
|
206
|
-
200: "var(--sc-base-200)",
|
|
207
|
-
300: "var(--sc-base-300)",
|
|
208
|
-
400: "var(--sc-base-400)",
|
|
209
|
-
500: "var(--sc-base-500)",
|
|
210
|
-
600: "var(--sc-base-600)",
|
|
211
|
-
700: "var(--sc-base-700)",
|
|
212
|
-
800: "var(--sc-base-800)",
|
|
213
|
-
900: "var(--sc-base-900)",
|
|
214
|
-
content: "var(--sc-base)",
|
|
215
|
-
},
|
|
216
|
-
primary: {
|
|
217
|
-
DEFAULT: "var(--sc-primary)",
|
|
218
|
-
content: "var(--sc-primary-content)",
|
|
219
|
-
},
|
|
220
|
-
success: {
|
|
221
|
-
DEFAULT: "var(--sc-success)",
|
|
222
|
-
content: "var(--sc-success-content)",
|
|
223
|
-
},
|
|
224
|
-
danger: {
|
|
225
|
-
DEFAULT: "var(--sc-danger)",
|
|
226
|
-
content: "var(--sc-danger-content)",
|
|
227
|
-
},
|
|
228
|
-
warning: {
|
|
229
|
-
DEFAULT: "var(--sc-warning)",
|
|
230
|
-
content: "var(--sc-warning-content)",
|
|
231
|
-
},
|
|
232
|
-
info: {
|
|
233
|
-
DEFAULT: "var(--sc-info)",
|
|
234
|
-
content: "var(--sc-info-content)",
|
|
235
|
-
},
|
|
236
|
-
contrast: {
|
|
237
|
-
DEFAULT: "var(--sc-contrast)",
|
|
238
|
-
content: "var(--sc-contrast-content)",
|
|
239
|
-
},
|
|
240
|
-
},
|
|
241
|
-
extend: {
|
|
242
|
-
borderWidth: {
|
|
243
|
-
DEFAULT: "var(--sc-border-width)",
|
|
244
|
-
},
|
|
245
|
-
fontFamily: {
|
|
246
|
-
headings: ["var(--sc-headings-font-family, var(--sc-font-family-base, sans-serif))"],
|
|
247
|
-
body: ["var(--sc-font-family-base)"],
|
|
248
|
-
monospace: ["var(--sc-font-family-monospace, monospace)"],
|
|
249
|
-
}
|
|
250
|
-
}
|
|
251
|
-
</template>
|
|
252
|
-
</sonic-code>
|
|
253
|
-
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# API configuration
|
|
2
|
-
|
|
3
|
-
`APIConfiguration` is the object built by [`HTML.getApiConfiguration`](../../core/utils/HTML.ts) from **ancestor attributes** on the DOM (or from a typed publisher — see [@get](#docs/_decorators/get.md/get) / [@post](#docs/_decorators/post.md/post) configuration key). It is passed to [`API`](../../core/utils/api.ts) by fetchers, **sonic-submit**, the **`wording()`** directive, **`@get`**, **`@post`**, **`@put`**, and **`@patch`**.
|
|
4
|
-
|
|
5
|
-
> **Mock service:** same [Local API demos](#docs/_misc/docs-mock-api.md/docs-mock-api) Service Worker / Vite middleware. Routes used on this page are listed in the [API config routes](#api-config-routes) section below.
|
|
6
|
-
|
|
7
|
-
## Attribute map
|
|
8
|
-
|
|
9
|
-
| Attribute (ancestor) | `APIConfiguration` field | Role |
|
|
10
|
-
|---------------------|---------------------------|------|
|
|
11
|
-
| `serviceURL` | `serviceURL` | Base URL (e.g. `/docs-mock-api`) |
|
|
12
|
-
| `token` | `token` | Static Bearer sent on REST calls |
|
|
13
|
-
| `userName` / `password` | `userName` / `password` | Basic auth for **tokenProvider** fetch only |
|
|
14
|
-
| `eventsApiToken` | `authToken` | Bearer for **tokenProvider** when no Basic |
|
|
15
|
-
| `tokenProvider` | `tokenProvider` | Path to GET a new token (`{ token }` JSON) |
|
|
16
|
-
| `wordingProvider` | — (read by `wording()`) | Base path + query for label batch GET |
|
|
17
|
-
| `wordingVersionProvider` | — | Publisher id; bump version → reload wordings |
|
|
18
|
-
| `credentials` | `credentials` | `fetch` credentials mode |
|
|
19
|
-
| `addHTTPResponse` | `addHTTPResponse` | Attach `_sonic_http_response_` on result |
|
|
20
|
-
| `cache` | `cache` | `fetch` cache mode |
|
|
21
|
-
| `blockUntilDone` | `blockUntilDone` | Serialize calls per `serviceURL` |
|
|
22
|
-
| `keepAlive` | `keepAlive` | `fetch` keepalive |
|
|
23
|
-
|
|
24
|
-
**Lit / TypeScript:** store the same shape in a publisher and pass `DataProviderKey<APIConfiguration>` as the second argument of `@get` (see [DataProviderKey](#docs/_misc/dataProviderKey.md/dataProviderKey)).
|
|
25
|
-
|
|
26
|
-
## Bearer token (static)
|
|
27
|
-
|
|
28
|
-
Publisher `docsApiConfBearerKey` (`set(docsApiConfBearerKey, { token: "docs-mock-valid-token", … })`) — mock returns the protected payload.
|
|
29
|
-
|
|
30
|
-
<docs-lit-demo for="docs-api-config-bearer-demo"></docs-lit-demo>
|
|
31
|
-
|
|
32
|
-
## tokenProvider + Basic auth
|
|
33
|
-
|
|
34
|
-
No static `token`: `API.auth()` calls `GET /docs-mock-api/auth/token` with Basic **demo** / **secret**, stores `token`, then calls the protected route.
|
|
35
|
-
|
|
36
|
-
<docs-lit-demo for="docs-api-config-token-provider-demo"></docs-lit-demo>
|
|
37
|
-
|
|
38
|
-
## HTTP 498 — stale token refresh
|
|
39
|
-
|
|
40
|
-
Initial `token="docs-mock-stale-token"` → mock responds **498** → Concorde invalidates the token, runs `auth()` again (same `tokenProvider` + Basic), retries with `docs-mock-fresh-token`.
|
|
41
|
-
|
|
42
|
-
<docs-lit-demo for="docs-api-config-stale-token-demo"></docs-lit-demo>
|
|
43
|
-
|
|
44
|
-
## eventsApiToken
|
|
45
|
-
|
|
46
|
-
Attribute **`eventsApiToken`** on an ancestor maps to **`authToken`** in config (used as Bearer when calling `tokenProvider`, instead of Basic).
|
|
47
|
-
|
|
48
|
-
<docs-lit-demo for="docs-api-config-events-token-demo"></docs-lit-demo>
|
|
49
|
-
|
|
50
|
-
## Wording API
|
|
51
|
-
|
|
52
|
-
`wordingProvider="wording/labels?lang=fr"` + `wording('api-config.greeting')` in Lit. Mock returns label map from `labels[]` query params.
|
|
53
|
-
|
|
54
|
-
<docs-lit-demo for="docs-api-config-wording-demo"></docs-lit-demo>
|
|
55
|
-
|
|
56
|
-
## Scoped attributes (HTML / sonic-scope)
|
|
57
|
-
|
|
58
|
-
Attributes on **`sonic-scope`** (or any ancestor) are visible to descendants via `getAncestorAttributeValue`.
|
|
59
|
-
|
|
60
|
-
<docs-lit-demo for="docs-api-config-scoped-attrs-demo"></docs-lit-demo>
|
|
61
|
-
|
|
62
|
-
## API config routes
|
|
63
|
-
|
|
64
|
-
| Route | Demo |
|
|
65
|
-
|-------|------|
|
|
66
|
-
| `GET /docs-mock-api/auth/token` | tokenProvider, eventsApiToken |
|
|
67
|
-
| `GET /docs-mock-api/api/config/protected` | Bearer / Basic / 498 |
|
|
68
|
-
| `GET /docs-mock-api/wording/labels?labels[]=…&lang=fr` | `wording()` |
|
|
69
|
-
|
|
70
|
-
Mock tokens (doc only): `docs-mock-valid-token`, `docs-mock-stale-token` (498), `docs-mock-fresh-token` (after refresh). Basic: **demo** / **secret**. Events token: `docs-mock-events-token`.
|
|
71
|
-
|
|
72
|
-
Implementation: `src/docs/mock-api/api-config-mock.ts` (bundled in the Service Worker with `router.ts`).
|
|
73
|
-
|
|
74
|
-
## See also
|
|
75
|
-
|
|
76
|
-
- [@get](#docs/_decorators/get.md/get) — `APIConfiguration` + `Endpoint`
|
|
77
|
-
- [@post](#docs/_decorators/post.md/post) — same configuration model for POST
|
|
78
|
-
- [@put](#docs/_decorators/put.md/put) · [@patch](#docs/_decorators/patch.md/patch) — PUT / PATCH
|
|
79
|
-
- [Endpoint](#docs/_misc/endpoint.md/endpoint) — typed path
|
|
80
|
-
- [Local API demos](#docs/_misc/docs-mock-api.md/docs-mock-api) — offline `serviceURL`
|
|
81
|
-
- [Fetch](#core/components/functional/fetch/fetch.md/fetch) — attribute table (legacy sonic-fetch)
|