From abc78c9e5794d568364a4808a2237a774e639c82 Mon Sep 17 00:00:00 2001 From: John Jenkins Date: Fri, 29 May 2026 01:11:29 +0100 Subject: [PATCH 1/3] feat(readme): v5 - multi component readmes --- .../core/src/compiler/docs/readme/index.ts | 22 +- .../src/compiler/docs/readme/output-docs.ts | 175 ++++++++++++--- .../e2e/custom-elements-manifest.json | 2 +- .../e2e/src/deep-selector/readme.md | 43 +++- .../e2e/src/hydrate-props/readme.md | 32 ++- .../src/ssr-declarative-shadow-dom/readme.md | 205 +++++++++++++++++- .../e2e/src/ssr-hydration/readme.md | 156 ++++++++++++- .../e2e/src/ssr-scoped-hydration/readme.md | 32 +++ .../build-benchmark/benchmark-results.json | 202 +++++++++++++---- .../perf/build-benchmark/benchmark-results.md | 28 +-- test/runtime/src/components.d.ts | 26 --- .../attributes/attribute-basic/readme.md | 31 ++- .../attributes/attribute-boolean/readme.md | 17 +- .../attributes/prefix-attr/readme.md | 32 ++- .../attributes/prefix-prop/readme.md | 31 ++- .../readme.md | 28 ++- .../reflect-single-render/readme.md | 28 ++- .../components/build/tag-transform/readme.md | 43 +++- .../src/components/dom/clone-node/readme.md | 39 +++- .../components/events/listen-jsx/readme.md | 21 +- .../forms/form-associated/readme.md | 5 +- .../forms/radio-group-blur/readme.md | 116 +++++++++- .../inheritance/extends-cmp/readme.md | 77 ++++++- .../extends-composition-scaling/readme.md | 76 ++++++- .../extends-inheritance-scaling/readme.md | 76 ++++++- .../lifecycle/child-load-failure/readme.md | 21 +- .../lifecycle/lifecycle-async/readme.md | 62 +++++- .../lifecycle/lifecycle-basic/readme.md | 62 +++++- .../lifecycle/lifecycle-unload/readme.md | 42 +++- .../lifecycle/lifecycle-update/readme.md | 52 ++++- .../misc/parent-child-props/readme.md | 38 +++- .../rendering/conditional-rerender/readme.md | 21 +- .../components/scoped/scoped-basic/readme.md | 21 +- .../scoped-id-in-nested-classname/readme.md | 43 +++- .../shadow-dom/shadow-dom-array/readme.md | 28 ++- .../shadow-dom/shadow-dom-basic/readme.md | 21 +- .../shadow-dom-slot-nested/readme.md | 28 ++- .../slots/manual-slot-assignment/readme.md | 34 ++- .../scoped-slot-connectedcallback/readme.md | 42 +++- .../slots/scoped-slot-in-slot/readme.md | 38 +++- .../slots/scoped-slot-slotchange/readme.md | 30 ++- .../slots/slot-array-complex/readme.md | 21 +- .../slots/slot-basic-order/readme.md | 21 +- .../src/components/slots/slot-basic/readme.md | 21 +- .../slots/slot-dynamic-name-change/readme.md | 15 +- .../slots/slot-dynamic-wrapper/readme.md | 28 ++- .../readme.md | 30 ++- .../slot-fallback-with-textnode/readme.md | 21 +- .../components/slots/slot-fallback/readme.md | 28 ++- .../slots/slot-hide-content/readme.md | 15 +- .../components/slots/slot-light-dom/readme.md | 21 +- .../components/slots/slot-map-order/readme.md | 21 +- .../slots/slot-nested-default-order/readme.md | 28 ++- .../slots/slot-nested-dynamic/readme.md | 43 +++- .../slots/slot-nested-order/readme.md | 21 +- .../slots/slot-parent-tag-change/readme.md | 30 ++- .../components/slots/slot-reorder/readme.md | 28 ++- .../slots/slot-replace-wrapper/readme.md | 28 ++- .../slots/slot-scoped-list/readme.md | 51 ++++- .../slots/slot-shadow-list/readme.md | 51 ++++- .../readme.md | 17 +- 61 files changed, 2471 insertions(+), 194 deletions(-) diff --git a/packages/core/src/compiler/docs/readme/index.ts b/packages/core/src/compiler/docs/readme/index.ts index dc59b834174..2f562d3f338 100644 --- a/packages/core/src/compiler/docs/readme/index.ts +++ b/packages/core/src/compiler/docs/readme/index.ts @@ -1,7 +1,7 @@ import type * as d from '@stencil/core'; import { isOutputTargetDocsReadme } from '../../../utils'; -import { generateReadme } from './output-docs'; +import { generateMergedReadme, generateReadme } from './output-docs'; export const generateReadmeDocs = async ( config: d.ValidatedConfig, @@ -18,10 +18,24 @@ export const generateReadmeDocs = async ( strictCheckDocs(config, docsData); } + // Group components by their readme path — multiple components in the same + // directory share a single readme.md and must be merged into one document. + const byReadmePath = new Map(); + for (const cmpData of docsData.components) { + const group = byReadmePath.get(cmpData.readmePath); + if (group) { + group.push(cmpData); + } else { + byReadmePath.set(cmpData.readmePath, [cmpData]); + } + } + await Promise.all( - docsData.components.map((cmpData) => { - return generateReadme(config, compilerCtx, readmeOutputTargets, cmpData, docsData.components); - }), + Array.from(byReadmePath.values()).map((group) => + group.length === 1 + ? generateReadme(config, compilerCtx, readmeOutputTargets, group[0], docsData.components) + : generateMergedReadme(config, compilerCtx, readmeOutputTargets, group, docsData.components), + ), ); }; diff --git a/packages/core/src/compiler/docs/readme/output-docs.ts b/packages/core/src/compiler/docs/readme/output-docs.ts index d20e949d9ef..51239e5ae07 100644 --- a/packages/core/src/compiler/docs/readme/output-docs.ts +++ b/packages/core/src/compiler/docs/readme/output-docs.ts @@ -47,41 +47,78 @@ export const generateReadme = async ( const relativeReadmePath = relative(config.srcDir, docsData.readmePath); const readmeOutputPath = join(readmeOutput.dir, relativeReadmePath); - const currentReadmeContent = - readmeOutput.overwriteExisting === true - ? // Overwrite explicitly requested: always use the provided user content. - userContent - : normalizePath(readmeOutput.dir) !== normalizePath(config.srcDir) - ? (readmeOutput.overwriteExisting === 'if-missing' && - // Validate a file exists at the output path - (await compilerCtx.fs.access(readmeOutputPath))) || - // False and undefined case: follow the changes made in #5648 - (readmeOutput.overwriteExisting ?? false) === false - ? // Existing file found: The user set a custom `.dir` property, which is - // where we're going to write the updated README. We need to read the - // non-automatically generated content from that file and preserve that. - await getUserReadmeContent(compilerCtx, readmeOutputPath) - : // No existing file found: use the provided user content. - userContent - : // Default case: writing to srcDir, so use the provided user content. - userContent; + const currentReadmeContent = await resolveUserContent( + compilerCtx, + readmeOutput, + readmeOutputPath, + config, + userContent, + ); // CSS Custom Properties preservation is now handled centrally in outputDocs - const readmeContent = generateMarkdown( - currentReadmeContent, - docsData, - cmps, + const readmeContent = generateMarkdown(currentReadmeContent, docsData, cmps, readmeOutput, config); + + const existingContent = await compilerCtx.fs.readFile(readmeOutputPath); + if (existingContent?.replace(/\r/g, '') === readmeContent.replace(/\r/g, '')) { + return; + } + + await compilerCtx.fs.writeFile(readmeOutputPath, readmeContent); + if (isUpdate) { + config.logger.info(`updated readme docs: ${docsData.tag}`); + } else { + config.logger.info(`created readme docs: ${docsData.tag}`); + } + } + }), + ); +}; + +/** + * Generate a single README for multiple components that share a directory and + * therefore share a single readme.md file. + * + * Each component gets an `## \`tag\`` section; existing section headings are + * shifted from h2 to h3 so they nest correctly under that heading. + */ +export const generateMergedReadme = async ( + config: d.ValidatedConfig, + compilerCtx: d.CompilerCtx, + readmeOutputs: d.OutputTargetDocsReadme[], + cmps: d.JsonDocsComponent[], + allCmps: d.JsonDocsComponent[], +) => { + const primaryCmp = cmps[0]; + const isUpdate = !!primaryCmp.readme; + const userContent = isUpdate ? primaryCmp.readme : getDefaultReadme(primaryCmp); + + await Promise.all( + readmeOutputs.map(async (readmeOutput) => { + if (readmeOutput.dir) { + const relativeReadmePath = relative(config.srcDir, primaryCmp.readmePath); + const readmeOutputPath = join(readmeOutput.dir, relativeReadmePath); + + const currentReadmeContent = await resolveUserContent( + compilerCtx, readmeOutput, + readmeOutputPath, config, + userContent, ); - const results = await compilerCtx.fs.writeFile(readmeOutputPath, readmeContent); - if (results.changedContent) { - if (isUpdate) { - config.logger.info(`updated readme docs: ${docsData.tag}`); - } else { - config.logger.info(`created readme docs: ${docsData.tag}`); - } + const readmeContent = generateMergedMarkdown(currentReadmeContent, cmps, allCmps, readmeOutput, config); + + const existingContent = await compilerCtx.fs.readFile(readmeOutputPath); + if (existingContent?.replace(/\r/g, '') === readmeContent.replace(/\r/g, '')) { + return; + } + + await compilerCtx.fs.writeFile(readmeOutputPath, readmeContent); + const tags = cmps.map((c) => c.tag).join(', '); + if (isUpdate) { + config.logger.info(`updated readme docs: ${tags}`); + } else { + config.logger.info(`created readme docs: ${tags}`); } } }), @@ -95,14 +132,58 @@ export const generateMarkdown = ( readmeOutput: d.OutputTargetDocsReadme, config?: d.ValidatedConfig, ) => { - //If the readmeOutput.dependencies is true or undefined the dependencies will be generated. - const dependencies = readmeOutput.dependencies !== false ? depsToMarkdown(cmp, cmps, config) : []; + return [ + userContent || '', + AUTO_GENERATE_COMMENT, + '', + '', + ...generateComponentBody(cmp, cmps, readmeOutput, config), + `----------------------------------------------`, + '', + readmeOutput.footer, + '', + ].join('\n'); +}; + +export const generateMergedMarkdown = ( + userContent: string | undefined, + cmps: d.JsonDocsComponent[], + allCmps: d.JsonDocsComponent[], + readmeOutput: d.OutputTargetDocsReadme, + config?: d.ValidatedConfig, +): string => { + const sections: string[] = []; + + for (const cmp of cmps) { + const body = generateComponentBody(cmp, allCmps, readmeOutput, config); + if (body.length === 0) continue; + // Shift h2 section headings to h3 so they nest under the component's h2 + const shiftedBody = body.map((line) => line.replace(/^## /, '### ')); + sections.push(`## \`${cmp.tag}\``, '', ...shiftedBody, ''); + } return [ userContent || '', AUTO_GENERATE_COMMENT, '', '', + ...sections, + `----------------------------------------------`, + '', + readmeOutput.footer, + '', + ].join('\n'); +}; + +/** Returns the auto-generated lines for a single component (no header/footer). */ +const generateComponentBody = ( + cmp: d.JsonDocsComponent, + cmps: d.JsonDocsComponent[], + readmeOutput: d.OutputTargetDocsReadme, + config?: d.ValidatedConfig, +): string[] => { + const dependencies = readmeOutput.dependencies !== false ? depsToMarkdown(cmp, cmps, config) : []; + return [ ...getDocsDeprecation(cmp), ...overviewToMarkdown(cmp.overview), ...usageToMarkdown(cmp.usage), @@ -114,11 +195,33 @@ export const generateMarkdown = ( ...customStatesToMarkdown(cmp.customStates), ...stylesToMarkdown(cmp.styles), ...dependencies, - `----------------------------------------------`, - '', - readmeOutput.footer, - '', - ].join('\n'); + ]; +}; + +/** + * Resolves the user-written content (above AUTO_GENERATE_COMMENT) to use when + * generating a readme, respecting the `overwriteExisting` option and whether + * the output dir differs from the source dir. + */ +const resolveUserContent = async ( + compilerCtx: d.CompilerCtx, + readmeOutput: d.OutputTargetDocsReadme, + readmeOutputPath: string, + config: d.ValidatedConfig, + userContent: string | undefined, +): Promise => { + if (readmeOutput.overwriteExisting === true) { + return userContent; + } + if (normalizePath(readmeOutput.dir) !== normalizePath(config.srcDir)) { + if ( + (readmeOutput.overwriteExisting === 'if-missing' && (await compilerCtx.fs.access(readmeOutputPath))) || + (readmeOutput.overwriteExisting ?? false) === false + ) { + return getUserReadmeContent(compilerCtx, readmeOutputPath); + } + } + return userContent; }; const getDocsDeprecation = (cmp: d.JsonDocsComponent) => { diff --git a/test/integration/e2e/custom-elements-manifest.json b/test/integration/e2e/custom-elements-manifest.json index 5ea27566ce7..d3aa2315521 100644 --- a/test/integration/e2e/custom-elements-manifest.json +++ b/test/integration/e2e/custom-elements-manifest.json @@ -2849,4 +2849,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/test/integration/e2e/src/deep-selector/readme.md b/test/integration/e2e/src/deep-selector/readme.md index 208d9ae8e50..70a6d570046 100644 --- a/test/integration/e2e/src/deep-selector/readme.md +++ b/test/integration/e2e/src/deep-selector/readme.md @@ -5,7 +5,47 @@ -## Dependencies +## `cmp-a` + +### Dependencies + +### Depends on + +- [cmp-b](.) + +### Graph +```mermaid +graph TD; + cmp-a --> cmp-b + cmp-b --> cmp-c + style cmp-a fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `cmp-b` + +### Dependencies + +### Used by + + - [cmp-a](.) + +### Depends on + +- [cmp-c](.) + +### Graph +```mermaid +graph TD; + cmp-b --> cmp-c + cmp-a --> cmp-b + style cmp-b fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `cmp-c` + +### Dependencies ### Used by @@ -18,6 +58,7 @@ graph TD; style cmp-c fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/integration/e2e/src/hydrate-props/readme.md b/test/integration/e2e/src/hydrate-props/readme.md index e011b48c961..500f473463e 100644 --- a/test/integration/e2e/src/hydrate-props/readme.md +++ b/test/integration/e2e/src/hydrate-props/readme.md @@ -5,7 +5,9 @@ -## Properties +## `my-cmp` + +### Properties | Property | Attribute | Description | Type | Default | | --------- | ---------- | ----------- | -------- | ----------- | @@ -14,7 +16,32 @@ | `mode` | `mode` | Mode | `any` | `undefined` | -## Dependencies +### Dependencies + +### Depends on + +- [my-jsx-cmp](.) + +### Graph +```mermaid +graph TD; + my-cmp --> my-jsx-cmp + style my-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `my-jsx-cmp` + +### Properties + +| Property | Attribute | Description | Type | Default | +| --------- | ---------- | ----------- | -------- | ----------- | +| `barProp` | `bar-prop` | bar prop | `string` | `'bar'` | +| `fooProp` | `foo-prop` | foo prop | `string` | `undefined` | +| `mode` | `mode` | Mode | `any` | `undefined` | + + +### Dependencies ### Used by @@ -27,6 +54,7 @@ graph TD; style my-jsx-cmp fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/integration/e2e/src/ssr-declarative-shadow-dom/readme.md b/test/integration/e2e/src/ssr-declarative-shadow-dom/readme.md index 8cae43647a2..1bc4bb61033 100644 --- a/test/integration/e2e/src/ssr-declarative-shadow-dom/readme.md +++ b/test/integration/e2e/src/ssr-declarative-shadow-dom/readme.md @@ -5,14 +5,214 @@ -## Properties +## `another-car-detail` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------- | ----------- | +| `car` | `car` | | `CarData` | `undefined` | + + +### Dependencies + +### Used by + + - [another-car-list](.) + - [scoped-car-list](.) + +### Graph +```mermaid +graph TD; + another-car-list --> another-car-detail + scoped-car-list --> another-car-detail + style another-car-detail fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `another-car-list` + +### Overview + +Component that helps display a list of cars + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------- | --------- | ----------- | ----------- | ----------- | +| `cars` | `cars` | | `CarData[]` | `undefined` | +| `selected` | -- | | `CarData` | `undefined` | + + +### Events + +| Event | Description | Type | +| ------------- | ----------- | ---------------------- | +| `carSelected` | | `CustomEvent` | + + +### Slots + +| Slot | Description | +| ---------- | -------------------------------- | +| `"header"` | The slot for the header content. | + + +### Shadow Parts + +| Part | Description | +| ------- | ------------------------------------------- | +| `"car"` | The shadow part to target to style the car. | + + +### Dependencies + +### Depends on + +- [another-car-detail](.) + +### Graph +```mermaid +graph TD; + another-car-list --> another-car-detail + style another-car-list fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `cmp-dsd` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------------- | ----------------- | ----------- | -------- | ------- | +| `initialCounter` | `initial-counter` | | `number` | `0` | + + + +## `nested-cmp-parent` + +### Dependencies + +### Depends on + +- [nested-scope-cmp](.) + +### Graph +```mermaid +graph TD; + nested-cmp-parent --> nested-scope-cmp + style nested-cmp-parent fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `nested-scope-cmp` + +### Dependencies + +### Used by + + - [nested-cmp-parent](.) + +### Graph +```mermaid +graph TD; + nested-cmp-parent --> nested-scope-cmp + style nested-scope-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-car-detail` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------- | ----------- | +| `car` | `car` | | `CarData` | `undefined` | + + + +## `scoped-car-list` + +### Overview + +Component that helps display a list of cars + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------- | --------- | ----------- | ----------- | ----------- | +| `cars` | `cars` | | `CarData[]` | `undefined` | +| `selected` | -- | | `CarData` | `undefined` | + + +### Events + +| Event | Description | Type | +| ------------- | ----------- | ---------------------- | +| `carSelected` | | `CustomEvent` | + + +### Slots + +| Slot | Description | +| ---------- | -------------------------------- | +| `"header"` | The slot for the header content. | + + +### Shadow Parts + +| Part | Description | +| ------- | ------------------------------------------- | +| `"car"` | The shadow part to target to style the car. | + + +### Dependencies + +### Depends on + +- [another-car-detail](.) + +### Graph +```mermaid +graph TD; + scoped-car-list --> another-car-detail + style scoped-car-list fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `ssr-shadow-cmp` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------- | ---------- | ----------- | --------- | ----------- | +| `selected` | `selected` | | `boolean` | `undefined` | + + +### Dependencies + +### Used by + + - [wrap-ssr-shadow-cmp](.) + +### Graph +```mermaid +graph TD; + wrap-ssr-shadow-cmp --> ssr-shadow-cmp + style ssr-shadow-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `wrap-ssr-shadow-cmp` + +### Properties | Property | Attribute | Description | Type | Default | | ---------- | ---------- | ----------- | --------- | ----------- | | `selected` | `selected` | | `boolean` | `undefined` | -## Dependencies +### Dependencies ### Depends on @@ -25,6 +225,7 @@ graph TD; style wrap-ssr-shadow-cmp fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/integration/e2e/src/ssr-hydration/readme.md b/test/integration/e2e/src/ssr-hydration/readme.md index 65573069a3d..5682126a589 100644 --- a/test/integration/e2e/src/ssr-hydration/readme.md +++ b/test/integration/e2e/src/ssr-hydration/readme.md @@ -5,7 +5,160 @@ -## Dependencies +## `part-ssr-shadow-cmp` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------- | ---------- | ----------- | --------- | ----------- | +| `selected` | `selected` | | `boolean` | `undefined` | + + +### Shadow Parts + +| Part | Description | +| ------------- | ----------- | +| `"container"` | | + + +### Dependencies + +### Used by + + - [part-wrap-ssr-shadow-cmp](.) + +### Graph +```mermaid +graph TD; + part-wrap-ssr-shadow-cmp --> part-ssr-shadow-cmp + style part-ssr-shadow-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `part-wrap-ssr-shadow-cmp` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------- | ---------- | ----------- | --------- | ----------- | +| `selected` | `selected` | | `boolean` | `undefined` | + + +### Dependencies + +### Depends on + +- [part-ssr-shadow-cmp](.) + +### Graph +```mermaid +graph TD; + part-wrap-ssr-shadow-cmp --> part-ssr-shadow-cmp + style part-wrap-ssr-shadow-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-ssr-child-cmp` + +### Dependencies + +### Used by + + - [shadow-ssr-parent-cmp](.) + +### Graph +```mermaid +graph TD; + shadow-ssr-parent-cmp --> scoped-ssr-child-cmp + style scoped-ssr-child-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-ssr-parent-cmp` + +### Dependencies + +### Depends on + +- [shadow-ssr-child-cmp](.) + +### Graph +```mermaid +graph TD; + scoped-ssr-parent-cmp --> shadow-ssr-child-cmp + shadow-ssr-child-cmp --> ssr-order-cmp + style scoped-ssr-parent-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `shadow-ssr-child-cmp` + +### Dependencies + +### Used by + + - [scoped-ssr-parent-cmp](.) + +### Depends on + +- [ssr-order-cmp](.) + +### Graph +```mermaid +graph TD; + shadow-ssr-child-cmp --> ssr-order-cmp + scoped-ssr-parent-cmp --> shadow-ssr-child-cmp + style shadow-ssr-child-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `shadow-ssr-parent-cmp` + +### Dependencies + +### Depends on + +- [scoped-ssr-child-cmp](.) + +### Graph +```mermaid +graph TD; + shadow-ssr-parent-cmp --> scoped-ssr-child-cmp + style shadow-ssr-parent-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slow-ssr-prop` + +### Properties + +| Property | Attribute | Description | Type | Default | +| --------- | --------- | ----------- | ---------- | ------- | +| `anArray` | -- | | `string[]` | `[]` | + + + +## `ssr-order-cmp` + +### Dependencies + +### Used by + + - [shadow-ssr-child-cmp](.) + - [ssr-order-wrap-cmp](.) + +### Graph +```mermaid +graph TD; + shadow-ssr-child-cmp --> ssr-order-cmp + ssr-order-wrap-cmp --> ssr-order-cmp + style ssr-order-cmp fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `ssr-order-wrap-cmp` + +### Dependencies ### Depends on @@ -18,6 +171,7 @@ graph TD; style ssr-order-wrap-cmp fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/integration/e2e/src/ssr-scoped-hydration/readme.md b/test/integration/e2e/src/ssr-scoped-hydration/readme.md index 732a84fe8a6..510fa9b9d75 100644 --- a/test/integration/e2e/src/ssr-scoped-hydration/readme.md +++ b/test/integration/e2e/src/ssr-scoped-hydration/readme.md @@ -5,6 +5,38 @@ +## `non-shadow-forwarded-slot` + +### Dependencies + +### Depends on + +- [shadow-child](.) + +### Graph +```mermaid +graph TD; + non-shadow-forwarded-slot --> shadow-child + style non-shadow-forwarded-slot fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `shadow-child` + +### Dependencies + +### Used by + + - [non-shadow-forwarded-slot](.) + +### Graph +```mermaid +graph TD; + non-shadow-forwarded-slot --> shadow-child + style shadow-child fill:#f9f,stroke:#333,stroke-width:4px +``` + + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/perf/build-benchmark/benchmark-results.json b/test/perf/build-benchmark/benchmark-results.json index 33e1d93c366..05f6b82f8b4 100644 --- a/test/perf/build-benchmark/benchmark-results.json +++ b/test/perf/build-benchmark/benchmark-results.json @@ -1,27 +1,37 @@ { "latest": { - "timestamp": "2026-04-10T10:49:46.767Z", - "stencilVersion": "5.0.0-alpha.3", + "timestamp": "2026-05-29T00:08:49.435Z", + "stencilVersion": "5.0.0-alpha.6", "nodeVersion": "v24.14.0", "platform": "darwin", "arch": "x64", "cold": { - "runs": [20892.681958999998, 23505.49664, 22801.728985, 22364.80433, 23421.913166], - "min": 20892.681958999998, - "max": 23505.49664, - "avg": 22597.325016, - "stddev": 949.355162149382, - "median": 22801.728985 + "runs": [ + 23421.083687000002, + 23884.050122, + 25321.340081999995, + 25039.486653999993, + 24127.975055000003 + ], + "min": 23421.083687000002, + "max": 25321.340081999995, + "avg": 24358.78712, + "stddev": 713.8343246331557, + "median": 24127.975055000003 }, "warm": { "runs": [ - 19698.374725, 18679.153068999993, 19107.783211, 19357.10183500001, 19292.62691000002 + 20331.99189199999, + 20311.053212, + 20945.819419000007, + 19697.669293999992, + 19727.812055999995 ], - "min": 18679.153068999993, - "max": 19698.374725, - "avg": 19227.007950000007, - "stddev": 333.99892587400086, - "median": 19292.62691000002 + "min": 19697.669293999992, + "max": 20945.819419000007, + "avg": 20202.869174599997, + "stddev": 460.7076541673154, + "median": 20311.053212 } }, "history": [ @@ -32,7 +42,11 @@ "arch": "x64", "cold": { "runs": [ - 34351.170047, 33631.484595, 33792.84220999999, 33212.284922000006, 36396.31289599999 + 34351.170047, + 33631.484595, + 33792.84220999999, + 33212.284922000006, + 36396.31289599999 ], "min": 33212.284922000006, "max": 36396.31289599999, @@ -42,7 +56,10 @@ }, "warm": { "runs": [ - 25229.430728999985, 24570.14856, 24362.824242000002, 25592.336630999984, + 25229.430728999985, + 24570.14856, + 24362.824242000002, + 25592.336630999984, 24989.860770999978 ], "min": 24362.824242000002, @@ -60,7 +77,11 @@ "arch": "x64", "cold": { "runs": [ - 41070.203315000006, 40466.788155999995, 36355.54683200001, 36107.316288, 36471.71495299999 + 41070.203315000006, + 40466.788155999995, + 36355.54683200001, + 36107.316288, + 36471.71495299999 ], "min": 36107.316288, "max": 41070.203315000006, @@ -70,7 +91,10 @@ }, "warm": { "runs": [ - 24409.04587500001, 23895.561968000024, 24854.688289999962, 24717.536471, + 24409.04587500001, + 23895.561968000024, + 24854.688289999962, + 24717.536471, 24724.432998000004 ], "min": 23895.561968000024, @@ -88,7 +112,11 @@ "arch": "x64", "cold": { "runs": [ - 34114.5202, 35607.537745999995, 35920.99819, 38205.58783800001, 38664.109512000025 + 34114.5202, + 35607.537745999995, + 35920.99819, + 38205.58783800001, + 38664.109512000025 ], "min": 34114.5202, "max": 38664.109512000025, @@ -98,7 +126,11 @@ }, "warm": { "runs": [ - 27898.99829300001, 26013.86491600002, 25837.091231000028, 26647.193134, 27039.510117000027 + 27898.99829300001, + 26013.86491600002, + 25837.091231000028, + 26647.193134, + 27039.510117000027 ], "min": 25837.091231000028, "max": 27898.99829300001, @@ -115,7 +147,11 @@ "arch": "x64", "cold": { "runs": [ - 39085.46991, 42408.136897, 42921.186862999995, 40101.28373699999, 37520.62988199998 + 39085.46991, + 42408.136897, + 42921.186862999995, + 40101.28373699999, + 37520.62988199998 ], "min": 37520.62988199998, "max": 42921.186862999995, @@ -125,7 +161,10 @@ }, "warm": { "runs": [ - 31742.300088999997, 32021.184749999957, 30630.97302199999, 30063.85729200003, + 31742.300088999997, + 32021.184749999957, + 30630.97302199999, + 30063.85729200003, 30797.36477600003 ], "min": 30063.85729200003, @@ -142,7 +181,13 @@ "platform": "darwin", "arch": "x64", "cold": { - "runs": [40972.065847, 43680.122187, 39409.826071, 39234.818866, 39924.505492], + "runs": [ + 40972.065847, + 43680.122187, + 39409.826071, + 39234.818866, + 39924.505492 + ], "min": 39234.818866, "max": 43680.122187, "avg": 40644.2676926, @@ -151,7 +196,10 @@ }, "warm": { "runs": [ - 31297.078374999983, 30858.587757, 29865.421657999977, 29993.223707999976, + 31297.078374999983, + 30858.587757, + 29865.421657999977, + 29993.223707999976, 29969.610345000052 ], "min": 29865.421657999977, @@ -169,7 +217,10 @@ "arch": "x64", "cold": { "runs": [ - 23269.459319999998, 25148.249820999998, 24139.774174000006, 23181.865806999995, + 23269.459319999998, + 25148.249820999998, + 24139.774174000006, + 23181.865806999995, 24293.64589 ], "min": 23181.865806999995, @@ -180,7 +231,10 @@ }, "warm": { "runs": [ - 15871.201039999985, 15170.183310000022, 15762.060900000011, 16362.84202099999, + 15871.201039999985, + 15170.183310000022, + 15762.060900000011, + 16362.84202099999, 15835.389356 ], "min": 15170.183310000022, @@ -198,7 +252,10 @@ "arch": "x64", "cold": { "runs": [ - 23991.005767000002, 25526.902739999998, 25937.340996, 25899.129243999996, + 23991.005767000002, + 25526.902739999998, + 25937.340996, + 25899.129243999996, 25927.120349999997 ], "min": 23991.005767000002, @@ -209,7 +266,10 @@ }, "warm": { "runs": [ - 19106.065850000014, 18406.57298300002, 18004.800843000005, 17384.010858000023, + 19106.065850000014, + 18406.57298300002, + 18004.800843000005, + 17384.010858000023, 18236.920518 ], "min": 17384.010858000023, @@ -227,7 +287,11 @@ "arch": "x64", "cold": { "runs": [ - 18161.978351, 19056.576091, 20401.606789000005, 19191.509473000006, 18364.89678299999 + 18161.978351, + 19056.576091, + 20401.606789000005, + 19191.509473000006, + 18364.89678299999 ], "min": 18161.978351, "max": 20401.606789000005, @@ -237,7 +301,10 @@ }, "warm": { "runs": [ - 15664.562531999996, 16320.587922999985, 15667.609597000002, 15464.345964999986, + 15664.562531999996, + 16320.587922999985, + 15667.609597000002, + 15464.345964999986, 15542.90580399998 ], "min": 15464.345964999986, @@ -255,7 +322,11 @@ "arch": "x64", "cold": { "runs": [ - 22201.833985999998, 23948.516979, 23626.507618999996, 24845.281126, 24417.314983000004 + 22201.833985999998, + 23948.516979, + 23626.507618999996, + 24845.281126, + 24417.314983000004 ], "min": 22201.833985999998, "max": 24845.281126, @@ -265,7 +336,10 @@ }, "warm": { "runs": [ - 22082.074709999986, 21207.868811000022, 22056.905397000024, 20727.638967000006, + 22082.074709999986, + 21207.868811000022, + 22056.905397000024, + 20727.638967000006, 20331.37961100001 ], "min": 20331.37961100001, @@ -282,7 +356,13 @@ "platform": "darwin", "arch": "x64", "cold": { - "runs": [21577.937547, 22903.280945000002, 24116.355673, 26190.01642, 25381.22183200001], + "runs": [ + 21577.937547, + 22903.280945000002, + 24116.355673, + 26190.01642, + 25381.22183200001 + ], "min": 21577.937547, "max": 26190.01642, "avg": 24033.7624834, @@ -291,7 +371,10 @@ }, "warm": { "runs": [ - 20118.486140999972, 18990.438446999993, 20025.83328000002, 20014.39137899998, + 20118.486140999972, + 18990.438446999993, + 20025.83328000002, + 20014.39137899998, 19337.564650000015 ], "min": 18990.438446999993, @@ -308,7 +391,13 @@ "platform": "darwin", "arch": "x64", "cold": { - "runs": [20892.681958999998, 23505.49664, 22801.728985, 22364.80433, 23421.913166], + "runs": [ + 20892.681958999998, + 23505.49664, + 22801.728985, + 22364.80433, + 23421.913166 + ], "min": 20892.681958999998, "max": 23505.49664, "avg": 22597.325016, @@ -317,7 +406,11 @@ }, "warm": { "runs": [ - 19698.374725, 18679.153068999993, 19107.783211, 19357.10183500001, 19292.62691000002 + 19698.374725, + 18679.153068999993, + 19107.783211, + 19357.10183500001, + 19292.62691000002 ], "min": 18679.153068999993, "max": 19698.374725, @@ -325,6 +418,41 @@ "stddev": 333.99892587400086, "median": 19292.62691000002 } + }, + { + "timestamp": "2026-05-29T00:08:49.435Z", + "stencilVersion": "5.0.0-alpha.6", + "nodeVersion": "v24.14.0", + "platform": "darwin", + "arch": "x64", + "cold": { + "runs": [ + 23421.083687000002, + 23884.050122, + 25321.340081999995, + 25039.486653999993, + 24127.975055000003 + ], + "min": 23421.083687000002, + "max": 25321.340081999995, + "avg": 24358.78712, + "stddev": 713.8343246331557, + "median": 24127.975055000003 + }, + "warm": { + "runs": [ + 20331.99189199999, + 20311.053212, + 20945.819419000007, + 19697.669293999992, + 19727.812055999995 + ], + "min": 19697.669293999992, + "max": 20945.819419000007, + "avg": 20202.869174599997, + "stddev": 460.7076541673154, + "median": 20311.053212 + } } ] -} +} \ No newline at end of file diff --git a/test/perf/build-benchmark/benchmark-results.md b/test/perf/build-benchmark/benchmark-results.md index 265aada0614..c4212580156 100644 --- a/test/perf/build-benchmark/benchmark-results.md +++ b/test/perf/build-benchmark/benchmark-results.md @@ -1,7 +1,7 @@ # Stencil Compile Time Benchmark -**Last Run:** 2026-04-10T10:49:46.767Z -**Stencil:** 5.0.0-alpha.3 | **Node:** v24.14.0 | **Platform:** darwin (x64) +**Last Run:** 2026-05-29T00:08:49.435Z +**Stencil:** 5.0.0-alpha.6 | **Node:** v24.14.0 | **Platform:** darwin (x64) ## Latest Results @@ -9,33 +9,29 @@ | Metric | Value | |----------|----------| -| Min | 20.89s | -| Max | 23.51s | -| **Avg** | **22.60s** | -| Median | 22.80s | -| StdDev | 0.95s | +| Min | 23.42s | +| Max | 25.32s | +| **Avg** | **24.36s** | +| Median | 24.13s | +| StdDev | 0.71s | ### Warm Builds (with cache) | Metric | Value | |----------|----------| -| Min | 18.68s | -| Max | 19.70s | -| **Avg** | **19.23s** | -| Median | 19.29s | -| StdDev | 0.33s | +| Min | 19.70s | +| Max | 20.95s | +| **Avg** | **20.20s** | +| Median | 20.31s | +| StdDev | 0.46s | ## History | Date | Stencil | Cold Avg | Warm Avg | Node | |------------|----------|----------|----------|----------| -| 4/10/2026 | 5.0.0-alpha.3 | 22.60s | 19.23s | v24.14.0 | -| 4/10/2026 | 5.0.0-alpha.3 | 24.03s | 19.70s | v24.14.0 | -| 4/10/2026 | 5.0.0-alpha.3 | 23.81s | 21.28s | v24.14.0 | | 4/3/2026 | 5.0.0-alpha.2 | 19.04s | 15.73s | v24.14.0 | | 4/3/2026 | 5.0.0-alpha.2 | 25.46s | 18.23s | v24.14.0 | | 4/2/2026 | 5.0.0-alpha.2 | 24.01s | 15.80s | v24.14.0 | | 4/2/2026 | 5.0.0-alpha.2 | 40.64s | 30.40s | v24.14.0 | | 4/2/2026 | 5.0.0-alpha.2 | 40.41s | 31.05s | v24.14.0 | | 3/24/2026 | 5.0.0-next.0 | 36.50s | 26.69s | v22.22.0 | -| 2/7/2026 | 4.42.1 | 38.09s | 24.52s | v22.2.0 | diff --git a/test/runtime/src/components.d.ts b/test/runtime/src/components.d.ts index 6a434b38763..2ebcec54ad3 100644 --- a/test/runtime/src/components.d.ts +++ b/test/runtime/src/components.d.ts @@ -282,10 +282,6 @@ export namespace Components { } interface EventListenerCapture { } - interface ExcludeComponentRoot { - } - interface ExcludedComponent { - } interface ExtendedCmp { /** * @default 'getter default value' @@ -1754,18 +1750,6 @@ declare global { prototype: HTMLEventListenerCaptureElement; new (): HTMLEventListenerCaptureElement; }; - interface HTMLExcludeComponentRootElement extends Components.ExcludeComponentRoot, HTMLStencilElement { - } - var HTMLExcludeComponentRootElement: { - prototype: HTMLExcludeComponentRootElement; - new (): HTMLExcludeComponentRootElement; - }; - interface HTMLExcludedComponentElement extends Components.ExcludedComponent, HTMLStencilElement { - } - var HTMLExcludedComponentElement: { - prototype: HTMLExcludedComponentElement; - new (): HTMLExcludedComponentElement; - }; interface HTMLExtendedCmpElement extends Components.ExtendedCmp, HTMLStencilElement { } var HTMLExtendedCmpElement: { @@ -3120,8 +3104,6 @@ declare global { "event-basic": HTMLEventBasicElement; "event-custom-type": HTMLEventCustomTypeElement; "event-listener-capture": HTMLEventListenerCaptureElement; - "exclude-component-root": HTMLExcludeComponentRootElement; - "excluded-component": HTMLExcludedComponentElement; "extended-cmp": HTMLExtendedCmpElement; "extended-cmp-cmp": HTMLExtendedCmpCmpElement; "extends-abstract": HTMLExtendsAbstractElement; @@ -3564,10 +3546,6 @@ declare namespace LocalJSX { } interface EventListenerCapture { } - interface ExcludeComponentRoot { - } - interface ExcludedComponent { - } interface ExtendedCmp { /** * @default 'getter default value' @@ -4753,8 +4731,6 @@ declare namespace LocalJSX { "event-basic": EventBasic; "event-custom-type": EventCustomType; "event-listener-capture": EventListenerCapture; - "exclude-component-root": ExcludeComponentRoot; - "excluded-component": ExcludedComponent; "extended-cmp": Omit & { [K in keyof ExtendedCmp & keyof ExtendedCmpAttributes]?: ExtendedCmp[K] } & { [K in keyof ExtendedCmp & keyof ExtendedCmpAttributes as `attr:${K}`]?: ExtendedCmpAttributes[K] } & { [K in keyof ExtendedCmp & keyof ExtendedCmpAttributes as `prop:${K}`]?: ExtendedCmp[K] }; "extended-cmp-cmp": Omit & { [K in keyof ExtendedCmpCmp & keyof ExtendedCmpCmpAttributes]?: ExtendedCmpCmp[K] } & { [K in keyof ExtendedCmpCmp & keyof ExtendedCmpCmpAttributes as `attr:${K}`]?: ExtendedCmpCmpAttributes[K] } & { [K in keyof ExtendedCmpCmp & keyof ExtendedCmpCmpAttributes as `prop:${K}`]?: ExtendedCmpCmp[K] }; "extends-abstract": Omit & { [K in keyof ExtendsAbstract & keyof ExtendsAbstractAttributes]?: ExtendsAbstract[K] } & { [K in keyof ExtendsAbstract & keyof ExtendsAbstractAttributes as `attr:${K}`]?: ExtendsAbstractAttributes[K] } & { [K in keyof ExtendsAbstract & keyof ExtendsAbstractAttributes as `prop:${K}`]?: ExtendsAbstract[K] }; @@ -5009,8 +4985,6 @@ declare module "@stencil/core" { "event-basic": LocalJSX.IntrinsicElements["event-basic"] & JSXBase.HTMLAttributes; "event-custom-type": LocalJSX.IntrinsicElements["event-custom-type"] & JSXBase.HTMLAttributes; "event-listener-capture": LocalJSX.IntrinsicElements["event-listener-capture"] & JSXBase.HTMLAttributes; - "exclude-component-root": LocalJSX.IntrinsicElements["exclude-component-root"] & JSXBase.HTMLAttributes; - "excluded-component": LocalJSX.IntrinsicElements["excluded-component"] & JSXBase.HTMLAttributes; "extended-cmp": LocalJSX.IntrinsicElements["extended-cmp"] & JSXBase.HTMLAttributes; "extended-cmp-cmp": LocalJSX.IntrinsicElements["extended-cmp-cmp"] & JSXBase.HTMLAttributes; /** diff --git a/test/runtime/src/components/attributes/attribute-basic/readme.md b/test/runtime/src/components/attributes/attribute-basic/readme.md index 2f19aba8fdf..5a538e57dab 100644 --- a/test/runtime/src/components/attributes/attribute-basic/readme.md +++ b/test/runtime/src/components/attributes/attribute-basic/readme.md @@ -5,7 +5,35 @@ -## Dependencies +## `attribute-basic` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ------------ | ---------------- | ----------- | -------- | ------------------ | +| `customAttr` | `my-custom-attr` | | `string` | `'my-custom-attr'` | +| `getter` | `getter` | | `string` | `'getter'` | +| `multiWord` | `multi-word` | | `string` | `'multiWord'` | +| `single` | `single` | | `string` | `'single'` | + + +### Dependencies + +### Used by + + - [attribute-basic-root](.) + +### Graph +```mermaid +graph TD; + attribute-basic-root --> attribute-basic + style attribute-basic fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `attribute-basic-root` + +### Dependencies ### Depends on @@ -18,6 +46,7 @@ graph TD; style attribute-basic-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/attributes/attribute-boolean/readme.md b/test/runtime/src/components/attributes/attribute-boolean/readme.md index 8740a5b951a..0d864662a89 100644 --- a/test/runtime/src/components/attributes/attribute-boolean/readme.md +++ b/test/runtime/src/components/attributes/attribute-boolean/readme.md @@ -5,7 +5,21 @@ -## Methods +## `attribute-boolean` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ------------ | ----------- | ---------------------- | ----------- | +| `boolState` | `bool-state` | | `boolean \| undefined` | `undefined` | +| `noreflect` | `noreflect` | | `boolean \| undefined` | `undefined` | +| `strState` | `str-state` | | `string \| undefined` | `undefined` | + + + +## `attribute-boolean-root` + +### Methods ### `toggleState() => Promise` @@ -18,6 +32,7 @@ Type: `Promise` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/attributes/prefix-attr/readme.md b/test/runtime/src/components/attributes/prefix-attr/readme.md index f73118993d0..95197ae86d5 100644 --- a/test/runtime/src/components/attributes/prefix-attr/readme.md +++ b/test/runtime/src/components/attributes/prefix-attr/readme.md @@ -5,7 +5,36 @@ -## Dependencies +## `prefix-attr-nested` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------------- | ----------------- | ----------- | ----------------------------- | ----------- | +| `count` | `count` | | `number \| undefined` | `undefined` | +| `enabled` | `enabled` | | `boolean \| undefined` | `undefined` | +| `message` | `message` | | `string \| undefined` | `undefined` | +| `nullValue` | `null-value` | | `null \| string \| undefined` | `undefined` | +| `undefinedValue` | `undefined-value` | | `string \| undefined` | `undefined` | + + +### Dependencies + +### Used by + + - [prefix-attr-root](.) + +### Graph +```mermaid +graph TD; + prefix-attr-root --> prefix-attr-nested + style prefix-attr-nested fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `prefix-attr-root` + +### Dependencies ### Depends on @@ -18,6 +47,7 @@ graph TD; style prefix-attr-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/attributes/prefix-prop/readme.md b/test/runtime/src/components/attributes/prefix-prop/readme.md index 83580236211..0d28b4d59d8 100644 --- a/test/runtime/src/components/attributes/prefix-prop/readme.md +++ b/test/runtime/src/components/attributes/prefix-prop/readme.md @@ -5,7 +5,35 @@ -## Dependencies +## `prefix-prop-nested` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------------- | ----------------- | ----------- | ----------------------------- | ----------- | +| `count` | `count` | | `number \| undefined` | `undefined` | +| `message` | `message` | | `string \| undefined` | `undefined` | +| `nullValue` | `null-value` | | `null \| string \| undefined` | `undefined` | +| `undefinedValue` | `undefined-value` | | `string \| undefined` | `undefined` | + + +### Dependencies + +### Used by + + - [prefix-prop-root](.) + +### Graph +```mermaid +graph TD; + prefix-prop-root --> prefix-prop-nested + style prefix-prop-nested fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `prefix-prop-root` + +### Dependencies ### Depends on @@ -18,6 +46,7 @@ graph TD; style prefix-prop-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/attributes/reflect-nan-attribute-with-child/readme.md b/test/runtime/src/components/attributes/reflect-nan-attribute-with-child/readme.md index fba21601445..414f43ac23e 100644 --- a/test/runtime/src/components/attributes/reflect-nan-attribute-with-child/readme.md +++ b/test/runtime/src/components/attributes/reflect-nan-attribute-with-child/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `child-reflect-nan-attribute` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ----------- | +| `val` | `val` | | `number` | `undefined` | + + +### Dependencies + +### Used by + + - [parent-reflect-nan-attribute](.) + +### Graph +```mermaid +graph TD; + parent-reflect-nan-attribute --> child-reflect-nan-attribute + style child-reflect-nan-attribute fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `parent-reflect-nan-attribute` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style parent-reflect-nan-attribute fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/attributes/reflect-single-render/readme.md b/test/runtime/src/components/attributes/reflect-single-render/readme.md index c4e983a3ca0..67ae9c1a4b3 100644 --- a/test/runtime/src/components/attributes/reflect-single-render/readme.md +++ b/test/runtime/src/components/attributes/reflect-single-render/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `child-with-reflection` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | ----- | ----------- | +| `val` | `val` | | `any` | `undefined` | + + +### Dependencies + +### Used by + + - [parent-with-reflect-child](.) + +### Graph +```mermaid +graph TD; + parent-with-reflect-child --> child-with-reflection + style child-with-reflection fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `parent-with-reflect-child` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style parent-with-reflect-child fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/build/tag-transform/readme.md b/test/runtime/src/components/build/tag-transform/readme.md index f3d9c5cdd29..9d280008d9b 100644 --- a/test/runtime/src/components/build/tag-transform/readme.md +++ b/test/runtime/src/components/build/tag-transform/readme.md @@ -5,7 +5,45 @@ -## Methods +## `child-tag-transform` + +### Properties + +| Property | Attribute | Description | Type | Default | +| --------- | --------- | ----------- | -------- | -------------------- | +| `message` | `message` | | `string` | `'Hello from Child'` | + + +### Methods + +### `closestParentTag() => Promise` + + + +#### Returns + +Type: `Promise` + + + + +### Dependencies + +### Used by + + - [parent-tag-transform](.) + +### Graph +```mermaid +graph TD; + parent-tag-transform --> child-tag-transform + style child-tag-transform fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `parent-tag-transform` + +### Methods ### `createChildTagElement() => Promise` @@ -48,7 +86,7 @@ Type: `Promise` -## Dependencies +### Dependencies ### Depends on @@ -61,6 +99,7 @@ graph TD; style parent-tag-transform fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/dom/clone-node/readme.md b/test/runtime/src/components/dom/clone-node/readme.md index 4bc3d190e40..8940df3aee7 100644 --- a/test/runtime/src/components/dom/clone-node/readme.md +++ b/test/runtime/src/components/dom/clone-node/readme.md @@ -5,7 +5,43 @@ -## Dependencies +## `clone-node-root` + +### Dependencies + +### Depends on + +- [clone-node-slide](.) +- [clone-node-text](.) + +### Graph +```mermaid +graph TD; + clone-node-root --> clone-node-slide + clone-node-root --> clone-node-text + style clone-node-root fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `clone-node-slide` + +### Dependencies + +### Used by + + - [clone-node-root](.) + +### Graph +```mermaid +graph TD; + clone-node-root --> clone-node-slide + style clone-node-slide fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `clone-node-text` + +### Dependencies ### Used by @@ -18,6 +54,7 @@ graph TD; style clone-node-text fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/events/listen-jsx/readme.md b/test/runtime/src/components/events/listen-jsx/readme.md index 4e4a31a62f9..bb572bb5426 100644 --- a/test/runtime/src/components/events/listen-jsx/readme.md +++ b/test/runtime/src/components/events/listen-jsx/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `listen-jsx` + +### Dependencies + +### Used by + + - [listen-jsx-root](.) + +### Graph +```mermaid +graph TD; + listen-jsx-root --> listen-jsx + style listen-jsx fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `listen-jsx-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style listen-jsx-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/forms/form-associated/readme.md b/test/runtime/src/components/forms/form-associated/readme.md index 108fb638899..896df3baddb 100644 --- a/test/runtime/src/components/forms/form-associated/readme.md +++ b/test/runtime/src/components/forms/form-associated/readme.md @@ -5,13 +5,16 @@ -## Properties +## `form-associated-prop-check` + +### Properties | Property | Attribute | Description | Type | Default | | ---------- | ---------- | ----------- | --------- | ----------- | | `disabled` | `disabled` | | `boolean` | `undefined` | + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/forms/radio-group-blur/readme.md b/test/runtime/src/components/forms/radio-group-blur/readme.md index 005689f2fde..ca881ff58f4 100644 --- a/test/runtime/src/components/forms/radio-group-blur/readme.md +++ b/test/runtime/src/components/forms/radio-group-blur/readme.md @@ -5,7 +5,120 @@ -## Dependencies +## `ion-radio` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | -------------- | +| `name` | `name` | | `string` | `this.inputId` | +| `value` | `value` | | `any` | `undefined` | + + +### Events + +| Event | Description | Type | +| ---------- | ----------- | ------------------- | +| `ionBlur` | | `CustomEvent` | +| `ionFocus` | | `CustomEvent` | + + +### Methods + +### `setButtonTabindex(value: number) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ------- | -------- | ----------- | +| `value` | `number` | | + +#### Returns + +Type: `Promise` + + + +### `setFocus(ev?: globalThis.Event) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| ---- | -------------------- | ----------- | +| `ev` | `Event \| undefined` | | + +#### Returns + +Type: `Promise` + + + + +### Shadow Parts + +| Part | Description | +| ------------- | ----------- | +| `"container"` | | +| `"mark"` | | + + +### Dependencies + +### Used by + + - [radio-group-blur-test](.) + +### Graph +```mermaid +graph TD; + radio-group-blur-test --> ion-radio + style ion-radio fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `ion-radio-group` + +### Properties + +| Property | Attribute | Description | Type | Default | +| --------------------- | ----------------------- | ----------- | ------------------------------------------------------------------------------------ | -------------- | +| `allowEmptySelection` | `allow-empty-selection` | | `boolean` | `false` | +| `compareWith` | `compare-with` | | `((currentValue: any, compareValue: any) => boolean) \| null \| string \| undefined` | `undefined` | +| `errorText` | `error-text` | | `string \| undefined` | `undefined` | +| `helperText` | `helper-text` | | `string \| undefined` | `undefined` | +| `name` | `name` | | `string` | `this.inputId` | +| `value` | `value` | | `any` | `undefined` | + + +### Events + +| Event | Description | Type | +| ---------------- | ----------- | ------------------ | +| `ionChange` | | `CustomEvent` | +| `ionValueChange` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [radio-group-blur-test](.) + +### Graph +```mermaid +graph TD; + radio-group-blur-test --> ion-radio-group + style ion-radio-group fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `radio-group-blur-test` + +### Dependencies ### Depends on @@ -20,6 +133,7 @@ graph TD; style radio-group-blur-test fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/inheritance/extends-cmp/readme.md b/test/runtime/src/components/inheritance/extends-cmp/readme.md index dc9c0834a84..d8adc9241c1 100644 --- a/test/runtime/src/components/inheritance/extends-cmp/readme.md +++ b/test/runtime/src/components/inheritance/extends-cmp/readme.md @@ -5,7 +5,79 @@ -## Properties +## `extended-cmp` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ------------ | ------------- | ----------- | -------- | -------------------------- | +| `getterProp` | `getter-prop` | | `string` | `'getter default value'` | +| `prop1` | `prop-1` | | `string` | `'ExtendedCmp text'` | +| `prop2` | `prop-2` | | `string` | `'ExtendedCmp prop2 text'` | + + +### Methods + +### `method1() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `method2() => Promise` + + + +#### Returns + +Type: `Promise` + + + + + +## `extended-cmp-cmp` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ------------ | ------------- | ----------- | -------- | -------------------------- | +| `getterProp` | `getter-prop` | | `string` | `'getter default value'` | +| `prop1` | `prop-1` | | `string` | `'ExtendedCmp text'` | +| `prop2` | `prop-2` | | `string` | `'ExtendedCmp prop2 text'` | + + +### Methods + +### `method1() => Promise` + + + +#### Returns + +Type: `Promise` + + + +### `method2() => Promise` + + + +#### Returns + +Type: `Promise` + + + + + +## `extends-cmp-cmp` + +### Properties | Property | Attribute | Description | Type | Default | | ------------ | ------------- | ----------- | -------- | -------------------------- | @@ -14,7 +86,7 @@ | `prop2` | `prop-2` | | `string` | `'ExtendedCmp prop2 text'` | -## Methods +### Methods ### `method1() => Promise` @@ -37,6 +109,7 @@ Type: `Promise` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/inheritance/extends-composition-scaling/readme.md b/test/runtime/src/components/inheritance/extends-composition-scaling/readme.md index 515a71e5237..28d59dc9fb0 100644 --- a/test/runtime/src/components/inheritance/extends-composition-scaling/readme.md +++ b/test/runtime/src/components/inheritance/extends-composition-scaling/readme.md @@ -5,7 +5,80 @@ -## Dependencies +## `composition-checkbox-group` + +### Events + +| Event | Description | Type | +| ------------- | ----------- | ----------------------- | +| `valueChange` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [composition-scaling-demo](.) + +### Graph +```mermaid +graph TD; + composition-scaling-demo --> composition-checkbox-group + style composition-checkbox-group fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `composition-radio-group` + +### Events + +| Event | Description | Type | +| ------------- | ----------- | --------------------- | +| `valueChange` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [composition-scaling-demo](.) + +### Graph +```mermaid +graph TD; + composition-scaling-demo --> composition-radio-group + style composition-radio-group fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `composition-scaling-demo` + +### Overview + +Main component that demonstrates composition-based scaling +with 3 components and 2 controllers (ValidationController and FocusController) + +### Dependencies + +### Depends on + +- [composition-text-input](.) +- [composition-radio-group](.) +- [composition-checkbox-group](.) + +### Graph +```mermaid +graph TD; + composition-scaling-demo --> composition-text-input + composition-scaling-demo --> composition-radio-group + composition-scaling-demo --> composition-checkbox-group + style composition-scaling-demo fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `composition-text-input` + +### Dependencies ### Used by @@ -18,6 +91,7 @@ graph TD; style composition-text-input fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/inheritance/extends-inheritance-scaling/readme.md b/test/runtime/src/components/inheritance/extends-inheritance-scaling/readme.md index 1675d9c2f96..0c1ebf3e6fb 100644 --- a/test/runtime/src/components/inheritance/extends-inheritance-scaling/readme.md +++ b/test/runtime/src/components/inheritance/extends-inheritance-scaling/readme.md @@ -5,7 +5,80 @@ -## Dependencies +## `inheritance-checkbox-group` + +### Events + +| Event | Description | Type | +| ------------- | ----------- | ----------------------- | +| `valueChange` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [inheritance-scaling-demo](.) + +### Graph +```mermaid +graph TD; + inheritance-scaling-demo --> inheritance-checkbox-group + style inheritance-checkbox-group fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `inheritance-radio-group` + +### Events + +| Event | Description | Type | +| ------------- | ----------- | --------------------- | +| `valueChange` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [inheritance-scaling-demo](.) + +### Graph +```mermaid +graph TD; + inheritance-scaling-demo --> inheritance-radio-group + style inheritance-radio-group fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `inheritance-scaling-demo` + +### Overview + +Main component that demonstrates inheritance-based scaling +with 3 components and 2 controllers (ValidationController and FocusController) + +### Dependencies + +### Depends on + +- [inheritance-text-input](.) +- [inheritance-radio-group](.) +- [inheritance-checkbox-group](.) + +### Graph +```mermaid +graph TD; + inheritance-scaling-demo --> inheritance-text-input + inheritance-scaling-demo --> inheritance-radio-group + inheritance-scaling-demo --> inheritance-checkbox-group + style inheritance-scaling-demo fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `inheritance-text-input` + +### Dependencies ### Used by @@ -18,6 +91,7 @@ graph TD; style inheritance-text-input fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/lifecycle/child-load-failure/readme.md b/test/runtime/src/components/lifecycle/child-load-failure/readme.md index 210b5b1140e..7d37b6ad84a 100644 --- a/test/runtime/src/components/lifecycle/child-load-failure/readme.md +++ b/test/runtime/src/components/lifecycle/child-load-failure/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `cmp-child-fail` + +### Dependencies + +### Used by + + - [cmp-parent](.) + +### Graph +```mermaid +graph TD; + cmp-parent --> cmp-child-fail + style cmp-child-fail fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `cmp-parent` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style cmp-parent fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/lifecycle/lifecycle-async/readme.md b/test/runtime/src/components/lifecycle/lifecycle-async/readme.md index f0ceca843f3..cacedb47a60 100644 --- a/test/runtime/src/components/lifecycle/lifecycle-async/readme.md +++ b/test/runtime/src/components/lifecycle/lifecycle-async/readme.md @@ -5,14 +5,69 @@ -## Properties +## `lifecycle-async-a` + +### Dependencies + +### Depends on + +- [lifecycle-async-b](.) + +### Graph +```mermaid +graph TD; + lifecycle-async-a --> lifecycle-async-b + lifecycle-async-b --> lifecycle-async-c + style lifecycle-async-a fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-async-b` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ------- | +| `value` | `value` | | `string` | `''` | + + +### Events + +| Event | Description | Type | +| ----------------- | ----------- | ------------------ | +| `lifecycleLoad` | | `CustomEvent` | +| `lifecycleUpdate` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [lifecycle-async-a](.) + +### Depends on + +- [lifecycle-async-c](.) + +### Graph +```mermaid +graph TD; + lifecycle-async-b --> lifecycle-async-c + lifecycle-async-a --> lifecycle-async-b + style lifecycle-async-b fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-async-c` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ----------- | -------- | ------- | | `value` | `value` | | `string` | `''` | -## Events +### Events | Event | Description | Type | | ----------------- | ----------- | ------------------ | @@ -20,7 +75,7 @@ | `lifecycleUpdate` | | `CustomEvent` | -## Dependencies +### Dependencies ### Used by @@ -33,6 +88,7 @@ graph TD; style lifecycle-async-c fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/lifecycle/lifecycle-basic/readme.md b/test/runtime/src/components/lifecycle/lifecycle-basic/readme.md index 2c33e59a491..e72060e8f71 100644 --- a/test/runtime/src/components/lifecycle/lifecycle-basic/readme.md +++ b/test/runtime/src/components/lifecycle/lifecycle-basic/readme.md @@ -5,14 +5,69 @@ -## Properties +## `lifecycle-basic-a` + +### Dependencies + +### Depends on + +- [lifecycle-basic-b](.) + +### Graph +```mermaid +graph TD; + lifecycle-basic-a --> lifecycle-basic-b + lifecycle-basic-b --> lifecycle-basic-c + style lifecycle-basic-a fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-basic-b` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ------- | +| `value` | `value` | | `string` | `''` | + + +### Events + +| Event | Description | Type | +| ----------------- | ----------- | ------------------ | +| `lifecycleLoad` | | `CustomEvent` | +| `lifecycleUpdate` | | `CustomEvent` | + + +### Dependencies + +### Used by + + - [lifecycle-basic-a](.) + +### Depends on + +- [lifecycle-basic-c](.) + +### Graph +```mermaid +graph TD; + lifecycle-basic-b --> lifecycle-basic-c + lifecycle-basic-a --> lifecycle-basic-b + style lifecycle-basic-b fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-basic-c` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ----------- | -------- | ------- | | `value` | `value` | | `string` | `''` | -## Events +### Events | Event | Description | Type | | ----------------- | ----------- | ------------------ | @@ -20,7 +75,7 @@ | `lifecycleUpdate` | | `CustomEvent` | -## Dependencies +### Dependencies ### Used by @@ -33,6 +88,7 @@ graph TD; style lifecycle-basic-c fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/lifecycle/lifecycle-unload/readme.md b/test/runtime/src/components/lifecycle/lifecycle-unload/readme.md index f95906be194..9d3ec49d965 100644 --- a/test/runtime/src/components/lifecycle/lifecycle-unload/readme.md +++ b/test/runtime/src/components/lifecycle/lifecycle-unload/readme.md @@ -5,7 +5,46 @@ -## Dependencies +## `lifecycle-unload-a` + +### Dependencies + +### Used by + + - [lifecycle-unload-root](.) + +### Depends on + +- [lifecycle-unload-b](.) + +### Graph +```mermaid +graph TD; + lifecycle-unload-a --> lifecycle-unload-b + lifecycle-unload-root --> lifecycle-unload-a + style lifecycle-unload-a fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-unload-b` + +### Dependencies + +### Used by + + - [lifecycle-unload-a](.) + +### Graph +```mermaid +graph TD; + lifecycle-unload-a --> lifecycle-unload-b + style lifecycle-unload-b fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-unload-root` + +### Dependencies ### Depends on @@ -19,6 +58,7 @@ graph TD; style lifecycle-unload-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/lifecycle/lifecycle-update/readme.md b/test/runtime/src/components/lifecycle/lifecycle-update/readme.md index 2a59bdf5943..7342a20a6d8 100644 --- a/test/runtime/src/components/lifecycle/lifecycle-update/readme.md +++ b/test/runtime/src/components/lifecycle/lifecycle-update/readme.md @@ -5,14 +5,61 @@ -## Properties +## `lifecycle-update-a` + +### Dependencies + +### Depends on + +- [lifecycle-update-b](.) + +### Graph +```mermaid +graph TD; + lifecycle-update-a --> lifecycle-update-b + lifecycle-update-b --> lifecycle-update-c + style lifecycle-update-a fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-update-b` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ----------- | -------- | ------- | | `value` | `value` | | `number` | `0` | -## Dependencies +### Dependencies + +### Used by + + - [lifecycle-update-a](.) + +### Depends on + +- [lifecycle-update-c](.) + +### Graph +```mermaid +graph TD; + lifecycle-update-b --> lifecycle-update-c + lifecycle-update-a --> lifecycle-update-b + style lifecycle-update-b fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `lifecycle-update-c` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ------- | +| `value` | `value` | | `number` | `0` | + + +### Dependencies ### Used by @@ -25,6 +72,7 @@ graph TD; style lifecycle-update-c fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/misc/parent-child-props/readme.md b/test/runtime/src/components/misc/parent-child-props/readme.md index 0eb7a71ca48..c8a4f3a3830 100644 --- a/test/runtime/src/components/misc/parent-child-props/readme.md +++ b/test/runtime/src/components/misc/parent-child-props/readme.md @@ -5,11 +5,36 @@ -## Overview +## `car-detail` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------- | ----------- | +| `car` | `car` | | `CarData` | `undefined` | + + +### Dependencies + +### Used by + + - [car-list](.) + +### Graph +```mermaid +graph TD; + car-list --> car-detail + style car-detail fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `car-list` + +### Overview Component that helps display a list of cars -## Properties +### Properties | Property | Attribute | Description | Type | Default | | ---------- | --------- | ----------- | ----------- | ----------- | @@ -17,28 +42,28 @@ Component that helps display a list of cars | `selected` | -- | | `CarData` | `undefined` | -## Events +### Events | Event | Description | Type | | ------------- | ----------- | ---------------------- | | `carSelected` | | `CustomEvent` | -## Slots +### Slots | Slot | Description | | ---------- | -------------------------------- | | `"header"` | The slot for the header content. | -## Shadow Parts +### Shadow Parts | Part | Description | | ------- | ------------------------------------------- | | `"car"` | The shadow part to target to style the car. | -## Dependencies +### Dependencies ### Depends on @@ -51,6 +76,7 @@ graph TD; style car-list fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/rendering/conditional-rerender/readme.md b/test/runtime/src/components/rendering/conditional-rerender/readme.md index 722030221f5..94ecd2b3149 100644 --- a/test/runtime/src/components/rendering/conditional-rerender/readme.md +++ b/test/runtime/src/components/rendering/conditional-rerender/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `conditional-rerender` + +### Dependencies + +### Used by + + - [conditional-rerender-root](.) + +### Graph +```mermaid +graph TD; + conditional-rerender-root --> conditional-rerender + style conditional-rerender fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `conditional-rerender-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style conditional-rerender-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/scoped/scoped-basic/readme.md b/test/runtime/src/components/scoped/scoped-basic/readme.md index b2c40b67943..17da0a15b23 100644 --- a/test/runtime/src/components/scoped/scoped-basic/readme.md +++ b/test/runtime/src/components/scoped/scoped-basic/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `scoped-basic` + +### Dependencies + +### Used by + + - [scoped-basic-root](.) + +### Graph +```mermaid +graph TD; + scoped-basic-root --> scoped-basic + style scoped-basic fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-basic-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style scoped-basic-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/scoped/scoped-id-in-nested-classname/readme.md b/test/runtime/src/components/scoped/scoped-id-in-nested-classname/readme.md index 9929ba787d9..9d1313614ae 100644 --- a/test/runtime/src/components/scoped/scoped-id-in-nested-classname/readme.md +++ b/test/runtime/src/components/scoped/scoped-id-in-nested-classname/readme.md @@ -5,7 +5,47 @@ -## Dependencies +## `cmp-level-1` + +### Dependencies + +### Depends on + +- [cmp-level-2](.) + +### Graph +```mermaid +graph TD; + cmp-level-1 --> cmp-level-2 + cmp-level-2 --> cmp-level-3 + style cmp-level-1 fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `cmp-level-2` + +### Dependencies + +### Used by + + - [cmp-level-1](.) + +### Depends on + +- [cmp-level-3](.) + +### Graph +```mermaid +graph TD; + cmp-level-2 --> cmp-level-3 + cmp-level-1 --> cmp-level-2 + style cmp-level-2 fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `cmp-level-3` + +### Dependencies ### Used by @@ -18,6 +58,7 @@ graph TD; style cmp-level-3 fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/shadow-dom/shadow-dom-array/readme.md b/test/runtime/src/components/shadow-dom/shadow-dom-array/readme.md index d34fe039e2c..3a7a27680d8 100644 --- a/test/runtime/src/components/shadow-dom/shadow-dom-array/readme.md +++ b/test/runtime/src/components/shadow-dom/shadow-dom-array/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `shadow-dom-array` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | ---------- | ------- | +| `values` | -- | | `number[]` | `[]` | + + +### Dependencies + +### Used by + + - [shadow-dom-array-root](.) + +### Graph +```mermaid +graph TD; + shadow-dom-array-root --> shadow-dom-array + style shadow-dom-array fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `shadow-dom-array-root` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style shadow-dom-array-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/shadow-dom/shadow-dom-basic/readme.md b/test/runtime/src/components/shadow-dom/shadow-dom-basic/readme.md index 9ce3c69bba4..0fcab2c35f0 100644 --- a/test/runtime/src/components/shadow-dom/shadow-dom-basic/readme.md +++ b/test/runtime/src/components/shadow-dom/shadow-dom-basic/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `shadow-dom-basic` + +### Dependencies + +### Used by + + - [shadow-dom-basic-root](.) + +### Graph +```mermaid +graph TD; + shadow-dom-basic-root --> shadow-dom-basic + style shadow-dom-basic fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `shadow-dom-basic-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style shadow-dom-basic-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/shadow-dom/shadow-dom-slot-nested/readme.md b/test/runtime/src/components/shadow-dom/shadow-dom-slot-nested/readme.md index 7c19c9a27c7..e3d5d8b2e10 100644 --- a/test/runtime/src/components/shadow-dom/shadow-dom-slot-nested/readme.md +++ b/test/runtime/src/components/shadow-dom/shadow-dom-slot-nested/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `shadow-dom-slot-nested` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------------------- | ----------- | +| `i` | `i` | | `number \| undefined` | `undefined` | + + +### Dependencies + +### Used by + + - [shadow-dom-slot-nested-root](.) + +### Graph +```mermaid +graph TD; + shadow-dom-slot-nested-root --> shadow-dom-slot-nested + style shadow-dom-slot-nested fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `shadow-dom-slot-nested-root` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style shadow-dom-slot-nested-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/manual-slot-assignment/readme.md b/test/runtime/src/components/slots/manual-slot-assignment/readme.md index 2aa7ea9e248..043abcf6999 100644 --- a/test/runtime/src/components/slots/manual-slot-assignment/readme.md +++ b/test/runtime/src/components/slots/manual-slot-assignment/readme.md @@ -5,12 +5,41 @@ -## Overview +## `manual-slot-filter` + +### Overview + +A filterable list that uses manual slot assignment to show/hide items +based on a filter criteria. + +### Methods + +### `setFilter(filter: string) => Promise` + + + +#### Parameters + +| Name | Type | Description | +| -------- | -------- | ----------- | +| `filter` | `string` | | + +#### Returns + +Type: `Promise` + + + + + +## `manual-slot-tabs` + +### Overview A tabbed container that uses manual slot assignment to dynamically assign tab content to the active slot based on user interaction. -## Methods +### Methods ### `setActiveTab(index: number) => Promise` @@ -29,6 +58,7 @@ Type: `Promise` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/scoped-slot-connectedcallback/readme.md b/test/runtime/src/components/slots/scoped-slot-connectedcallback/readme.md index c7d908e4155..2274960ea52 100644 --- a/test/runtime/src/components/slots/scoped-slot-connectedcallback/readme.md +++ b/test/runtime/src/components/slots/scoped-slot-connectedcallback/readme.md @@ -5,7 +5,46 @@ -## Dependencies +## `scoped-slot-connectedcallback-child` + +### Dependencies + +### Used by + + - [scoped-slot-connectedcallback-middle](.) + +### Graph +```mermaid +graph TD; + scoped-slot-connectedcallback-middle --> scoped-slot-connectedcallback-child + style scoped-slot-connectedcallback-child fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-slot-connectedcallback-middle` + +### Dependencies + +### Used by + + - [scoped-slot-connectedcallback-parent](.) + +### Depends on + +- [scoped-slot-connectedcallback-child](.) + +### Graph +```mermaid +graph TD; + scoped-slot-connectedcallback-middle --> scoped-slot-connectedcallback-child + scoped-slot-connectedcallback-parent --> scoped-slot-connectedcallback-middle + style scoped-slot-connectedcallback-middle fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-slot-connectedcallback-parent` + +### Dependencies ### Depends on @@ -19,6 +58,7 @@ graph TD; style scoped-slot-connectedcallback-parent fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/scoped-slot-in-slot/readme.md b/test/runtime/src/components/slots/scoped-slot-in-slot/readme.md index 7a7c87a5980..3e1ede37926 100644 --- a/test/runtime/src/components/slots/scoped-slot-in-slot/readme.md +++ b/test/runtime/src/components/slots/scoped-slot-in-slot/readme.md @@ -5,7 +5,42 @@ -## Dependencies +## `ion-child` + +### Dependencies + +### Used by + + - [ion-parent](.) + +### Graph +```mermaid +graph TD; + ion-parent --> ion-child + style ion-child fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `ion-host` + +### Dependencies + +### Depends on + +- [ion-parent](.) + +### Graph +```mermaid +graph TD; + ion-host --> ion-parent + ion-parent --> ion-child + style ion-host fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `ion-parent` + +### Dependencies ### Used by @@ -23,6 +58,7 @@ graph TD; style ion-parent fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/scoped-slot-slotchange/readme.md b/test/runtime/src/components/slots/scoped-slot-slotchange/readme.md index 751fe4a783e..7bcf390c5b2 100644 --- a/test/runtime/src/components/slots/scoped-slot-slotchange/readme.md +++ b/test/runtime/src/components/slots/scoped-slot-slotchange/readme.md @@ -5,14 +5,39 @@ -## Properties +## `scoped-slot-slotchange` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------------- | --------- | ----------- | -------------------------------------------- | ------- | +| `slotEventCatch` | -- | | `{ event: Event; assignedNodes: Node[]; }[]` | `[]` | + + +### Dependencies + +### Used by + + - [scoped-slot-slotchange-wrap](.) + +### Graph +```mermaid +graph TD; + scoped-slot-slotchange-wrap --> scoped-slot-slotchange + style scoped-slot-slotchange fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `scoped-slot-slotchange-wrap` + +### Properties | Property | Attribute | Description | Type | Default | | ----------------- | ------------------- | ----------- | --------- | ------- | | `swapSlotContent` | `swap-slot-content` | | `boolean` | `false` | -## Dependencies +### Dependencies ### Depends on @@ -25,6 +50,7 @@ graph TD; style scoped-slot-slotchange-wrap fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-array-complex/readme.md b/test/runtime/src/components/slots/slot-array-complex/readme.md index eca9ae7f03e..915ffa4e756 100644 --- a/test/runtime/src/components/slots/slot-array-complex/readme.md +++ b/test/runtime/src/components/slots/slot-array-complex/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `slot-array-complex` + +### Dependencies + +### Used by + + - [slot-array-complex-root](.) + +### Graph +```mermaid +graph TD; + slot-array-complex-root --> slot-array-complex + style slot-array-complex fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-array-complex-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-array-complex-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-basic-order/readme.md b/test/runtime/src/components/slots/slot-basic-order/readme.md index 921c9fd29bb..e31f07e67c0 100644 --- a/test/runtime/src/components/slots/slot-basic-order/readme.md +++ b/test/runtime/src/components/slots/slot-basic-order/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `slot-basic-order` + +### Dependencies + +### Used by + + - [slot-basic-order-root](.) + +### Graph +```mermaid +graph TD; + slot-basic-order-root --> slot-basic-order + style slot-basic-order fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-basic-order-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-basic-order-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-basic/readme.md b/test/runtime/src/components/slots/slot-basic/readme.md index 8462df3b517..bbb217fb872 100644 --- a/test/runtime/src/components/slots/slot-basic/readme.md +++ b/test/runtime/src/components/slots/slot-basic/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `slot-basic` + +### Dependencies + +### Used by + + - [slot-basic-root](.) + +### Graph +```mermaid +graph TD; + slot-basic-root --> slot-basic + style slot-basic fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-basic-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-basic-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-dynamic-name-change/readme.md b/test/runtime/src/components/slots/slot-dynamic-name-change/readme.md index a3a664845f3..fdd57f3a46b 100644 --- a/test/runtime/src/components/slots/slot-dynamic-name-change/readme.md +++ b/test/runtime/src/components/slots/slot-dynamic-name-change/readme.md @@ -5,13 +5,26 @@ -## Properties +## `slot-dynamic-name-change-scoped` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ---------- | ----------- | ----------- | -------- | ------------ | +| `slotName` | `slot-name` | | `string` | `'greeting'` | + + + +## `slot-dynamic-name-change-shadow` + +### Properties | Property | Attribute | Description | Type | Default | | ---------- | ----------- | ----------- | -------- | ------------ | | `slotName` | `slot-name` | | `string` | `'greeting'` | + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-dynamic-wrapper/readme.md b/test/runtime/src/components/slots/slot-dynamic-wrapper/readme.md index 3639e4ce17f..ab47d4b8772 100644 --- a/test/runtime/src/components/slots/slot-dynamic-wrapper/readme.md +++ b/test/runtime/src/components/slots/slot-dynamic-wrapper/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `slot-dynamic-wrapper` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ----------- | +| `tag` | `tag` | | `string` | `'section'` | + + +### Dependencies + +### Used by + + - [slot-dynamic-wrapper-root](.) + +### Graph +```mermaid +graph TD; + slot-dynamic-wrapper-root --> slot-dynamic-wrapper + style slot-dynamic-wrapper fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-dynamic-wrapper-root` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style slot-dynamic-wrapper-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-fallback-with-forwarded-slot/readme.md b/test/runtime/src/components/slots/slot-fallback-with-forwarded-slot/readme.md index 45ced3257df..8bc76486e38 100644 --- a/test/runtime/src/components/slots/slot-fallback-with-forwarded-slot/readme.md +++ b/test/runtime/src/components/slots/slot-fallback-with-forwarded-slot/readme.md @@ -5,14 +5,39 @@ -## Properties +## `slot-forward-child-fallback` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ----------- | -------- | ----------- | | `label` | `label` | | `string` | `undefined` | -## Dependencies +### Dependencies + +### Used by + + - [slot-forward-root](.) + +### Graph +```mermaid +graph TD; + slot-forward-root --> slot-forward-child-fallback + style slot-forward-child-fallback fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-forward-root` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ----------- | +| `label` | `label` | | `string` | `undefined` | + + +### Dependencies ### Depends on @@ -25,6 +50,7 @@ graph TD; style slot-forward-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-fallback-with-textnode/readme.md b/test/runtime/src/components/slots/slot-fallback-with-textnode/readme.md index 8ff5891114f..5c21dd093bf 100644 --- a/test/runtime/src/components/slots/slot-fallback-with-textnode/readme.md +++ b/test/runtime/src/components/slots/slot-fallback-with-textnode/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `cmp-avatar-textnode` + +### Dependencies + +### Used by + + - [slot-fallback-textnode-root](.) + +### Graph +```mermaid +graph TD; + slot-fallback-textnode-root --> cmp-avatar-textnode + style cmp-avatar-textnode fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-fallback-textnode-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-fallback-textnode-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-fallback/readme.md b/test/runtime/src/components/slots/slot-fallback/readme.md index d1973ecea93..1fd2b834394 100644 --- a/test/runtime/src/components/slots/slot-fallback/readme.md +++ b/test/runtime/src/components/slots/slot-fallback/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `slot-fallback` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ------- | +| `inc` | `inc` | | `number` | `0` | + + +### Dependencies + +### Used by + + - [slot-fallback-root](.) + +### Graph +```mermaid +graph TD; + slot-fallback-root --> slot-fallback + style slot-fallback fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-fallback-root` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style slot-fallback-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-hide-content/readme.md b/test/runtime/src/components/slots/slot-hide-content/readme.md index 5ab6293d12a..b953902c3e6 100644 --- a/test/runtime/src/components/slots/slot-hide-content/readme.md +++ b/test/runtime/src/components/slots/slot-hide-content/readme.md @@ -5,13 +5,26 @@ -## Properties +## `slot-hide-content-open` + +### Properties + +| Property | Attribute | Description | Type | Default | +| --------- | --------- | ----------- | --------- | ------- | +| `enabled` | `enabled` | | `boolean` | `false` | + + + +## `slot-hide-content-scoped` + +### Properties | Property | Attribute | Description | Type | Default | | --------- | --------- | ----------- | --------- | ------- | | `enabled` | `enabled` | | `boolean` | `false` | + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-light-dom/readme.md b/test/runtime/src/components/slots/slot-light-dom/readme.md index d79dd5d1523..00c5fb7884e 100644 --- a/test/runtime/src/components/slots/slot-light-dom/readme.md +++ b/test/runtime/src/components/slots/slot-light-dom/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `slot-light-dom-content` + +### Dependencies + +### Used by + + - [slot-light-dom-root](.) + +### Graph +```mermaid +graph TD; + slot-light-dom-root --> slot-light-dom-content + style slot-light-dom-content fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-light-dom-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-light-dom-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-map-order/readme.md b/test/runtime/src/components/slots/slot-map-order/readme.md index 35805627982..dadeb169280 100644 --- a/test/runtime/src/components/slots/slot-map-order/readme.md +++ b/test/runtime/src/components/slots/slot-map-order/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `slot-map-order` + +### Dependencies + +### Used by + + - [slot-map-order-root](.) + +### Graph +```mermaid +graph TD; + slot-map-order-root --> slot-map-order + style slot-map-order fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-map-order-root` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-map-order-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-nested-default-order/readme.md b/test/runtime/src/components/slots/slot-nested-default-order/readme.md index 7d6fbcda4e1..bb4df38085b 100644 --- a/test/runtime/src/components/slots/slot-nested-default-order/readme.md +++ b/test/runtime/src/components/slots/slot-nested-default-order/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `slot-nested-default-order-child` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------- | ----------- | +| `state` | `state` | | `boolean` | `undefined` | + + +### Dependencies + +### Used by + + - [slot-nested-default-order-parent](.) + +### Graph +```mermaid +graph TD; + slot-nested-default-order-parent --> slot-nested-default-order-child + style slot-nested-default-order-child fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-nested-default-order-parent` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style slot-nested-default-order-parent fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-nested-dynamic/readme.md b/test/runtime/src/components/slots/slot-nested-dynamic/readme.md index 588aa24125a..3c3b2cdc6e5 100644 --- a/test/runtime/src/components/slots/slot-nested-dynamic/readme.md +++ b/test/runtime/src/components/slots/slot-nested-dynamic/readme.md @@ -5,7 +5,47 @@ -## Dependencies +## `slot-nested-dynamic-child` + +### Dependencies + +### Used by + + - [slot-nested-dynamic-parent](.) + +### Depends on + +- [slot-nested-dynamic-wrapper](.) + +### Graph +```mermaid +graph TD; + slot-nested-dynamic-child --> slot-nested-dynamic-wrapper + slot-nested-dynamic-parent --> slot-nested-dynamic-child + style slot-nested-dynamic-child fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-nested-dynamic-parent` + +### Dependencies + +### Depends on + +- [slot-nested-dynamic-child](.) + +### Graph +```mermaid +graph TD; + slot-nested-dynamic-parent --> slot-nested-dynamic-child + slot-nested-dynamic-child --> slot-nested-dynamic-wrapper + style slot-nested-dynamic-parent fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-nested-dynamic-wrapper` + +### Dependencies ### Used by @@ -18,6 +58,7 @@ graph TD; style slot-nested-dynamic-wrapper fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-nested-order/readme.md b/test/runtime/src/components/slots/slot-nested-order/readme.md index 5147f7bd3f3..a946df25441 100644 --- a/test/runtime/src/components/slots/slot-nested-order/readme.md +++ b/test/runtime/src/components/slots/slot-nested-order/readme.md @@ -5,7 +5,25 @@ -## Dependencies +## `slot-nested-order-child` + +### Dependencies + +### Used by + + - [slot-nested-order-parent](.) + +### Graph +```mermaid +graph TD; + slot-nested-order-parent --> slot-nested-order-child + style slot-nested-order-child fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-nested-order-parent` + +### Dependencies ### Depends on @@ -18,6 +36,7 @@ graph TD; style slot-nested-order-parent fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-parent-tag-change/readme.md b/test/runtime/src/components/slots/slot-parent-tag-change/readme.md index 0512e112f34..4a319e7dfd1 100644 --- a/test/runtime/src/components/slots/slot-parent-tag-change/readme.md +++ b/test/runtime/src/components/slots/slot-parent-tag-change/readme.md @@ -5,14 +5,39 @@ -## Properties +## `slot-parent-tag-change` + +### Properties | Property | Attribute | Description | Type | Default | | --------- | --------- | ----------- | -------- | ------- | | `element` | `element` | | `string` | `'p'` | -## Dependencies +### Dependencies + +### Used by + + - [slot-parent-tag-change-root](.) + +### Graph +```mermaid +graph TD; + slot-parent-tag-change-root --> slot-parent-tag-change + style slot-parent-tag-change fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-parent-tag-change-root` + +### Properties + +| Property | Attribute | Description | Type | Default | +| --------- | --------- | ----------- | -------- | ------- | +| `element` | `element` | | `string` | `'p'` | + + +### Dependencies ### Depends on @@ -25,6 +50,7 @@ graph TD; style slot-parent-tag-change-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-reorder/readme.md b/test/runtime/src/components/slots/slot-reorder/readme.md index 8fcd26e8cbd..6766813d350 100644 --- a/test/runtime/src/components/slots/slot-reorder/readme.md +++ b/test/runtime/src/components/slots/slot-reorder/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `slot-reorder` + +### Properties + +| Property | Attribute | Description | Type | Default | +| ----------- | ----------- | ----------- | --------- | ------- | +| `reordered` | `reordered` | | `boolean` | `false` | + + +### Dependencies + +### Used by + + - [slot-reorder-root](.) + +### Graph +```mermaid +graph TD; + slot-reorder-root --> slot-reorder + style slot-reorder fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-reorder-root` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style slot-reorder-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-replace-wrapper/readme.md b/test/runtime/src/components/slots/slot-replace-wrapper/readme.md index 1783ec45e47..a1afe45445e 100644 --- a/test/runtime/src/components/slots/slot-replace-wrapper/readme.md +++ b/test/runtime/src/components/slots/slot-replace-wrapper/readme.md @@ -5,7 +5,32 @@ -## Dependencies +## `slot-replace-wrapper` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | --------------------- | ----------- | +| `href` | `href` | | `string \| undefined` | `undefined` | + + +### Dependencies + +### Used by + + - [slot-replace-wrapper-root](.) + +### Graph +```mermaid +graph TD; + slot-replace-wrapper-root --> slot-replace-wrapper + style slot-replace-wrapper fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-replace-wrapper-root` + +### Dependencies ### Depends on @@ -18,6 +43,7 @@ graph TD; style slot-replace-wrapper-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-scoped-list/readme.md b/test/runtime/src/components/slots/slot-scoped-list/readme.md index b63c1a5831d..e0afed29ca8 100644 --- a/test/runtime/src/components/slots/slot-scoped-list/readme.md +++ b/test/runtime/src/components/slots/slot-scoped-list/readme.md @@ -5,14 +5,60 @@ -## Properties +## `slot-dynamic-scoped-list` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | ---------- | ------- | +| `items` | -- | | `string[]` | `[]` | + + +### Dependencies + +### Used by + + - [slot-list-light-scoped-root](.) + +### Depends on + +- [slot-light-scoped-list](.) + +### Graph +```mermaid +graph TD; + slot-dynamic-scoped-list --> slot-light-scoped-list + slot-list-light-scoped-root --> slot-dynamic-scoped-list + style slot-dynamic-scoped-list fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-light-scoped-list` + +### Dependencies + +### Used by + + - [slot-dynamic-scoped-list](.) + +### Graph +```mermaid +graph TD; + slot-dynamic-scoped-list --> slot-light-scoped-list + style slot-light-scoped-list fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-list-light-scoped-root` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ----------- | ---------- | ------- | | `items` | -- | | `string[]` | `[]` | -## Dependencies +### Dependencies ### Depends on @@ -26,6 +72,7 @@ graph TD; style slot-list-light-scoped-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/slots/slot-shadow-list/readme.md b/test/runtime/src/components/slots/slot-shadow-list/readme.md index f1c165aa0f1..172b6174cc0 100644 --- a/test/runtime/src/components/slots/slot-shadow-list/readme.md +++ b/test/runtime/src/components/slots/slot-shadow-list/readme.md @@ -5,14 +5,60 @@ -## Properties +## `slot-dynamic-shadow-list` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | ---------- | ------- | +| `items` | -- | | `string[]` | `[]` | + + +### Dependencies + +### Used by + + - [slot-list-light-root](.) + +### Depends on + +- [slot-light-list](.) + +### Graph +```mermaid +graph TD; + slot-dynamic-shadow-list --> slot-light-list + slot-list-light-root --> slot-dynamic-shadow-list + style slot-dynamic-shadow-list fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-light-list` + +### Dependencies + +### Used by + + - [slot-dynamic-shadow-list](.) + +### Graph +```mermaid +graph TD; + slot-dynamic-shadow-list --> slot-light-list + style slot-light-list fill:#f9f,stroke:#333,stroke-width:4px +``` + + +## `slot-list-light-root` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | --------- | ----------- | ---------- | ------- | | `items` | -- | | `string[]` | `[]` | -## Dependencies +### Dependencies ### Depends on @@ -26,6 +72,7 @@ graph TD; style slot-list-light-root fill:#f9f,stroke:#333,stroke-width:4px ``` + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* diff --git a/test/runtime/src/components/state/computed-properties-prop-decorator/readme.md b/test/runtime/src/components/state/computed-properties-prop-decorator/readme.md index a31e40fa01d..e78b431bbaa 100644 --- a/test/runtime/src/components/state/computed-properties-prop-decorator/readme.md +++ b/test/runtime/src/components/state/computed-properties-prop-decorator/readme.md @@ -5,7 +5,21 @@ -## Properties +## `computed-properties-prop-decorator` + +### Properties + +| Property | Attribute | Description | Type | Default | +| -------- | --------- | ----------- | -------- | ----------- | +| `first` | `first` | | `string` | `'no'` | +| `last` | `last` | | `string` | `'content'` | +| `middle` | `middle` | | `string` | `''` | + + + +## `computed-properties-prop-decorator-reflect` + +### Properties | Property | Attribute | Description | Type | Default | | -------- | ------------ | ----------- | -------- | ----------- | @@ -14,6 +28,7 @@ | `middle` | `middle` | | `string` | `''` | + ---------------------------------------------- *Built with [StencilJS](https://stenciljs.com/)* From 427e16dafa848dc4780ce7cd54d30498b1c48bfd Mon Sep 17 00:00:00 2001 From: John Jenkins Date: Fri, 29 May 2026 01:17:21 +0100 Subject: [PATCH 2/3] chore: format --- .../core/src/compiler/docs/readme/index.ts | 8 +- .../src/compiler/docs/readme/output-docs.ts | 42 ++++- .../e2e/custom-elements-manifest.json | 2 +- .../build-benchmark/benchmark-results.json | 151 ++++-------------- 4 files changed, 72 insertions(+), 131 deletions(-) diff --git a/packages/core/src/compiler/docs/readme/index.ts b/packages/core/src/compiler/docs/readme/index.ts index 2f562d3f338..1ec2459d3a7 100644 --- a/packages/core/src/compiler/docs/readme/index.ts +++ b/packages/core/src/compiler/docs/readme/index.ts @@ -34,7 +34,13 @@ export const generateReadmeDocs = async ( Array.from(byReadmePath.values()).map((group) => group.length === 1 ? generateReadme(config, compilerCtx, readmeOutputTargets, group[0], docsData.components) - : generateMergedReadme(config, compilerCtx, readmeOutputTargets, group, docsData.components), + : generateMergedReadme( + config, + compilerCtx, + readmeOutputTargets, + group, + docsData.components, + ), ), ); }; diff --git a/packages/core/src/compiler/docs/readme/output-docs.ts b/packages/core/src/compiler/docs/readme/output-docs.ts index 51239e5ae07..1012c93f6b3 100644 --- a/packages/core/src/compiler/docs/readme/output-docs.ts +++ b/packages/core/src/compiler/docs/readme/output-docs.ts @@ -56,7 +56,13 @@ export const generateReadme = async ( ); // CSS Custom Properties preservation is now handled centrally in outputDocs - const readmeContent = generateMarkdown(currentReadmeContent, docsData, cmps, readmeOutput, config); + const readmeContent = generateMarkdown( + currentReadmeContent, + docsData, + cmps, + readmeOutput, + config, + ); const existingContent = await compilerCtx.fs.readFile(readmeOutputPath); if (existingContent?.replace(/\r/g, '') === readmeContent.replace(/\r/g, '')) { @@ -78,8 +84,14 @@ export const generateReadme = async ( * Generate a single README for multiple components that share a directory and * therefore share a single readme.md file. * - * Each component gets an `## \`tag\`` section; existing section headings are + * Each component gets an '## `tag`' section; existing section headings are * shifted from h2 to h3 so they nest correctly under that heading. + * + * @param config a validated Stencil config + * @param compilerCtx the current compiler context + * @param readmeOutputs docs-readme output targets + * @param cmps the components to include in the README (typically components that share a directory) + * @param allCmps metadata for all the components in the project, used to generate dependency lists */ export const generateMergedReadme = async ( config: d.ValidatedConfig, @@ -106,7 +118,13 @@ export const generateMergedReadme = async ( userContent, ); - const readmeContent = generateMergedMarkdown(currentReadmeContent, cmps, allCmps, readmeOutput, config); + const readmeContent = generateMergedMarkdown( + currentReadmeContent, + cmps, + allCmps, + readmeOutput, + config, + ); const existingContent = await compilerCtx.fs.readFile(readmeOutputPath); if (existingContent?.replace(/\r/g, '') === readmeContent.replace(/\r/g, '')) { @@ -175,7 +193,14 @@ export const generateMergedMarkdown = ( ].join('\n'); }; -/** Returns the auto-generated lines for a single component (no header/footer). */ +/** + * Returns the auto-generated lines for a single component (no header/footer). + * @param cmp the component documentation data + * @param cmps all components documentation data + * @param readmeOutput the readme output target config + * @param config the Stencil config + * @returns an array of strings representing the auto-generated lines for the component + */ const generateComponentBody = ( cmp: d.JsonDocsComponent, cmps: d.JsonDocsComponent[], @@ -202,6 +227,12 @@ const generateComponentBody = ( * Resolves the user-written content (above AUTO_GENERATE_COMMENT) to use when * generating a readme, respecting the `overwriteExisting` option and whether * the output dir differs from the source dir. + * @param compilerCtx the current compiler context + * @param readmeOutput the readme output target config + * @param readmeOutputPath the full path to the output readme file + * @param config the Stencil config + * @param userContent the content located above AUTO_GENERATE_COMMENT in the existing readme, or a default template if no existing readme + * @returns the content to use as the "user content" (content above AUTO_GENERATE_COMMENT) for the new readme */ const resolveUserContent = async ( compilerCtx: d.CompilerCtx, @@ -215,7 +246,8 @@ const resolveUserContent = async ( } if (normalizePath(readmeOutput.dir) !== normalizePath(config.srcDir)) { if ( - (readmeOutput.overwriteExisting === 'if-missing' && (await compilerCtx.fs.access(readmeOutputPath))) || + (readmeOutput.overwriteExisting === 'if-missing' && + (await compilerCtx.fs.access(readmeOutputPath))) || (readmeOutput.overwriteExisting ?? false) === false ) { return getUserReadmeContent(compilerCtx, readmeOutputPath); diff --git a/test/integration/e2e/custom-elements-manifest.json b/test/integration/e2e/custom-elements-manifest.json index d3aa2315521..5ea27566ce7 100644 --- a/test/integration/e2e/custom-elements-manifest.json +++ b/test/integration/e2e/custom-elements-manifest.json @@ -2849,4 +2849,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/test/perf/build-benchmark/benchmark-results.json b/test/perf/build-benchmark/benchmark-results.json index 05f6b82f8b4..a8f00e2eec3 100644 --- a/test/perf/build-benchmark/benchmark-results.json +++ b/test/perf/build-benchmark/benchmark-results.json @@ -7,11 +7,7 @@ "arch": "x64", "cold": { "runs": [ - 23421.083687000002, - 23884.050122, - 25321.340081999995, - 25039.486653999993, - 24127.975055000003 + 23421.083687000002, 23884.050122, 25321.340081999995, 25039.486653999993, 24127.975055000003 ], "min": 23421.083687000002, "max": 25321.340081999995, @@ -21,11 +17,7 @@ }, "warm": { "runs": [ - 20331.99189199999, - 20311.053212, - 20945.819419000007, - 19697.669293999992, - 19727.812055999995 + 20331.99189199999, 20311.053212, 20945.819419000007, 19697.669293999992, 19727.812055999995 ], "min": 19697.669293999992, "max": 20945.819419000007, @@ -42,11 +34,7 @@ "arch": "x64", "cold": { "runs": [ - 34351.170047, - 33631.484595, - 33792.84220999999, - 33212.284922000006, - 36396.31289599999 + 34351.170047, 33631.484595, 33792.84220999999, 33212.284922000006, 36396.31289599999 ], "min": 33212.284922000006, "max": 36396.31289599999, @@ -56,10 +44,7 @@ }, "warm": { "runs": [ - 25229.430728999985, - 24570.14856, - 24362.824242000002, - 25592.336630999984, + 25229.430728999985, 24570.14856, 24362.824242000002, 25592.336630999984, 24989.860770999978 ], "min": 24362.824242000002, @@ -77,11 +62,7 @@ "arch": "x64", "cold": { "runs": [ - 41070.203315000006, - 40466.788155999995, - 36355.54683200001, - 36107.316288, - 36471.71495299999 + 41070.203315000006, 40466.788155999995, 36355.54683200001, 36107.316288, 36471.71495299999 ], "min": 36107.316288, "max": 41070.203315000006, @@ -91,10 +72,7 @@ }, "warm": { "runs": [ - 24409.04587500001, - 23895.561968000024, - 24854.688289999962, - 24717.536471, + 24409.04587500001, 23895.561968000024, 24854.688289999962, 24717.536471, 24724.432998000004 ], "min": 23895.561968000024, @@ -112,11 +90,7 @@ "arch": "x64", "cold": { "runs": [ - 34114.5202, - 35607.537745999995, - 35920.99819, - 38205.58783800001, - 38664.109512000025 + 34114.5202, 35607.537745999995, 35920.99819, 38205.58783800001, 38664.109512000025 ], "min": 34114.5202, "max": 38664.109512000025, @@ -126,11 +100,7 @@ }, "warm": { "runs": [ - 27898.99829300001, - 26013.86491600002, - 25837.091231000028, - 26647.193134, - 27039.510117000027 + 27898.99829300001, 26013.86491600002, 25837.091231000028, 26647.193134, 27039.510117000027 ], "min": 25837.091231000028, "max": 27898.99829300001, @@ -147,11 +117,7 @@ "arch": "x64", "cold": { "runs": [ - 39085.46991, - 42408.136897, - 42921.186862999995, - 40101.28373699999, - 37520.62988199998 + 39085.46991, 42408.136897, 42921.186862999995, 40101.28373699999, 37520.62988199998 ], "min": 37520.62988199998, "max": 42921.186862999995, @@ -161,10 +127,7 @@ }, "warm": { "runs": [ - 31742.300088999997, - 32021.184749999957, - 30630.97302199999, - 30063.85729200003, + 31742.300088999997, 32021.184749999957, 30630.97302199999, 30063.85729200003, 30797.36477600003 ], "min": 30063.85729200003, @@ -181,13 +144,7 @@ "platform": "darwin", "arch": "x64", "cold": { - "runs": [ - 40972.065847, - 43680.122187, - 39409.826071, - 39234.818866, - 39924.505492 - ], + "runs": [40972.065847, 43680.122187, 39409.826071, 39234.818866, 39924.505492], "min": 39234.818866, "max": 43680.122187, "avg": 40644.2676926, @@ -196,10 +153,7 @@ }, "warm": { "runs": [ - 31297.078374999983, - 30858.587757, - 29865.421657999977, - 29993.223707999976, + 31297.078374999983, 30858.587757, 29865.421657999977, 29993.223707999976, 29969.610345000052 ], "min": 29865.421657999977, @@ -217,10 +171,7 @@ "arch": "x64", "cold": { "runs": [ - 23269.459319999998, - 25148.249820999998, - 24139.774174000006, - 23181.865806999995, + 23269.459319999998, 25148.249820999998, 24139.774174000006, 23181.865806999995, 24293.64589 ], "min": 23181.865806999995, @@ -231,10 +182,7 @@ }, "warm": { "runs": [ - 15871.201039999985, - 15170.183310000022, - 15762.060900000011, - 16362.84202099999, + 15871.201039999985, 15170.183310000022, 15762.060900000011, 16362.84202099999, 15835.389356 ], "min": 15170.183310000022, @@ -252,10 +200,7 @@ "arch": "x64", "cold": { "runs": [ - 23991.005767000002, - 25526.902739999998, - 25937.340996, - 25899.129243999996, + 23991.005767000002, 25526.902739999998, 25937.340996, 25899.129243999996, 25927.120349999997 ], "min": 23991.005767000002, @@ -266,10 +211,7 @@ }, "warm": { "runs": [ - 19106.065850000014, - 18406.57298300002, - 18004.800843000005, - 17384.010858000023, + 19106.065850000014, 18406.57298300002, 18004.800843000005, 17384.010858000023, 18236.920518 ], "min": 17384.010858000023, @@ -287,11 +229,7 @@ "arch": "x64", "cold": { "runs": [ - 18161.978351, - 19056.576091, - 20401.606789000005, - 19191.509473000006, - 18364.89678299999 + 18161.978351, 19056.576091, 20401.606789000005, 19191.509473000006, 18364.89678299999 ], "min": 18161.978351, "max": 20401.606789000005, @@ -301,10 +239,7 @@ }, "warm": { "runs": [ - 15664.562531999996, - 16320.587922999985, - 15667.609597000002, - 15464.345964999986, + 15664.562531999996, 16320.587922999985, 15667.609597000002, 15464.345964999986, 15542.90580399998 ], "min": 15464.345964999986, @@ -322,11 +257,7 @@ "arch": "x64", "cold": { "runs": [ - 22201.833985999998, - 23948.516979, - 23626.507618999996, - 24845.281126, - 24417.314983000004 + 22201.833985999998, 23948.516979, 23626.507618999996, 24845.281126, 24417.314983000004 ], "min": 22201.833985999998, "max": 24845.281126, @@ -336,10 +267,7 @@ }, "warm": { "runs": [ - 22082.074709999986, - 21207.868811000022, - 22056.905397000024, - 20727.638967000006, + 22082.074709999986, 21207.868811000022, 22056.905397000024, 20727.638967000006, 20331.37961100001 ], "min": 20331.37961100001, @@ -356,13 +284,7 @@ "platform": "darwin", "arch": "x64", "cold": { - "runs": [ - 21577.937547, - 22903.280945000002, - 24116.355673, - 26190.01642, - 25381.22183200001 - ], + "runs": [21577.937547, 22903.280945000002, 24116.355673, 26190.01642, 25381.22183200001], "min": 21577.937547, "max": 26190.01642, "avg": 24033.7624834, @@ -371,10 +293,7 @@ }, "warm": { "runs": [ - 20118.486140999972, - 18990.438446999993, - 20025.83328000002, - 20014.39137899998, + 20118.486140999972, 18990.438446999993, 20025.83328000002, 20014.39137899998, 19337.564650000015 ], "min": 18990.438446999993, @@ -391,13 +310,7 @@ "platform": "darwin", "arch": "x64", "cold": { - "runs": [ - 20892.681958999998, - 23505.49664, - 22801.728985, - 22364.80433, - 23421.913166 - ], + "runs": [20892.681958999998, 23505.49664, 22801.728985, 22364.80433, 23421.913166], "min": 20892.681958999998, "max": 23505.49664, "avg": 22597.325016, @@ -406,11 +319,7 @@ }, "warm": { "runs": [ - 19698.374725, - 18679.153068999993, - 19107.783211, - 19357.10183500001, - 19292.62691000002 + 19698.374725, 18679.153068999993, 19107.783211, 19357.10183500001, 19292.62691000002 ], "min": 18679.153068999993, "max": 19698.374725, @@ -427,10 +336,7 @@ "arch": "x64", "cold": { "runs": [ - 23421.083687000002, - 23884.050122, - 25321.340081999995, - 25039.486653999993, + 23421.083687000002, 23884.050122, 25321.340081999995, 25039.486653999993, 24127.975055000003 ], "min": 23421.083687000002, @@ -441,10 +347,7 @@ }, "warm": { "runs": [ - 20331.99189199999, - 20311.053212, - 20945.819419000007, - 19697.669293999992, + 20331.99189199999, 20311.053212, 20945.819419000007, 19697.669293999992, 19727.812055999995 ], "min": 19697.669293999992, @@ -455,4 +358,4 @@ } } ] -} \ No newline at end of file +} From b86f649dc303213663c0f025f076092749d31c35 Mon Sep 17 00:00:00 2001 From: John Jenkins Date: Fri, 29 May 2026 10:07:17 +0100 Subject: [PATCH 3/3] chore: --- packages/core/src/compiler/docs/readme/output-docs.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/core/src/compiler/docs/readme/output-docs.ts b/packages/core/src/compiler/docs/readme/output-docs.ts index 1012c93f6b3..17e1713dc91 100644 --- a/packages/core/src/compiler/docs/readme/output-docs.ts +++ b/packages/core/src/compiler/docs/readme/output-docs.ts @@ -163,7 +163,7 @@ export const generateMarkdown = ( ].join('\n'); }; -export const generateMergedMarkdown = ( +const generateMergedMarkdown = ( userContent: string | undefined, cmps: d.JsonDocsComponent[], allCmps: d.JsonDocsComponent[],