Skip to content

Commit

Permalink
docs: sort
Browse files Browse the repository at this point in the history
  • Loading branch information
guilhermehto committed Oct 11, 2024
1 parent 264c35c commit da5c433
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions website/packages/docs/src/pages/pkg-babel-plugin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ If you choose to configure Compiled through Webpack or Parcel (recommended), you

- `addComponentName`
- `cache`
- `classHashPrefix`
- `classNameCompressionMap`
- `extensions`
- `classHashPrefix`
- `importReact`
- `importSources`
- `increaseSpecificity`
Expand Down Expand Up @@ -79,6 +79,17 @@ Will cache the result of statically evaluated imports.
* Type: `boolean | 'single-pass'`
* Default: `true`

#### classHashPrefix

Adds a prefix to the generated hashed css rule names. The valued passed to it gets hashed in conjunction with the rest of the rule declaration.

This is useful when `@compiled` is being used in a micro frontend environment by multiple packages and you want to avoid specificity issues.

The currently accepted regex for this value is `^[a-zA-Z\-_]+[a-zA-Z\-_0-9]*$`.

- Type: `string`
- Default: `undefined`

#### classNameCompressionMap

Don't use this!
Expand All @@ -94,17 +105,6 @@ Extensions that we should consider code. We use these to identify if a file shou
- Type: `string[]`
- Default: `['.js', '.jsx', '.ts', '.tsx']`

#### classHashPrefix

Adds a prefix to the generated hashed css rule names. The valued passed to it gets hashed in conjunction with the rest of the rule declaration.

This is useful when `@compiled` is being used in a micro frontend environment by multiple packages and you want to avoid specificity issues.

The currently accepted regex for this value is `^[a-zA-Z\-_]+[a-zA-Z\-_0-9]*$`.

- Type: `string`
- Default: `undefined`

#### importReact

Will import React into the module if it is not found.
Expand Down
2 changes: 1 addition & 1 deletion website/packages/docs/src/pages/pkg-parcel-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ Example usage:
The following options are passed directly to `@compiled/babel-plugin`:

- `addComponentName`
- `classNameCompressionMap`
- `classHashPrefix`
- `classNameCompressionMap`
- `importReact`
- `importSources`
- `optimizeCss`
Expand Down
2 changes: 1 addition & 1 deletion website/packages/docs/src/pages/pkg-webpack-loader.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ module.exports = {
`@compiled/webpack-loader` also accepts the following options. These are not used in the loader itself, but instead they are passed directly to the underlying `@compiled/babel-plugin`.

- `addComponentName`
- `classNameCompressionMap`
- `classHashPrefix`
- `classNameCompressionMap`
- `importReact`
- `importSources`
- `nonce`
Expand Down

0 comments on commit da5c433

Please sign in to comment.