RFS is a unit resizing engine which was initially developed to resize font sizes (hence its abbreviation for Responsive Font Sizes). Nowadays RFS is capable of rescaling basically every value for any css property with units, like margin
, padding
, border-radius
or even box-shadow
.
The mechanism automatically calculates the appropriate values based on the dimensions of the browser viewport. It's available in one of your favourite preprocessors or postprocessor: Sass, Less, Stylus or PostCSS.
RFS
Demos
- Card example (Sass)
- Card example (Sass, with custom properties)
- Card example (PostCSS)
- Card example (PostCSS, with custom properties)
- Simple font rescaling Codepen Demo
- RFS in Bootstrap demo
Advantages
- No need to rescale paddings or margins anymore.
- Text won't be chopped off in smaller viewports when RFS is applied to font sizes.
- RFS will prevent the font size from rescaling too small, so readability can be assured.
- The font sizes of all text elements will always remain in relation with each other.
Fluid rescaling in action
The following example shows the effect of RFS on font sizes:
Installation
RFS can be installed using a package manager (recommended):
- npm:
npm install rfs
- yarn:
yarn add rfs
- bower (deprecated):
bower install rfs --save
Copy/paste (not recommended):
The source files can also be downloaded manually and used in a project. This method is not recommended because you lose the ability to easily and quickly manage and update RFS as a dependency.
Usage
.scss
syntax)
Sass (project/
├── node_modules/
│ └── rfs
│ └── ...
└── scss/
└── main.scss
Input
// scss/main.scss
@import "../node_modules/rfs/scss";
.title {
@include font-size(4rem);
// The font-size mixin is a shorthand which calls
// @include rfs(4rem, font-size);
// Other shorthand mixins that are available are:
// @include padding(4rem);
// @include padding-top(4rem);
// @include padding-right(4rem);
// @include padding-bottom(4rem);
// @include padding-left(4rem);
// @include margin(4rem);
// @include margin-top(4rem);
// @include margin-right(4rem);
// @include margin-bottom(4rem);
// @include margin-left(4rem);
// For properties which do not have a shorthand, the property can be passed:
// @include rfs(4rem, border-radius);
// Whenever a value contains a comma, it should be escaped with `#{}`:
// @include rfs(0 0 4rem red #{","} 0 0 5rem blue, box-shadow);
// Custom properties (css variables):
// @include rfs(4rem, --border-radius);
}
If you're using Webpack, you can simplify the @import
using the ~
prefix:
@import "~rfs/scss";
Generated css
.title {
font-size: calc(1.525rem + 3.3vw);
}
@media (min-width: 1200px) {
.title {
font-size: 4rem;
}
}
!important usage
Input
.label {
@include font-size(2.5rem !important);
}
Output
.label {
font-size: calc(1.375rem + 1.5vw) !important;
}
@media (min-width: 1200px) {
.label {
font-size: 2.5rem !important;
}
}
.sass
syntax)
Sass (project/
├── node_modules/
│ └── rfs
│ └── ...
└── sass/
└── main.sass
Input
// sass/main.sass
@import "../node_modules/rfs/sass"
.title
+font-size(4rem)
// The font-size mixin is a shorthand which calls
// +rfs(4rem, font-size)
// Other shorthand mixins that are available are:
// +padding(4rem)
// +padding-top(4rem)
// +padding-right(4rem)
// +padding-bottom(4rem)
// +padding-left(4rem)
// +margin(4rem)
// +margin-top(4rem)
// +margin-right(4rem)
// +margin-bottom(4rem)
// +margin-left(4rem)
// For properties which do not have a shorthand, the property can be passed:
// +rfs(4rem, border-radius)
// Whenever a value contains a comma, it should be escaped with `#{}`:
// +rfs(0 0 4rem red #{","} 0 0 5rem blue, box-shadow)
// Custom properties (css variables):
// +rfs(4rem, --border-radius)
If you're using Webpack, you can simplify the @import
using the ~
prefix:
@import "~rfs/scss"
Generated css
.title {
font-size: calc(1.525rem + 3.3vw);
}
@media (min-width: 1200px) {
.title {
font-size: 4rem;
}
}
!important usage
Input
.label
+font-size(2.5rem !important)
output
.label {
font-size: calc(1.375rem + 1.5vw) !important;
}
@media (min-width: 1200px) {
.label {
font-size: 2.5rem !important;
}
}
PostCSS
project/
├── postcss/
│ └── main.css
└── node_modules/
└── rfs
└── ...
Have a look at the examples folder to find examples on how your PostCSS setup can be configured.
// postcss/main.css
.title {
font-size: rfs(4rem);
// Or use it with any other property, for example
// padding: rfs(4rem);
// It's also possible to pass multiple values
// padding: rfs(3rem 4rem);
// or even
// box-shadow: rfs(0 3px 4rem red);
// or even comma seperated values
// box-shadow: rfs(0 3px 4rem red, 3px 0 4rem blue);
// To combine it with !important, use
// box-shadow: rfs(0 3px 4rem red) !important;
// Custom properties (css variables):
// --border-radius: rfs(4rem);
}
Generated css
.title {
font-size: calc(1.525rem + 3.3vw);
}
@media (min-width: 1200px) {
.title {
font-size: 4rem;
}
}
Less
project/
├── less/
│ └── main.less
└── node_modules/
└── rfs
└── ...
// less/main.less
@import "../node_modules/rfs/less";
.title {
.font-size(4rem);
// The font-size mixin is a shorthand which calls
// .rfs(4rem, font-size);
// Other shorthand mixins that are available are:
// .padding(4rem);
// .padding-top(4rem);
// .padding-right(4rem);
// 'padding-bottom(4rem);
// .padding-left(4rem);
// .margin(4rem);
// .margin-top(4rem);
// .margin-right(4rem);
// .margin-bottom(4rem);
// .margin-left(4rem);
// For properties which do not have a shorthand, the property can be passed as:
// .rfs(4rem, border-radius);
// Whenever a value contains a comma, it should be escaped with a tilde(~):
// .rfs(0 0 4rem red ~"," 0 0 5rem blue, box-shadow)
// Custom properties (css variables):
// .rfs(4rem, --border-radius)
}
If you're using Webpack, you can simplify the @import
using the ~
prefix:
@import "~rfs/less"
Generated css
.title {
font-size: calc(1.525rem + 3.3vw);
}
@media (min-width: 1200px) {
.title {
font-size: 4rem;
}
}
!important usage
Less still has a bug for native !important
support, and !important
can not be accepted as a parameter, so you 'll need to pass important
as a flag:
Input
.label {
.font-size(2.5rem important);
}
output
.label {
font-size: calc(1.375rem + 1.5vw) !important;
}
@media (min-width: 1200px) {
.label {
font-size: 2.5rem !important;
}
}
Stylus
project/
├── node_modules/
│ └── rfs
│ └── ...
└── stylus/
└── main.styl
// stylus/main.styl
@import "../node_modules/rfs/stylus";
.title
rfs-font-size(64px)
// The font-size mixin is a shorthand which calls
// rfs(4rem, font-size)
// Other shorthand mixins that are available are:
// rfs-padding(4rem)
// rfs-padding-top(4rem)
// rfs-padding-right(4rem)
// rfs-padding-bottom(4rem)
// rfs-padding-left(4rem)
// rfs-margin(4rem)
// rfs-margin-top(4rem)
// rfs-margin-right(4rem)
// rfs-margin-bottom(4rem)
// rfs-margin-left(4rem)
// For properties which do not have a shorthand, the property can be passed as:
// rfs(4rem, border-radius)
// Whenever a value contains a comma, it should be escaped with a backslash:
// rfs(0 0 4rem red \, 0 0 5rem blue, box-shadow)
// Custom properties (css variables):
// rfs(4rem, --border-radius)
Note the font-size
mixin can not be used to set the font size. That is because a font-size()
mixin would override the font-size
property. See 129#issuecomment-477926416 for more info.
If you're using Webpack, you can simplify the @import
using the ~
prefix:
@import "~rfs/stylus"
Generated css
.title {
font-size: calc(1.525rem + 3.3vw);
}
@media (min-width: 1200px) {
.title {
font-size: 4rem;
}
}
!important usage
Input
.label
rfs-font-size(2.5rem important)
output
.label {
font-size: calc(1.375rem + 1.5vw) !important;
}
@media (min-width: 1200px) {
.label {
font-size: 2.5rem !important;
}
}
Visualisation
If you wonder how the values are rescaled, wonder no more and stare at this graph which might clarify things a bit:
Each color represents another value being rescaled. For example:
.title {
@include font-size(40px);
}
This is the green line. A font size of 40px
stays 40px
in viewports with a size larger than 1200px
. Below 1200px
, the font size is rescaled and at viewport of 360px
, the font size is about 27px
. Note that every font size is generated in a combination of rem
and vw
units, but they are mapped to px
in the graph to make it easier to understand.
Configuration
RFS works out of the box without any configuration tweaks, but if you feel the urge to go loco and fine tune the way values are rescaled, you can:
px
or rem
)
Base value (unit in - SCSS, Sass & Stylus:
$rfs-base-value
- Less:
@rfs-base-value
- PostCSS:
baseValue
The option will prevent the value from becoming too small on smaller screens. If the font size which is passed to RFS is smaller than this value, no fluid rescaling will take place.
Default value: 1.25rem
px
or rem
)
Unit (- SCSS, Sass & Stylus:
$rfs-unit
- Less:
@rfs-unit
- PostCSS:
unit
The output value will be rendered in this unit. Keep in mind configuring this value to px
will disable the ability for users to change the the font size in their browser.
Default value: rem
px
, em
or rem
)
Breakpoint (in - SCSS, Sass & Stylus:
$rfs-breakpoint
- Less:
@rfs-breakpoint
- PostCSS:
breakpoint
Above this breakpoint, the value will be equal to the value you passed to RFS; below the breakpoint, the value will dynamically scale.
Default value: 1200px
px
, em
or rem
)
Breakpoint unit (- SCSS, Sass & Stylus:
$rfs-breakpoint-unit
- Less:
@rfs-breakpoint-unit
- PostCSS:
breakpointUnit
The width of the max width in the media query will be rendered in this unit.
Default value: px
Factor (number)
- SCSS, Sass & Stylus:
$rfs-factor
- Less:
@rfs-factor
- PostCSS:
factor
This value determines the strength of font size resizing. The higher the factor, the less difference there is between values on small screens. The lower the factor, the less influence RFS has, which results in bigger values for small screens. The factor must be greater than 1.
Default value: 10
Rem value (number)
- SCSS, Sass & Stylus:
$rfs-rem-value
- Less:
@rfs-rem-value
- PostCSS:
remValue
The value of 1rem
in px
. The value of 1rem
is typically 16px
but if the font size is changed for html
the value of 1rem
changes. This variable can be used to change the default value but be careful with it because changing it could lead to unexpected behaviour, for example if additional CSS is loaded which expects 1rem
to be 16px
.
Default value: 16
Two dimensional (boolean)
- SCSS, Sass & Stylus:
$rfs-two-dimensional
- Less:
@rfs-two-dimensional
- PostCSS:
twoDimensional
Enabling the two dimensional media queries will determine the value based on the smallest side of the screen with vmin
. This prevents values from changing if the device toggles between portrait and landscape mode.
Default value: false
Class (boolean)
- SCSS, Sass & Stylus:
$rfs-class
- Less:
@rfs-class
- PostCSS:
class
RFS can be enabled or disabled with a class. There are 3 options:
false
No extra classes are generated.disable
When the the disable classes are generated you can add the.disable-rfs
class to an element to disable responsive value rescaling for the element and its child elements.enable
RFS is disabled by default in this case. The.enable-rfs
class can be added to an element to enable responsive value rescaling for the element and its child elements.
Default value: false
Safari iframe resize bug fix (boolean)
- SCSS, Sass & Stylus:
$rfs-safari-iframe-resize-bug-fix
- Less:
@rfs-safari-iframe-resize-bug-fix
- PostCSS:
safariIframeResizeBugFix
Safari doesn't resize its values in an iframe if the iframe is resized. To fix this min-width: 0vw
can be added and that's what happens if this option is enabled. See #14.
Default value: false
Best practices
- Don't set RFS on the
html
element, because this influences the value ofrem
and could lead to unexpected results. - Always set your line-heights relative (in
em
or unitless) to prevent interline issues with font sizes.
Browser support
RFS is supported by all browsers that support media queries and viewport units.
Creator
Martijn Cuppens
Copyright and license
Code released under the MIT license.
Version 7.1.8 Post-Install Issue
I've been using the rfs v 7.1.4 since the last 2 months without a problem. I recently started a new Project and did a
npm install
followed by the project execution.I noticed the below error:
ERROR in ./src/styles.scss (./node_modules/raw-loader!./node_modules/postcss-loader/lib??embedded!./node_modules/sass-loader/lib/loader.js??ref--14-3!./src/styles.scss) Module build failed: @error "
#{$rfs-breakpoint-unit}is not a valid unit for $rfs-breakpoint-unit. Use
px,
emor
rem."; ^ `` is not a valid unit for $rfs-breakpoint-unit. Use
px,
emor
rem.
I reviewed the documentation to check for any breaking changes or whether I had to explicitly specify the rfs-breakpoint-unit (and I tried doing that) but it didn't work.
On a bit of investigation, I could see that there has been a new version upgrade to v7.1.8.
I then reverted to the previous version with
npm install [email protected] --save
and things worked as expected -- no error. (I do see a difference in the packages between 7.1.4 and 7.1.8)Am I missing something in the new release ? Please advise.
RFS doesn't work
Hi,
I've installed your library and tried to refactor one of my projects to see how it performs. What I've found really strange is that font-size jumps from 48px(viewport wider than 1200px) to 24px (viewport on 1199px and below).
Shouldn't it fluidly resize?
Thanks.
Any way to use css variables?
On my current project i am forced to use css variables instead of scss variables. But i was not a ble to make it in this way work:
@include font-size(var(--h6-font-size));
Someone think it will be possible to use css vars any time?Add function that just returns the calc() value for a specific property
When using a separate file for variables in a project it would be very useful to have a function in rfs, that only returns the calc() value for a specific property.
E.g. instead of using the mixin
@include font-size(30px)
I would like to do the following:vars.scss:
file1.scss
That would really help sometimes, when it comes to elements with
position: fixed
and margins set with rfs.Not mobile-first
What are your thoughts on changing the algorithm to be mobile-first (i.e. take font size on mobile as the argument and use min-width in the output)? Ultimately the effect could be the same, but readability could be better for those accustomed to writing for mobile-first (of which there are many).
Or another option might be to just add a mixin for mobile-first sizing.
See: Precise control over responsive typography
$rfs-two-dimensional: true wrong media queries?
at the moment the media queries for two dimensional mode are generated to look like this:
@media (min-width: 1200px), (min-height: 1200px) {
I think this leads to undesired behavior for screens with very high or very low aspect ratio.
better would be to change this to:
@media (min-width: 1200px) and (min-height: 1200px) {
fallback values for missing calc() browser support
I would like to suggest adding fallback values in case the browser doesnt support calc().
This could be easily done by adding the fallback value at the beginning of the generated css file.
Bump stylelint from 12.0.1 to 13.0.0
Bumps stylelint from 12.0.1 to 13.0.0.
Release notes
Sourced from stylelint's releases.
Changelog
Sourced from stylelint's changelog.
Commits
04af9e4
13.0.0704f6a2
Prepare 13.0.050ba8a9
Reorder changelog1666bba
Update devDependencies (#4542)062d298
Reindent nodejs.yml (#4541)a24e44a
Fix atypical rule README structure (#4537)616ad71
Bump husky from 4.0.3 to 4.0.6 (#4536)5e58ee7
Bump globby from 10.0.2 to 11.0.0 (#4528)eaee6a4
Refactor CLI options definition (#4530)6a2ffbd
Fix plugin pathYou can trigger a rebase of this PR by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)@dependabot badge me
will comment on this PR with code to add a "Dependabot enabled" badge to your readmeAdditionally, you can set the following in the
.dependabot/config.yml
file in this repo:padding-bottom mixin is using font-size property?
I got a strange issue. Here is the SCSS I'm using:
The result CSS checked in Browser Inspector is as follows:
Whats going on. Am I missing something? Same happens when I'm using
rfs()
mixin. The rfs version is 9.0.0Switch to lefthook
Ditch Husky in favor of https://github.com/Arkweid/lefthook. In the future we can split the tests more, eg. only run
xo
when something is changed in js files or prevent the tests from running when.md
files are changed.Fixes https://github.com/twbs/rfs/issues/149
It's not you, it's me: Bootstrap 4.3.1/RFS not generating media query at sub 1200px threshold
I've recently updated our project's Bootstrap version to the latest (4.3.1). I'm importing all of Bootstrap via node_modules. I haven't modified the RFS mixin in any way. I'm using the version that ships with Bootstrap 4.3.1 as configured by default. Bootstrap is compiling just fine with the exception of this particular RFS issue.
The media query is not being generated in my current environment. It is a large project with many dependencies and I'm pretty much shooting the dark trying to come up with a reduced test case. I realize that that makes helping me with this issue very difficult if not impossible. But I'm desperate at this point.
Also, I'm reasonably sure (say, 99%) this is a me problem, not an RFS problem, but I haven't been able to sort the issue.
I'm invoking the mixin as follows:
Note that this font size is greater than the minimum font size of 1.25rem at or below which no scaling will take place. So, that's not the issue.
I've also tried invoking the aliased versions of the mixin:
and
I've tried it with
rem
,px
, and unitless values.The mixin is definitely being recognized and is halfway working. I.e., it compiles out to regular CSS without a hitch.
So, the code above does indeed generate the following CSS:
But, again, no media query (at
1200px
) is being generated by the mixin in my current environment and, thus, no downward scaling is taking place below the 1200px threshold.At screen widths below
1200px
, I would expect to see something similar to the following:But, no dice.
Again, I haven't modified the default configuration of the RFS mixin in any way, and it does appear to be halfway working, as it's compiling out to CSS.
Tried in my coworker's environment and he gets the same results. But, that's expected, as we have pretty similar local environments, I suppose.
I hate to clutter up your issues with something that's in all likelihood not an issue with RFS (which is awesome -- using it on other projects), but SO hasn't turned up any leads so far.
Any suggestions for how to debug?
Thanks.
Build(deps): Bump decode-uri-component from 0.2.0 to 0.2.2
Bumps decode-uri-component from 0.2.0 to 0.2.2.
Release notes
Sourced from decode-uri-component's releases.
Commits
a0eea46
0.2.2980e0bf
Prevent overwriting previously decoded tokens3c8a373
0.2.176abc93
Switch to GitHub workflows746ca5d
Fix issue where decode throws - fixes #6486d7e2
Update license (#1)a650457
Tidelift tasks66e1c28
Meta tweaksDependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page.rem and px have incompatible units in rfs-breakpoint
Hey, i'm trying to configure the RFS values in a scss stylesheet and get the following error:
7065rem and 1440px have incompatible units.
I previously used the same settings but in a stylus stylesheet and had no problems. Is this a bug or a feature? 😁
Build(deps): Bump terser from 5.12.1 to 5.14.2
Bumps terser from 5.12.1 to 5.14.2.
Changelog
Sourced from terser's changelog.
Commits
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebase
will rebase this PR@dependabot recreate
will recreate this PR, overwriting any edits that have been made to it@dependabot merge
will merge this PR after your CI passes on it@dependabot squash and merge
will squash and merge this PR after your CI passes on it@dependabot cancel merge
will cancel a previously requested merge and block automerging@dependabot reopen
will reopen this PR if it is closed@dependabot close
will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot ignore this major version
will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor version
will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependency
will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the Security Alerts page.Use Sass Modules (dart-sass)
Some functions in the scss files are deprecated and will be removed next Year. So dont use lib-sass anymore and change to dart-sass. https://sass-lang.com/blog/libsass-is-deprecated
Usefull Link: https://sass-lang.com/documentation/at-rules
rfs() doens't work inside calc()
I'm using RFS v9.0.3 with PostCSS. The
rfs()
function doesn't work when wrapped in acalc()
function.Input:
Output:
Expected Output: