docs: clarify CSS Modules class name generation#5419
Merged
chenjiahan merged 1 commit intomainfrom Jun 14, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation to clarify how CSS Modules generate class names by appending hash values and provides examples for both development and production modes.
- Updated wording for file-specific usage instructions in Chinese and English.
- Added code examples demonstrating the generated CSS class naming patterns.
- Included a tip section linking to custom class name configuration options.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/guide/styling/css-modules.mdx | Clarified instructions and added examples for CSS Modules class name generation (Chinese version). |
| website/docs/en/guide/styling/css-modules.mdx | Clarified instructions and added examples for CSS Modules class name generation (English version). |
Comments suppressed due to low confidence (2)
website/docs/zh/guide/styling/css-modules.mdx:36
- Consider mentioning that the hash value is generated based on the build configuration and may vary between projects.
+经过编译后，CSS Modules 中的类名会自动添加一个哈希值，以避免类名冲突：
website/docs/en/guide/styling/css-modules.mdx:36
- Consider clarifying that the appended hash value is configurable and may change based on the build settings.
+After compilation, CSS Modules class names are automatically appended with a hash value to prevent class name conflicts:
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Clarify CSS Modules class name generation, added examples showing how CSS class names are automatically appended with hash values during development and production to prevent conflicts.
Checklist