You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update/correct TypeScript docs to reflect current best practice (#2598)
* Update/correct TypeScript docs to reflect current best practice
#2596
* Clean up typescript.mdx per Andarist's suggestions
* Add back deleted section to typescript.mdx
Copy file name to clipboardExpand all lines: docs/typescript.mdx
+35-57Lines changed: 35 additions & 57 deletions
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,19 @@
2
2
title: 'TypeScript'
3
3
---
4
4
5
-
Emotion includes TypeScript definitions for `@emotion/react` and `@emotion/styled`. These definitions also infer types for css properties with the object syntax, HTML/SVG tag names, and prop types.
5
+
Emotion includes TypeScript definitions for `@emotion/react` and `@emotion/styled`. These definitions infer types for css properties with the object syntax, HTML/SVG tag names, and prop types.
6
6
7
7
## @emotion/react
8
8
9
+
The easiest way to use the css prop with TypeScript is with the new JSX transform and the `jsxImportSource` TSConfig option (available since TS 4.1). For this approach, your TSConfig `compilerOptions` should contain
10
+
11
+
```json
12
+
"jsx": "react-jsx",
13
+
"jsxImportSource": "@emotion/react"
14
+
```
15
+
16
+
For most users, this is all the setup that is required. You can now define styles using the object syntax or template literal syntax and pass them to your components via the `css` prop.
17
+
9
18
```tsx
10
19
import { css } from'@emotion/react'
11
20
@@ -22,7 +31,7 @@ const subtitleStyle = css`
22
31
`
23
32
```
24
33
25
-
TypeScript checks css properties with the object style syntax using [csstype](https://www.npmjs.com/package/csstype) package, so following code will emit errors.
34
+
Object styles are recommended since they are type checked with the help of the [csstype](https://www.npmjs.com/package/csstype) package. For example, the following code will emit an error.
26
35
27
36
```tsx
28
37
import { css } from'@emotion/react';
@@ -35,47 +44,41 @@ const titleStyle = css({
35
44
});
36
45
```
37
46
38
-
To make the css prop work with pure TypeScript (without babel plugin) you need to add `/** @jsx jsx */` at the top of every file that is using the css prop:
47
+
When using our JSX factory, TypeScript only allows the `css` prop on components that accept a `className` prop. This is because `@emotion/react` resolves the value of the `css` prop to a class name and then passes this class name down to the rendered component.
48
+
49
+
### With the Babel plugin
50
+
51
+
[`@emotion/babel-plugin`](/docs/babel) is completely optional for TypeScript users. If you are not already using Babel, you probably shouldn't add it to your build tooling unless you truly need one of the features offered by `@emotion/babel-plugin`. On the other hand, there's no reason not to use `@emotion/babel-plugin` if you are already using Babel to transpile your TypeScript code.
52
+
53
+
### With the old JSX transform
54
+
55
+
If you are unable to upgrade to the `react-jsx` transform, you will need to specify the JSX factory at the top of every file:
39
56
40
57
```tsx
41
58
/**@jsx jsx */
42
59
import { jsx } from'@emotion/react'
43
-
44
-
<divcss={{ background: 'black' }} />
45
60
```
46
61
47
-
As a result you may be not able to use react fragment shorthand syntax - `<></>`, but still you can use `<Fragment></Fragment>`.
48
-
This is a limitation of the TypeScript compiler not being able to independently specify jsx pragma and jsxFrag pragma.
62
+
As a result, you may be not able to use the shorthand syntax `<></>` for React fragments, but you can still use `<Fragment></Fragment>`. This is a limitation of the TypeScript compiler not being able to independently specify jsx pragma and jsxFrag pragma.
49
63
50
64
You can still use the css helper and pass the className yourself (ensure you are importing from the `@emotion/css` package, not `@emotion/react`).
51
65
52
66
```tsx
53
67
import { css } from'@emotion/css'
54
68
55
-
<divclassName={css({ background: 'black' })} />
69
+
const el =<divclassName={css({ background: 'black' })} />
56
70
```
57
71
58
-
### `css` prop
59
-
60
-
When using our JSX factories the support for `css` prop is being added only for components that accepts `className` prop as they take provided `css` prop, resolves it and pass the generated `className` to the rendered component.
61
-
62
-
If using the automatic runtime you should just add this to your `tsconfig.json` to let TypeScript know where it should look for the `JSX` namespace:
63
-
```json
64
-
{
65
-
"compilerOptions": {
66
-
"jsxImportSource": "@emotion/react"
67
-
}
68
-
}
69
-
```
70
-
71
-
The same `JSX` namespace is resolved if you are still using the classic runtime through the `@jsx` pragma. 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 or the automatic runtime. For those cases when people use our pragma implicitly (for example when using our `@emotion/babel-preset-css-prop`) we have a special file that can be imported once to add support for the `css` prop globally, for all components. Use it like this:
72
+
It's not possible to leverage `css` prop support being added conditionally based on the type of a rendered component when not using our jsx pragma or the `react-jsx` transform. If you use our pragma implicitly (for example when using our `@emotion/babel-preset-css-prop`) we have a special file that can be imported once to add support for the `css` prop globally, for all components. Use it like this:
Sometimes you want to wrap an existing component and override the type of a prop. Emotion allows you to specify a `shouldForwardProp` hook to filter properties which should be passed to the wrapped component.
197
199
198
-
If you make `shouldForwardProp` a [type guard](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards) then only the props from the type guard will be exposed.
200
+
If you make `shouldForwardProp` a [type guard](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) then only the props from the type guard will be exposed.
0 commit comments