From 3189e8a2f6d47d67a5aee250262bbd1ea7a81614 Mon Sep 17 00:00:00 2001 From: Tanner Reits Date: Mon, 29 Jan 2024 16:13:52 -0500 Subject: [PATCH 1/4] docs(framework-integrations): add note about consuming custom elements STENCIL-1092 --- docs/framework-integration/angular.md | 6 ++++++ docs/framework-integration/react.md | 5 +++++ docs/framework-integration/vue.md | 5 +++++ 3 files changed, 16 insertions(+) diff --git a/docs/framework-integration/angular.md b/docs/framework-integration/angular.md index f6657b360..e63721bc2 100644 --- a/docs/framework-integration/angular.md +++ b/docs/framework-integration/angular.md @@ -594,6 +594,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/docs/framework-integration/react.md b/docs/framework-integration/react.md index 2c0603186..973272942 100644 --- a/docs/framework-integration/react.md +++ b/docs/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/docs/framework-integration/vue.md b/docs/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/docs/framework-integration/vue.md +++ b/docs/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** From 116ca88861e127af4d84e5f6dcb2296cadd9afc9 Mon Sep 17 00:00:00 2001 From: Tanner Reits Date: Tue, 30 Jan 2024 13:13:22 -0500 Subject: [PATCH 2/4] propagate to rest of v4 react --- versioned_docs/version-v4.0/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.1/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.10/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.11/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.12/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.2/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.3/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.4/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.5/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.6/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.7/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.8/framework-integration/react.md | 5 +++++ versioned_docs/version-v4.9/framework-integration/react.md | 5 +++++ 13 files changed, 65 insertions(+) diff --git a/versioned_docs/version-v4.0/framework-integration/react.md b/versioned_docs/version-v4.0/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.0/framework-integration/react.md +++ b/versioned_docs/version-v4.0/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.1/framework-integration/react.md b/versioned_docs/version-v4.1/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.1/framework-integration/react.md +++ b/versioned_docs/version-v4.1/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.10/framework-integration/react.md b/versioned_docs/version-v4.10/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.10/framework-integration/react.md +++ b/versioned_docs/version-v4.10/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.11/framework-integration/react.md b/versioned_docs/version-v4.11/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.11/framework-integration/react.md +++ b/versioned_docs/version-v4.11/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.12/framework-integration/react.md b/versioned_docs/version-v4.12/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.12/framework-integration/react.md +++ b/versioned_docs/version-v4.12/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.2/framework-integration/react.md b/versioned_docs/version-v4.2/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.2/framework-integration/react.md +++ b/versioned_docs/version-v4.2/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.3/framework-integration/react.md b/versioned_docs/version-v4.3/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.3/framework-integration/react.md +++ b/versioned_docs/version-v4.3/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.4/framework-integration/react.md b/versioned_docs/version-v4.4/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.4/framework-integration/react.md +++ b/versioned_docs/version-v4.4/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.5/framework-integration/react.md b/versioned_docs/version-v4.5/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.5/framework-integration/react.md +++ b/versioned_docs/version-v4.5/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.6/framework-integration/react.md b/versioned_docs/version-v4.6/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.6/framework-integration/react.md +++ b/versioned_docs/version-v4.6/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.7/framework-integration/react.md b/versioned_docs/version-v4.7/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.7/framework-integration/react.md +++ b/versioned_docs/version-v4.7/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.8/framework-integration/react.md b/versioned_docs/version-v4.8/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.8/framework-integration/react.md +++ b/versioned_docs/version-v4.8/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.9/framework-integration/react.md b/versioned_docs/version-v4.9/framework-integration/react.md index 2c0603186..973272942 100644 --- a/versioned_docs/version-v4.9/framework-integration/react.md +++ b/versioned_docs/version-v4.9/framework-integration/react.md @@ -427,6 +427,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements](../output-targets/custom-elements.md) output and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** From 745814558fe51435312933eed4d5bee85062fdcb Mon Sep 17 00:00:00 2001 From: Tanner Reits Date: Tue, 30 Jan 2024 13:17:24 -0500 Subject: [PATCH 3/4] propagate to rest of v4 vue --- versioned_docs/version-v4.0/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.1/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.10/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.11/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.12/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.2/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.3/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.4/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.5/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.6/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.7/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.8/framework-integration/vue.md | 5 +++++ versioned_docs/version-v4.9/framework-integration/vue.md | 5 +++++ 13 files changed, 65 insertions(+) diff --git a/versioned_docs/version-v4.0/framework-integration/vue.md b/versioned_docs/version-v4.0/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.0/framework-integration/vue.md +++ b/versioned_docs/version-v4.0/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.1/framework-integration/vue.md b/versioned_docs/version-v4.1/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.1/framework-integration/vue.md +++ b/versioned_docs/version-v4.1/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.10/framework-integration/vue.md b/versioned_docs/version-v4.10/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.10/framework-integration/vue.md +++ b/versioned_docs/version-v4.10/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.11/framework-integration/vue.md b/versioned_docs/version-v4.11/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.11/framework-integration/vue.md +++ b/versioned_docs/version-v4.11/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.12/framework-integration/vue.md b/versioned_docs/version-v4.12/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.12/framework-integration/vue.md +++ b/versioned_docs/version-v4.12/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.2/framework-integration/vue.md b/versioned_docs/version-v4.2/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.2/framework-integration/vue.md +++ b/versioned_docs/version-v4.2/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.3/framework-integration/vue.md b/versioned_docs/version-v4.3/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.3/framework-integration/vue.md +++ b/versioned_docs/version-v4.3/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.4/framework-integration/vue.md b/versioned_docs/version-v4.4/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.4/framework-integration/vue.md +++ b/versioned_docs/version-v4.4/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.5/framework-integration/vue.md b/versioned_docs/version-v4.5/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.5/framework-integration/vue.md +++ b/versioned_docs/version-v4.5/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.6/framework-integration/vue.md b/versioned_docs/version-v4.6/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.6/framework-integration/vue.md +++ b/versioned_docs/version-v4.6/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.7/framework-integration/vue.md b/versioned_docs/version-v4.7/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.7/framework-integration/vue.md +++ b/versioned_docs/version-v4.7/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.8/framework-integration/vue.md b/versioned_docs/version-v4.8/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.8/framework-integration/vue.md +++ b/versioned_docs/version-v4.8/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** diff --git a/versioned_docs/version-v4.9/framework-integration/vue.md b/versioned_docs/version-v4.9/framework-integration/vue.md index 6b4e3cb2b..143a858a8 100644 --- a/versioned_docs/version-v4.9/framework-integration/vue.md +++ b/versioned_docs/version-v4.9/framework-integration/vue.md @@ -470,6 +470,11 @@ If `true`, all Web Components will automatically be registered with the Custom E If `true`, the output target will import the custom element instance and register it with the Custom Elements Registry when the component is imported inside of a user's app. This can only be used with the [Custom Elements Bundle](../output-targets/custom-elements.md) and will not work with lazy loaded components. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly. +::: + ### includePolyfills **Optional** From f6a33097455a14246a3e980b005c2bbbff7d8e52 Mon Sep 17 00:00:00 2001 From: Tanner Reits Date: Tue, 30 Jan 2024 13:23:49 -0500 Subject: [PATCH 4/4] propagate to rest of v4 angular --- .../version-v4.10/framework-integration/angular.md | 6 ++++++ .../version-v4.11/framework-integration/angular.md | 6 ++++++ .../version-v4.12/framework-integration/angular.md | 6 ++++++ .../version-v4.2/framework-integration/angular.md | 6 ++++++ .../version-v4.3/framework-integration/angular.md | 6 ++++++ .../version-v4.4/framework-integration/angular.md | 6 ++++++ .../version-v4.5/framework-integration/angular.md | 6 ++++++ .../version-v4.6/framework-integration/angular.md | 6 ++++++ .../version-v4.7/framework-integration/angular.md | 6 ++++++ .../version-v4.8/framework-integration/angular.md | 6 ++++++ .../version-v4.9/framework-integration/angular.md | 6 ++++++ 11 files changed, 66 insertions(+) diff --git a/versioned_docs/version-v4.10/framework-integration/angular.md b/versioned_docs/version-v4.10/framework-integration/angular.md index f6657b360..e63721bc2 100644 --- a/versioned_docs/version-v4.10/framework-integration/angular.md +++ b/versioned_docs/version-v4.10/framework-integration/angular.md @@ -594,6 +594,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.11/framework-integration/angular.md b/versioned_docs/version-v4.11/framework-integration/angular.md index f6657b360..e63721bc2 100644 --- a/versioned_docs/version-v4.11/framework-integration/angular.md +++ b/versioned_docs/version-v4.11/framework-integration/angular.md @@ -594,6 +594,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.12/framework-integration/angular.md b/versioned_docs/version-v4.12/framework-integration/angular.md index f6657b360..e63721bc2 100644 --- a/versioned_docs/version-v4.12/framework-integration/angular.md +++ b/versioned_docs/version-v4.12/framework-integration/angular.md @@ -594,6 +594,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.2/framework-integration/angular.md b/versioned_docs/version-v4.2/framework-integration/angular.md index 380a557a5..aeddacc19 100644 --- a/versioned_docs/version-v4.2/framework-integration/angular.md +++ b/versioned_docs/version-v4.2/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.3/framework-integration/angular.md b/versioned_docs/version-v4.3/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.3/framework-integration/angular.md +++ b/versioned_docs/version-v4.3/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.4/framework-integration/angular.md b/versioned_docs/version-v4.4/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.4/framework-integration/angular.md +++ b/versioned_docs/version-v4.4/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.5/framework-integration/angular.md b/versioned_docs/version-v4.5/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.5/framework-integration/angular.md +++ b/versioned_docs/version-v4.5/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.6/framework-integration/angular.md b/versioned_docs/version-v4.6/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.6/framework-integration/angular.md +++ b/versioned_docs/version-v4.6/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.7/framework-integration/angular.md b/versioned_docs/version-v4.7/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.7/framework-integration/angular.md +++ b/versioned_docs/version-v4.7/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.8/framework-integration/angular.md b/versioned_docs/version-v4.8/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.8/framework-integration/angular.md +++ b/versioned_docs/version-v4.8/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs diff --git a/versioned_docs/version-v4.9/framework-integration/angular.md b/versioned_docs/version-v4.9/framework-integration/angular.md index 0b6474c01..b4da9f6a6 100644 --- a/versioned_docs/version-v4.9/framework-integration/angular.md +++ b/versioned_docs/version-v4.9/framework-integration/angular.md @@ -417,6 +417,12 @@ Specifies the type of output to be generated. It can take one of the following v Both `scam` and `standalone` options are compatible with the `dist-custom-elements` output. +:::note +The configuration for the [Custom Elements](../output-targets/custom-elements.md) output target must set the +[export behavior](../output-targets/custom-elements.md#customelementsexportbehavior) to `single-export-module` for the wrappers to generate correctly +if using the `scam` or `standalone` output type. +::: + Note: Please choose the appropriate `outputType` based on your project's requirements and the desired output structure. ### valueAccessorConfigs