Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(framework-integrations): add note about consuming custom elements #1338

Merged
merged 5 commits into from
Jan 30, 2024
Merged

docs(framework-integrations): add note about consuming custom elements #1338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3189e8a
docs(framework-integrations): add note about consuming custom elements
tanner-reits Jan 29, 2024
116ca88
propagate to rest of v4 react
tanner-reits Jan 30, 2024
7458145
propagate to rest of v4 vue
tanner-reits Jan 30, 2024
f6a3309
propagate to rest of v4 angular
tanner-reits Jan 30, 2024
bdc6e21
Merge branch 'main' into docs/framework-wrappers-custom-elements
tanner-reits Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions docs/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.0/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.0/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.1/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.1/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.10/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.10/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.10/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.11/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.11/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.11/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.12/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.12/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.12/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.2/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.2/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.2/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.3/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.3/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.3/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.4/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.4/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.4/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.5/framework-integration/angular.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.5/framework-integration/react.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
5 changes: 5 additions & 0 deletions versioned_docs/version-v4.5/framework-integration/vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
Loading