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.

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

Emotion 11 post #2089

Merged
merged 6 commits into from Nov 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 0 additions & 5 deletions .changeset/angry-rats-type.md

This file was deleted.

4 changes: 3 additions & 1 deletion .changeset/four-cars-tell.md
Expand Up @@ -3,9 +3,11 @@
'@emotion/styled': major
---

Reworked TypeScript definitions so it's easier to provide a type for Theme. Instead of creating custom instances (like before) you can augment builtin Theme interface like this:
It's now easier to provide a type for `Theme`. Instead of creating custom instances (like before) you can augment the builtin `Theme` interface like this:

```ts
import '@emotion/react'

declare module '@emotion/react' {
export interface Theme {
primaryColor: string
Expand Down
2 changes: 1 addition & 1 deletion .changeset/gorgeous-steaks-report.md
Expand Up @@ -3,4 +3,4 @@
'@emotion/sheet': minor
---

Accept new `prepend` option to allow for adding style tags at the beginning of the specified DOM container.
The new `prepend` option can make Emotion add style tags at the beginning of the specified DOM container instead of the end.
30 changes: 8 additions & 22 deletions .changeset/long-apes-admire.md
Expand Up @@ -3,27 +3,13 @@
'@emotion/styled': major
---

TypeScript types have been restructured. These changes:
TypeScript types have been significantly restructured. These changes:

- Reduce build times when using emotion
- In many cases remove the need for manually specifying generic parameters for your emotion components.
- reduce build times when using Emotion, especially in larger projects
- it's no longer necessary to manually specify generic parameters for your Emotion components in many cases
- union types as props are better supported and should be inferred properly
- the `css` function has been restricted to prevent passing invalid types
- `styled`'s generic parameter has been changed, if you were specifying the `ComponentType` you will need to remove that generic parameter
- `styled` no longer takes a second `ExtraProps` parameter - instead of that move it to after the `styled` call. So instead of writing `styled<typeof MyComponent, ExtraProps>(MyComponent)({})` you should now be writing `styled(MyComponent)<ExtraProps>({})`

If you encounter build issues after upgrade, try removing any manually specified generic types and let them be inferred. Otherwise refer to the breaking changes list below.

## Improvements

- Union types as props are better supported and should be inferred properly
- Build times should be reduced significantly in larger projects.

## Breaking changes

- `withTheme` can now have the Theme type specified when calling it. For example `withTheme<MyTheme>(MyComponent)`

**Breaking change:** Generic argument changed, if you were specifying the ComponentType you will need to remove the generic parameter. Recommend following example setup in the TypeScript docs under theming section

- `css` function has been restricted to prevent passing of invalid types
- `CreateStyled` functions no longer take a second `ExtraProps` argument. Instead move it to after the create styled call. For example

`styled<typeof MyComponent, ExtraProps>(MyComponent)({})`
to
`styled(MyComponent)<ExtraProps>({})`
If you encounter build issues after upgrade, try removing any manually specified generic types and let them be inferred.
10 changes: 7 additions & 3 deletions .changeset/moody-ravens-deny.md
Expand Up @@ -2,12 +2,16 @@
'@emotion/react': patch
---

The way in which we provide TypeScript support for `css` prop has changed. Based on usage of our jsx pragma we are able to add support for `css` prop only for components that support `className` prop (as our `jsx` factory function takes provided `css` prop, resolves it and pass the generated `className` to the rendered component). This has been implemented using technique described [here](https://www.typescriptlang.org/docs/handbook/jsx.html#factory-functions). What is important - we no longer extend any global interfaces, so people shouldn't bump anymore into type conflicts for the `css` prop when using different libraries with the `css` prop support, such as `styled-components`.
The way in which we provide TypeScript support for the `css` prop has changed. Based on the usage of our JSX factories, we can add support for `css` prop only for components that support `className` prop (as our JSX factory functions take the provided `css` prop, resolve it and pass the generated `className` to the rendered component).

However, it's not possible to leverage `css` prop support being added conditionally based on a type of rendered component when one is not using our jsx pragma. For those cases when people use our pragma implicitly (for example when using our `@emotion/babel-preset-css-prop`) we have added special file that can be imported once to add support for the `css` prop globally, for all components. Use it like this:
For the classic runtime this has been implemented using technique described [here](https://www.typescriptlang.org/docs/handbook/jsx.html#factory-functions). What is important - we no longer extend any global interfaces, so people shouldn't bump anymore into type conflicts for the `css` prop when using different libraries with `css` prop support, such as `styled-components`.

For the automatic runtime this has been implemented by exporting `JSX` namespace from the appropriate entries but this is only supported in **TypeScript 4.1 or higher**.

However, if you are stuck with older version of TypeScript or using the classic runtime implicitly by using our `@emotion/babel-preset-css-prop` then it's not possible to leverage leverage `css` prop support being added conditionally based on a type of rendered component. For those cases we have added a special file that can be imported once to add support for the `css` prop globally, for all components. Use it like this:

```ts
import {} from '@emotion/react/types/css-prop'
/// <reference types="@emotion/react/types/css-prop" />
```

In this particular case we are forced to extend the existing `React.Attributes` interface. Previously we've been extending both `React.DOMAttributes<T>` and `JSX.IntrinsicAttributes`. This change is really minor and shouldn't affect any consuming code.
2 changes: 1 addition & 1 deletion .changeset/sweet-hotels-return.md
Expand Up @@ -2,4 +2,4 @@
'@emotion/css': major
---

From now on `key` option is required when creating a custom instance. Please make sure it's unique (and not equal to `"css"`) as it's used for linking styles to your cache. If multiple caches share the same key they might "fight" for each other's style elements.
The `key` option is now required when creating a custom instance of a cache. Please make sure it's unique (and not equal to `'css'`) as it's used for linking styles to your cache. If multiple caches share the same key they might "fight" for each other's style elements.
4 changes: 2 additions & 2 deletions .changeset/warm-ties-drop.md
Expand Up @@ -7,9 +7,9 @@

The parser we use ([Stylis](https://github.com/thysultan/stylis.js)) got upgraded. It fixes some long-standing parsing edge cases while being smaller and faster 🚀

It has been completely rewritten and comes with some breaking changes. Most notable ones that might affect Emotion users are:
It has been completely rewritten and comes with some breaking changes. The most notable ones that might affect Emotion users are:

- plugins written for the former Stylis v3 are not compatible with the new version. To learn more on how to write a plugin for Stylis v4 you can check out its [README](https://github.com/thysultan/stylis.js#middleware) and the source code of core plugins.
- vendor-prefixing was previously customizable using `prefix` option. This was always limited to turning off all of some of the prefixes as all available prefixes were on by default. The `prefix` option is gone and to customize which prefixes are applied you need to fork (copy-paste) the prefixer plugin and adjust it to your needs. While this being somewhat more problematic to setup at first we believe that the vast majority of users were not customizing this anyway. By not including the possibility to customize this through an extra option the final solution is more performant because there is no extra overhead of checking if a particular property should be prefixed or not.
- Prefixer is now just a plugin which happens to be put in default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`. You can import `prefixer` from the `stylis` module to do that.
- the prefixer is now just a plugin which happens to be included in the default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`. You can import `prefixer` from the `stylis` module to do that.
- `@import` rules are no longer special-cased. The responsibility to put them first has been moved to the author of the styles. They also can't be nested within other rules now. It's only possible to write them at the top level of global styles.
6 changes: 5 additions & 1 deletion docs/docs.yaml
Expand Up @@ -20,7 +20,6 @@
- labels
- class-names
- cache-provider
- migrating-to-emotion-10
#- benchmarks

- title: Tooling
Expand All @@ -46,3 +45,8 @@
- '@emotion/native'
- '@emotion/primitives'
- '@emotion/babel-preset-css-prop'

- title: Posts
items:
- emotion-11
- migrating-to-emotion-10
108 changes: 108 additions & 0 deletions docs/emotion-11.mdx
@@ -0,0 +1,108 @@
---
title: 'Emotion 11'
---

Emotion 11 is a slight evolution over the Emotion 10. It focuses mainly on the developer experience, TS types improvements, switches internals to hooks and to the new version of the parser that we use: [Stylis](https://github.com/thysultan/stylis.js).

# Package renaming

One of the most significant changes is that most of the user-facing packages have been renamed:
- `@emotion/core` → `@emotion/react`
- `emotion` → `@emotion/css`
- `emotion-theming` → moved into ` @emotion/react`
- `emotion-server` → `@emotion/server`
- `create-emotion` → `@emotion/css/create-instance`
- `create-emotion-server` → `@emotion/server/create-instance`
- `babel-plugin-emotion` → `@emotion/babel-plugin`
- `eslint-plugin-emotion` → `@emotion/eslint-plugin`
- `jest-emotion` → `@emotion/jest`

Most of this renaming can be done automatically via a codemod by running the `@emotion/pkg-renaming` rule from `@emotion/eslint-plugin` with `--fix` over your codebase.

# Hooks

Use hooks internally for improved bundle size and a better tree in React DevTools 🎉.

# TypeScript

## Types overhaul

TypeScript types have been significantly restructured.

- reduce build times when using Emotion, especially in larger projects
- it's no longer necessary to manually specify generic parameters for your Emotion components in many cases
- union types as props are better supported and should be inferred properly
- the `css` function has been restricted to prevent passing invalid types
- `styled`'s generic parameter has been changed, if you were specifying the `ComponentType` you will need to remove that generic parameter
- `styled` no longer takes a second `ExtraProps` parameter - instead of that move it to after the `styled` call. So instead of writing `styled<typeof MyComponent, ExtraProps>(MyComponent)({})` you should now be writing `styled(MyComponent)<ExtraProps>({})`

If you encounter build issues after upgrade, try removing any manually specified generic types and let them be inferred.

## Theme type

It's now easier to provide a type for `Theme`. Instead of creating custom instances (like before) you can augment the builtin `Theme` interface like this:

```ts
import '@emotion/react'

declare module '@emotion/react' {
export interface Theme {
primaryColor: string
secondaryColor: string
}
}
```

## css prop types

The way in which we provide TypeScript support for the `css` prop has changed. Based on the usage of our JSX factories, we can add support for `css` prop only for components that support `className` prop (as our JSX factory functions take the provided `css` prop, resolve it and pass the generated `className` to the rendered component).

For the classic runtime this has been implemented using technique described [here](https://www.typescriptlang.org/docs/handbook/jsx.html#factory-functions). What is important - we no longer extend any global interfaces, so people shouldn't bump anymore into type conflicts for the `css` prop when using different libraries with `css` prop support, such as `styled-components`.

For the automatic runtime this has been implemented by exporting `JSX` namespace from the appropriate entries but this is only supported in **TypeScript 4.1 or higher**.

However, if you are stuck with older version of TypeScript or using the classic runtime implicitly by using our `@emotion/babel-preset-css-prop` then it's not possible to leverage leverage `css` prop support being added conditionally based on a type of rendered component. For those cases we have added a special file that can be imported once to add support for the `css` prop globally, for all components. Use it like this:

```ts
/// <reference types="@emotion/react/types/css-prop" />
```

In this particular case we are forced to extend the existing `React.Attributes` interface. Previously we've been extending both `React.DOMAttributes` and `JSX.IntrinsicAttributes`. This change is really minor and shouldn't affect any consuming code.

# Stylis v4

The parser we use ([Stylis](https://github.com/thysultan/stylis.js)) got upgraded. It fixes some long-standing parsing edge cases while being smaller and faster 🚀

It has been completely rewritten and comes with some breaking changes. The most notable ones that might affect Emotion users are:

- plugins written for the former Stylis v3 are not compatible with the new version. To learn more on how to write a plugin for Stylis v4 you can check out its [README](https://github.com/thysultan/stylis.js#middleware) and the source code of core plugins.
- vendor-prefixing was previously customizable using `prefix` option. This was always limited to turning off all of some of the prefixes as all available prefixes were on by default. The `prefix` option is gone and to customize which prefixes are applied you need to fork (copy-paste) the prefixer plugin and adjust it to your needs. While this being somewhat more problematic to setup at first we believe that the vast majority of users were not customizing this anyway. By not including the possibility to customize this through an extra option the final solution is more performant because there is no extra overhead of checking if a particular property should be prefixed or not.
- the prefixer is now just a plugin which happens to be included in the default `stylisPlugins`. If you plan to use custom `stylisPlugins` and you want to have your styles prefixed automatically you must include prefixer in your custom `stylisPlugins`. You can import `prefixer` from the `stylis` module to do that.
- `@import` rules are no longer special-cased. The responsibility to put them first has been moved to the author of the styles. They also can't be nested within other rules now. It's only possible to write them at the top level of global styles.

# Emotion's caches

The `key` option is now required when creating a custom instance of a cache. Please make sure it's unique (and not equal to `'css'`) as it's used for linking styles to your cache. If multiple caches share the same key they might "fight" for each other's style elements.

The new `prepend` option can make Emotion add style tags at the beginning of the specified DOM container instead of the end.

# Other

There are a lot of less substantial changes than what has been described here, some of them might even be breaking changes but are not relevant to the majority of users. Therefore to learn more about all of the changes please read through the full list of changes contained in the respective changelogs:

[`@emotion/babel-plugin`](https://github.com/emotion-js/emotion/blob/master/packages/babel-plugin/CHANGELOG.md#1100)
[`@emotion/babel-preset-css-prop`](https://github.com/emotion-js/emotion/blob/master/packages/babel-preset-css-prop/CHANGELOG.md#1100)
[`@emotion/cache`](https://github.com/emotion-js/emotion/blob/master/packages/cache/CHANGELOG.md#1100)
[`@emotion/css`](https://github.com/emotion-js/emotion/blob/master/packages/css/CHANGELOG.md#1100)
[`@emotion/eslint-plugin`](https://github.com/emotion-js/emotion/blob/master/packages/eslint-plugin/CHANGELOG.md#1100)
[`@emotion/is-prop-valid`](https://github.com/emotion-js/emotion/blob/master/packages/is-prop-valid/CHANGELOG.md#100)
[`@emotion/jest`](https://github.com/emotion-js/emotion/blob/master/packages/jest/CHANGELOG.md#1100)
[`@emotion/native`](https://github.com/emotion-js/emotion/blob/master/packages/native/CHANGELOG.md#1100)
[`@emotion/primitives-core`](https://github.com/emotion-js/emotion/blob/master/packages/primitives-core/CHANGELOG.md#1100)
[`@emotion/primitives`](https://github.com/emotion-js/emotion/blob/master/packages/primitives/CHANGELOG.md#1100)
[`@emotion/react`](https://github.com/emotion-js/emotion/blob/master/packages/react/CHANGELOG.md#1100)
[`@emotion/serialize`](https://github.com/emotion-js/emotion/blob/master/packages/serialize/CHANGELOG.md#100)
[`@emotion/server`](https://github.com/emotion-js/emotion/blob/master/packages/server/CHANGELOG.md#1100)
[`@emotion/sheet`](https://github.com/emotion-js/emotion/blob/master/packages/sheet/CHANGELOG.md#100)
[`@emotion/styled`](https://github.com/emotion-js/emotion/blob/master/packages/styled/CHANGELOG.md#1100)
[`@emotion/utils`](https://github.com/emotion-js/emotion/blob/master/packages/utils/CHANGELOG.md#100)
4 changes: 2 additions & 2 deletions site/src/components/SiteHeader.js
Expand Up @@ -154,8 +154,8 @@ export default function SiteHeader() {
</HeaderLink>
</li>
<li>
<HeaderLink to="https://5bb1495273f2cf57a2cf39cc--emotion.netlify.com">
v9 Docs
<HeaderLink to="https://5faaafd0bd0f3f0008469537--emotion.netlify.app">
v10 Docs
</HeaderLink>
</li>
</ul>
Expand Down