Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moodlehq/rtlcss-php
RTLCSS-PHP is a framework for converting LTR CSS to RTL.
https://github.com/moodlehq/rtlcss-php
Last synced: about 2 months ago
JSON representation
RTLCSS-PHP is a framework for converting LTR CSS to RTL.
- Host: GitHub
- URL: https://github.com/moodlehq/rtlcss-php
- Owner: moodlehq
- License: mit
- Created: 2016-07-19T10:52:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-25T08:10:43.000Z (almost 3 years ago)
- Last Synced: 2023-03-11T01:20:17.971Z (almost 2 years ago)
- Language: PHP
- Size: 36.1 KB
- Stars: 7
- Watchers: 16
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
RTLCSS for PHP
--------------
[](https://github.com/moodlehq/rtlcss-php/actions/workflows/ci.yml)
RTLCSS is a framework for converting Left-To-Right (LTR) Cascading Style Sheets(CSS) to Right-To-Left (RTL).
## Usage
### Installation using composer
Add the library to your composer.json
```json
{
"repositories": [{
"type": "vcs",
"url": "https://github.com/moodlehq/rtlcss-php"
}],
"require-dev": {
"moodlehq/rtlcss-php": "*"
}
}
```
### Flipping
```php
$parser = new Sabberworm\CSS\Parser($css);
$tree = $parser->parse()
$rtlcss = new MoodleHQ\RTLCSS\RTLCSS($tree);
$rtlcss->flip();
echo $tree->render();
```
For parsing options and rendering, refer to [Sabberworm/PHP-CSS-Parser](https://github.com/sabberworm/PHP-CSS-Parser).
## Output sample
```css
.div {
direction: ltr;
left: 10px;
border: 10px 5px 0px 2px;
float: left;
}
```
Becomes:
```css
.div {
direction: rtl;
right: 10px;
border: 10px 2px 0px 5px;
float: right;
}
```
## Options
You can prefix your CSS with comments starting with `/*rtl:*/` for special handling.
### Do not flip values
Prepend with `/*rtl:ignore*/`, or wrap within `/*rtl:begin:ignore*/` and `/*rtl:end:ignore*/`.
```css
.div {
/*rtl:ignore*/
float: left;
left: 10px;
}
.div {
direction: ltr;
/*rtl:begin:ignore*/
float: left;
left: 10px;
/*rtl:end:ignore*/
}
```
Becomes:
```css
.div {
float: left;
right: 10px;
}
.div {
direction: rtl;
float: left;
left: 10px;
}
```
### Remove CSS
Prepend with `/*rtl:remove*/`, wrap within `/*rtl:begin:remove*/` and `/*rtl:end:remove*/`.
```css
.div {
/*rtl:remove*/
float: left;
left: 10px;
}
.div {
direction: ltr;
/*rtl:begin:remove*/
float: left;
left: 10px;
/*rtl:end:remove*/
}
```
Becomes:
```css
.div {
right: 10px;
}
.div {
direction: rtl;
}
```
### Additional CSS
Write the CSS in a content starting with `/*rtl:raw:`.
```css
.div {
/*rtl:raw:
text-align: left;
*/
float: left;
}
```
Becomes:
```css
.div {
text-align: left;
float: right;
}
```
### Limitation
Currently the comments must always precede a statement, they will not work if they are not followed by anything.
Valid:
```css
.div {
/*rtl:raw:
text-align: left;
*/
float: left;
}
```
Invalid:
```css
.div {
float: left;
/*rtl:raw:
text-align: left;
*/
}
```
## CSS support
A lot of common CSS rules are supported, however a few complex ones are not. To get a grasp of what is supported and what isn't, please refer to the test cases. Unsupported scenarios are marked to be skipped.
## About this tool
This tool is very heavily inspired by [MohammadYounes/rtlcss](https://github.com/MohammadYounes/rtlcss), even though at this stage it does not include all of its features. See this library as a partial port of the latter.
## Credits
* [MohammadYounes/rtlcss](https://github.com/MohammadYounes/rtlcss) for being the example we followed.
* [Sabberworm/PHP-CSS-Parser](https://github.com/sabberworm/PHP-CSS-Parser) for parsing CSS in PHP.
## License
Licensed under the [MIT License](https://opensource.org/licenses/MIT).