feat: add dir prop for RTL support - #574
Merged
Merged
Conversation
Allow consumers to set the text direction of the modal content with a new dir prop, and make the built-in styles direction aware so the close button and text alignment flip correctly in RTL. Closes #523
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #574 +/- ##
=======================================
Coverage 80.40% 80.40%
=======================================
Files 7 7
Lines 199 199
Branches 73 73
=======================================
Hits 160 160
Misses 29 29
Partials 10 10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Closes #523.
Problem
The modal had no way to set a text direction. The component does not spread extra props, so consumers could not put
diron the modal DOM, and the built-in styles used physical properties (text-align: left,right: 14px) that ignoredirection. Settingdiron<html>/<body>or using a customcontainerwere the only workarounds.Changes
New optional
dir?: 'ltr' | 'rtl' | 'auto'prop, applied to the modal root element so the whole modal inherits the direction.Built-in styles are now direction aware:
.react-responsive-modal-modal:text-align: left→text-align: start.react-responsive-modal-closeButton:right: 14px→inset-inline-end: 14pxBoth are identical in LTR and flip correctly in RTL.
Documented the prop in the website props table.
Added tests covering the
dirattribute being set and absent by default.Notes
The CSS flip is not covered by jsdom tests. Happy to add an RTL example page and a Cypress assertion against real computed styles if you want that covered in a browser.