Skip to content

Commit

Permalink
readme(gatsby-plugin-emotion): fix table (#28906)
Browse files Browse the repository at this point in the history 
Co-authored-by: Lennart <lekoarts@gmail.com>
  • Loading branch information
@muescha @LekoArts
muescha and LekoArts committed Jan 8, 2021
1 parent 712e864 commit 4798257
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/gatsby-plugin-emotion/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ module.exports = {

The plugin supports the same options that you can pass into [`@emotion/babel-plugin`](https://emotion.sh/docs/@emotion/babel-plugin#options).

| Option | Type | Description | Default | Required |
| ------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sourceMap | boolean | Tells the plugin to inject source maps for use in browser dev tools in development. | `true` | |
| autoLabel | `'dev-only' | 'always' | 'never'` | Automatically adds the label property to styles so that class names generated by css or styled include the name of the variable the result is assigned to. You can read more about this option in [`@emotion/babel-plugin`'s docs](https://emotion.sh/docs/@emotion/babel-plugin#autolabel) | `dev-only` | |
| labelFormat | string | Only works when `autoLabel` is set to true. It allows you to define the format of the resulting label. The format is defined via string where variable parts are enclosed in square brackets []. For example `labelFormat: "my-classname--[local]"`, where `[local]` will be replaced with the name of the variable the result is assigned to. | "[local]" | |
| cssPropOptimization | boolean | Assumes that you are using something to make `@emotion/react`’s jsx function work for all jsx. If you are not doing so and you do not want such optimizations to occur, disable this option. | `true` | |
| Option | Type | Description | Default | Required |
| --------------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | -------- |
| `sourceMap` | boolean | Tells the plugin to inject source maps for use in browser dev tools in development. | `true` | |
| `autoLabel` | `'dev-only' ∣ 'always' ∣ 'never'` | Automatically adds the label property to styles so that class names generated by css or styled include the name of the variable the result is assigned to. You can read more about this option in [`@emotion/babel-plugin`'s docs](https://emotion.sh/docs/@emotion/babel-plugin#autolabel) | `dev-only` | |
| `labelFormat` | string | Only works when `autoLabel` is set to true. It allows you to define the format of the resulting label. The format is defined via string where variable parts are enclosed in square brackets `[]`. For example `labelFormat: "my-classname--[local]"`, where `[local]` will be replaced with the name of the variable the result is assigned to. | `"[local]"` | |
| `cssPropOptimization` | boolean | Assumes that you are using something to make `@emotion/react`’s jsx function work for all jsx. If you are not doing so and you do not want such optimizations to occur, disable this option. | `true` | |

0 comments on commit 4798257

Please sign in to comment.