Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@material/rtl

Package Overview
Dependencies
Maintainers
15
Versions
1662
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@material/rtl

Material Components for the web RTL Scss helpers

  • 14.0.0
  • unpublished
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
923K
decreased by-8.16%
Maintainers
15
Weekly downloads
 
Created
Source

RTL

UIs for languages that are read from right-to-left (RTL), such as Arabic and Hebrew, should be mirrored to ensure content is easy to understand.

Design & API Documentation

  • Material Design guidelines: Bidirectionality

Installation

npm install @material/rtl

Usage

Sass Mixins

rtl is the most flexible mixin, because it can work with multiple CSS properties. All other RTL mixins logic could be engineered by only using rtl, but we provide these mixins for convenience.

Both reflexive-property and reflexive-box work with one base box-model property, e.g. margin, border, padding. But reflexive-property is more flexible because it accepts different left and right values. reflexive-box assumes the left and right values are the same, and therefore that the box-model is symmetrical.

reflexive-position is the least flexible mixin. It only works with one horizontal position property, "left" or "right". It also assumes the left and right values are the same.

MixinDescription
rtl($root-selector)Creates a rule that is applied when the root element is within an RTL context
reflexive-box($base-property, $default-direction, $value, $root-selector)Applies the value to the #{$base-property}-#{$default-direction} property in a LTR context, and flips the direction in an RTL context. This mixin zeros out the original value in an RTL context.
reflexive-property($base-property, $left-value, $right-value, $root-selector)Emits rules that assign #{$base-property}-left to #{left-value} and #{base-property}-right to #{right-value} in a LTR context, and vice versa in a RTL context. Basically it flips values between a LTR and RTL context.
reflexive-position($position-property, $value, $root-selector)Applies the value to the specified position in a LTR context, and flips the direction in an RTL context. $position-property is a horizontal position, either "left" or "right".
reflexive($left-property, $left-value, $right-property, $right-value, $root-selector)Applies the pair of property values to the specified position in a LTR context, and flips the direction in an RTL context.

A note about [dir="rtl"]: rtl($root-selector) checks for [dir="rtl"] on the ancestor element. This works in most cases, it will sometimes lead to false negatives for more complex layouts, e.g.

<html dir="rtl">
  <!-- ... -->
  <div dir="ltr">
    <div class="mdc-foo">Styled incorrectly as RTL!</div>
  </div>
</html>

Unfortunately, we've found that this is the best we can do for now. In the future, selectors such as :dir will help us mitigate this.

Keywords

FAQs

Package last updated on 28 Apr 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc