-
-
Notifications
You must be signed in to change notification settings - Fork 3.3k
docs: add module.parser.css.namedExports #7274
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -270,6 +270,59 @@ module.exports = { | |
}; | ||
``` | ||
|
||
### module.parser.css.namedExports | ||
|
||
This option enables the use of ES modules named export for CSS exports. When set to true, the CSS module will export its classes and styles using named exports. | ||
|
||
- Type: `boolean` | ||
- Available: 5.90.0+ | ||
- Example: | ||
|
||
```js | ||
module.exports = { | ||
module: { | ||
parser: { | ||
css: { | ||
namedExports: true, | ||
}, | ||
}, | ||
}, | ||
}; | ||
``` | ||
|
||
When `namedExports` is `false` (default behavior) for CSS modules, you can retrieve CSS classes using various import methods. | ||
Named exports are redirected to improve developer experience (DX), facilitating a smooth transition from default exports to named exports: | ||
|
||
```js | ||
import * as styles from './styles.css'; | ||
import styles1 from './styles.css'; | ||
import { foo } from './styles.css'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's use There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done |
||
|
||
console.log(styles.default.foo); // Access via styles.default | ||
console.log(styles.foo); // Access directly from styles | ||
console.log(styles1.foo); // Access via default import styles1 | ||
console.log(foo); // Direct named import | ||
``` | ||
|
||
When `namedExports` is enabled, you can use **only** named exports to import CSS classes. | ||
|
||
```css | ||
/* styles.css */ | ||
.header { | ||
color: blue; | ||
} | ||
|
||
.footer { | ||
color: green; | ||
} | ||
``` | ||
|
||
```js | ||
import { header, footer } from './styles.css'; | ||
``` | ||
|
||
By enabling `namedExports`, you adopt a more modular and maintainable approach to managing CSS in JavaScript projects, leveraging ES module syntax for clearer and more explicit imports. | ||
|
||
### module.parser.javascript | ||
|
||
Configure options for JavaScript parser. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For webpack
default behavior
is named export, so let's rewrite it