Skip to content

docs(config): remove deprecated extras options #1129

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

Merged
tanner-reits merged 3 commits into from
May 30, 2023
Merged

docs(config): remove deprecated extras options #1129

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93ef73b
docs(config): remove deprecated `extras` options
May 24, 2023
7dfce72
revert removal of shadowDomShim
May 30, 2023
f5f84da
Merge branch 'main' into treits/remove-deprecated-extras
tanner-reits May 30, 2023
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
48 changes: 0 additions & 48 deletions docs/config/extras.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,7 @@ Example `extras` config when **supporting** legacy browsers:
export const config: Config = {
buildEs5: 'prod',
extras: {
__deprecated__cssVarsShim: true,
__deprecated__dynamicImportShim: true,
__deprecated__shadowDomShim: true,
__deprecated__safari10: true,
scriptDataOpts: true,
appendChildSlotFix: false,
cloneNodeFix: false,
Expand All @@ -53,39 +50,6 @@ By default, the slot polyfill does not update `appendChild()` so that it appends

By default, the runtime does not polyfill `cloneNode()` when cloning a component that uses the slot polyfill. This is an opt-in polyfill for those who need it.

### `__deprecated__cssVarsShim`

Include the CSS Custom Property polyfill/shim for legacy browsers.

A result of this being set to `false` is that you will need to manually provide
"fallback" properties to legacy builds. For example, in the css below, the css
variable will not be polyfilled for IE11, so the developer will manually need
to provide a fallback just before the css variable. If the app does not need to
support IE11 it's recommended to leave `__deprecated__cssVarsShim` set to the
default value of `false`.

```css
div {
color: blue; /* Used by IE */
color: var(--color); /* Used by modern browsers */
}
```

As of Stencil v3.0.0, support for IE 11, Edge <= 18, and Safari 10 has begun to
reach end-of-life. While this flag and its supporting functionality is
currently available, it will be removed in a future version of Stencil.

### `__deprecated__dynamicImportShim`

Dynamic `import()` shim. This is only needed for Edge 18 and below, and Firefox
67 and below. If you do not need to support Edge 18 and below (Edge before it
moved to Chromium) then it's recommended to set `dynamicImportShim` to `false`.
Defaults to `false`.

As of Stencil v3.0.0, support for IE 11, Edge <= 18, and Safari 10 has begun to
reach end-of-life. While this flag and its supporting functionality is
currently available, it will be removed in a future version of Stencil.

### experimentalImportInjection

:::caution
Expand Down Expand Up @@ -141,18 +105,6 @@ Dispatches component lifecycle events. By default these events are not dispatche
| `stencil_componentDidUpdate` | Dispatched for each component's `componentDidUpdate`. |
| `stencil_componentDidRender` | Dispatched for each component's `componentDidRender`. |

### `__deprecated__safari10`

Safari 10 supports ES modules with `<script type="module">`, however, it did
not implement `<script nomodule>`. When `__deprecated__safari10` is set to
`true`, the runtime will patch support for Safari 10. If your app does not need
to support Safari 10, it's recommended to leave this set to its default value
of `false`.

As of Stencil v3.0.0, support Safari 10 has begun to reach end-of-life. While
this flag and its supporting functionality is currently available, it will be
removed in a future version of Stencil.

### scopedSlotTextContentFix

An experimental flag that when set to `true`, aligns the behavior of invoking the `textContent` getter/setter on a scoped component to act more like a component that uses the shadow DOM. Specifically, invoking `textContent` on a component will adhere to the return values described in [MDN's article on textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#description). Defaults to `false`.
Expand Down