rtlcss

What is rtlcss?

RTLCSS is a framework for transforming CSS from left-to-right (LTR) to right-to-left (RTL). It is particularly useful for creating websites that need to support both LTR and RTL languages, such as English and Arabic.

What are rtlcss's main functionalities?

Basic LTR to RTL conversion

This feature allows you to convert basic CSS properties from LTR to RTL. For example, 'margin-left' is converted to 'margin-right'.

const rtlcss = require('rtlcss');
const ltrCSS = 'body { margin-left: 10px; }';
const rtlCSS = rtlcss.process(ltrCSS);
console.log(rtlCSS); // Outputs: body { margin-right: 10px; }

Custom Directives

RTLCSS supports custom directives that allow you to control the transformation process. In this example, the '/*rtl:ignore*/' directive prevents the 'float: left;' rule from being converted.

const rtlcss = require('rtlcss');
const ltrCSS = '/*rtl:ignore*/ .example { float: left; }';
const rtlCSS = rtlcss.process(ltrCSS);
console.log(rtlCSS); // Outputs: .example { float: left; }

Plugins

RTLCSS supports plugins that can extend its functionality. This example shows how to use a plugin with RTLCSS.

const rtlcss = require('rtlcss');
const rtlcssPlugin = require('rtlcss-plugin');
const ltrCSS = 'body { margin-left: 10px; }';
const rtlCSS = rtlcss.process(ltrCSS, {}, [rtlcssPlugin]);
console.log(rtlCSS); // Outputs: body { margin-right: 10px; }

Other packages similar to rtlcss

postcss-rtl

PostCSS-RTL is a plugin for PostCSS that transforms LTR CSS to RTL. It offers similar functionality to RTLCSS but is designed to work within the PostCSS ecosystem, making it a good choice if you are already using PostCSS.

rtlcss-webpack-plugin

RTLCSS Webpack Plugin is a Webpack plugin that uses RTLCSS to generate RTL stylesheets from LTR stylesheets. It is specifically designed for use with Webpack, making it a good option if you are using Webpack for your build process.

flipcss

FlipCSS is a tool for converting LTR CSS to RTL. It offers similar functionality to RTLCSS but is a standalone tool rather than a library, making it a good choice for command-line usage.

README

RTLCSS

RTLCSS is a framework for converting Left-To-Right (LTR) Cascading Style Sheets(CSS) to Right-To-Left (RTL).

Documentation

Visit https://rtlcss.com/learn/

Playground

Visit https://rtlcss.com/playground/

Bugs and Issues

Have a bug or a feature request? please feel free to open a new issue.

Release Notes

To view changes in recent versions, see the CHANGELOG.

Support

RTLCSS is saving you and your team a tremendous amount of time and effort? Buy Me a Coffee ☕

Changelog

4.3.0 - 27 Aug. 2024

• Return an error code when the parsed CSS stdin is invalid. Thanks @lade-odoo