Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/rfs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMartijn Cuppens <martijn.cuppens@intracto.com>2018-02-24 00:21:57 +0300
committerMartijn Cuppens <martijn.cuppens@intracto.com>2018-02-24 00:21:57 +0300
commite8b90ad4ee7d302b2cd61335c4a29f6865828922 (patch)
tree405b8f66e5e474e2c429f080a8fa8410674cd0e4 /README.md
parentb191c037c8ef95973eeaace075ae1531f4731569 (diff)
:wrench: rfs class docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 15 insertions, 12 deletions
diff --git a/README.md b/README.md
index 706a956..2a8e15d 100644
--- a/README.md
+++ b/README.md
@@ -81,9 +81,7 @@ lose the ability to easily and quickly manage and update RFS as a dependency.
```
### Generated css
```css
-.title,
-.disable-responsive-font-size .title,
-.title.disable-responsive-font-size {
+.title {
font-size: 4rem;
}
@@ -151,13 +149,20 @@ Enabling the two dimensional media queries will determine the font size based on
*Default value: `false`*
-### Generate disable classes <sub><sup>(boolean)</sup></sub> ###
-> **SCSS, Sass & Stylus:** `$rfs-generate-disable-classes`
-> **Less:** `@rfs-generate-disable-classes`
-> **PostCSS:** `generateDisableClasses`
+### Class <sub><sup>(boolean)</sup></sub> ###
+> **SCSS, Sass & Stylus:** `$rfs-class`
+> **Less:** `@rfs-class`
+> **PostCSS:** `class`
+
+RFS can ben enabled or disabled with a class. There are 3 options:
+- `disable`
+When the the disable classes are generated you can add the `.disable-responsive-font-size` class to an element to disable responsive font sizes for the element and its child elements.
+- `enable`
+RFS is disabled by default in this case. The `.enable-responsive-font-size` class can be added to an element to enable responsive font sizes for the element and its child elements.
+- `false`
+No extra classes are generated.
-When the the disable classes are generated you can add the `.disable-responsive-font-size` class to an element to disable responsive font sizes for the element and its child elements. If you don't use this, it's better to set this to `false` to prevent the generation of unused css. This doesn't apply on font-sizes which are inherited from parents.
-*Default value: `true`*
+*Default value: `false`*
## !important
@@ -171,9 +176,7 @@ By setting a second parameter to true, `!important` is added after the font-size
CSS:
```css
-.label,
-.disable-responsive-font-size .label,
-.label.disable-responsive-font-size {
+.label {
font-size: 2.5rem !important;
}