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(v3-upgrade): add note about deprecating cssVarsShim #950

Merged
merged 2 commits into from
Dec 16, 2022
Merged

docs(v3-upgrade): add note about deprecating cssVarsShim #950

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
785fc3a
docs(v3-upgrade): add note about deprecating `cssVarsShim`
alicewriteswrongs Dec 13, 2022
50cc9b7
change wording
alicewriteswrongs Dec 14, 2022
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
18 changes: 18 additions & 0 deletions src/docs/introduction/upgrading-to-stencil-three.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,24 @@ export const config: Config = {
};
```

#### `cssVarShim`

`extras.cssVarShim` causes Stencil to include a polyfill for [CSS
variables](https://developer.mozilla.org/en-US/docs/Web/CSS/--*). For Stencil
v3.0.0 this field is renamed to `__deprecated__cssVarsShim`. To retain the
previous behavior the new option can be set in your project's
`stencil.config.ts`:

```ts
// stencil.config.ts
import { Config } from '@stencil/core';
export const config: Config = {
extras: {
__deprecated__cssVarsShim: true
}
};
```

### Deprecated `assetsDir` Removed from `@Component()` decorator
The `assetsDir` field was [deprecated in Stencil v2.0.0](https://github.com/ionic-team/stencil/blob/main/BREAKING_CHANGES.md#componentassetsdir), but some backwards compatibility was retained with a warning message.
It has been fully removed in Stencil v3.0.0 in favor of `assetsDirs`.
Expand Down