Skip to content
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.

Sign up for GitHub

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

Components utils: rtl() return type, rtl.watch() utility #33882

Merged
merged 3 commits into from
Aug 4, 2021
Merged

Components utils: rtl() return type, rtl.watch() utility #33882

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fd423f
Better return type for rtl() function
ciampo Aug 4, 2021
3b93161
Add rtl.watch() utility function
ciampo Aug 4, 2021
5503c65
Update packages/components/src/utils/rtl.js
ciampo Aug 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion packages/components/src/utils/rtl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export const convertLTRToRTL = ( ltrStyles = {} ) => {
* @param {import('react').CSSProperties} ltrStyles Ltr styles. Converts and renders from ltr -> rtl styles, if applicable.
* @param {import('react').CSSProperties} [rtlStyles] Rtl styles. Renders if provided.
*
* @return {Function} A function to output CSS styles for Emotion's renderer
* @return {() => import('@emotion/react').SerializedStyles} A function to output CSS styles for Emotion's renderer
*/
export function rtl( ltrStyles = {}, rtlStyles ) {
return () => {
Expand All @@ -79,3 +79,17 @@ export function rtl( ltrStyles = {}, rtlStyles ) {
return isRTL() ? css( convertLTRToRTL( ltrStyles ) ) : css( ltrStyles );
};
}

/**
* Call this in the `useMemo` dependency array to ensure that subsequent renders will
* cause rtl styles to update based on the `isRTL` return value even if all other dependencies
* remain the same.
*
* @example
* const styles = useMemo( () => {
* return css`
* ${ rtl( { marginRight: '10px' } ) }
* `;
* }, [ rtl.watch() ] );
*/
rtl.watch = () => isRTL();