Components: Update Readme#69967
Open
Debarghya-Banerjee wants to merge 3 commits intoWordPress:trunkfrom
Open
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Debarghya-Banerjee
changed the title
t-hamano
added
[Type] Developer Documentation
sejas
reviewed
May 23, 2025
Contributor
sejas
left a comment
sejas
left a comment
There was a problem hiding this comment.
It would be great if we could be more specific about including only one stylesheet: either LTR or RTL.
packages/components/README.md
Outdated
|
|
||
| In non-WordPress projects, link to the `build-style/style.css` file directly, it is located at `node_modules/@wordpress/components/build-style/style.css`. | ||
|
|
||
| > **Note:** If your project supports right-to-left (RTL) languages, you should also include the RTL stylesheet: |
Contributor
There was a problem hiding this comment.
Suggested change
| > **Note:** If your project supports right-to-left (RTL) languages, you should also include the RTL stylesheet: | |
| > **Note:** If your project supports right-to-left (RTL) languages, you should include the appropriate stylesheet, either the standard or the RTL version, but not both. The RTL stylesheet is located at: |
Contributor
Author
There was a problem hiding this comment.
Have updated the comment
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
3 participants
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.
What?
Fixes #69966
This PR adds a note to the
README.mdabout including the RTL stylesheet when using@wordpress/componentsin non-WordPress projects.Why?
The existing documentation for
@wordpress/componentsin non-WordPress projects didn't include a note about the need for the RTL stylesheet when working in RTL contexts. This PR adds that information for clarity and completeness.How?
The change involves updating the
README.mdto include a section for RTL (Right-to-Left) languages, recommending the inclusion ofstyle-rtl.csswhen using the package outside WordPress.