diff options
author | Martijn Cuppens <martijn.cuppens@gmail.com> | 2019-08-28 19:05:56 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-08-28 19:05:56 +0300 |
commit | 89f7a63ee4826b646ec659709cc170b8c45cddbc (patch) | |
tree | aab7f3991699ffe9f423a0599b9e1c75442e6d4d /scss.scss | |
parent | 7a15c1a4e41b1fd46b3f26be3529abc1e2d65a4d (diff) |
Support for every property (#144)
- Support for all properties
- Shorthand mixins for margins and paddings
- Support for custom properties
- Clearer way to declare `!important` rules: `@include rfs(1rem !important)` instead of `@include rfs(1rem, true)`
- Switched to mobile first approach, still possible to switch to the `max-width` media queries if needed
- Configuration variables are changed:
- Base font size -> Base value
- Font size unit -> Unit
- `responsive-font-size` property changed to `rfs()` function (see https://github.com/twbs/rfs/issues/116)
- Dropped `responsive-font-size` mixins
- Dropped Less 2 support since we had to work with lists
- Prevent generation of `/test/expected/main.css`
- Additional tests for new implementations
- Cleanup npm scripts examples
- Code examples in `README.md` are grouped by processor and collapsed
Diffstat (limited to 'scss.scss')
-rw-r--r-- | scss.scss | 284 |
1 files changed, 200 insertions, 84 deletions
@@ -2,21 +2,21 @@ // SCSS RFS mixin // -// Automated responsive font sizes +// Automated responsive values for for font sizes, paddings, margins and much more // // Licensed under MIT (https://github.com/twbs/rfs/blob/master/LICENSE) // Configuration -// Base font size -$rfs-base-font-size: 1.25rem !default; -$rfs-font-size-unit: rem !default; +// Base value +$rfs-base-value: 1.25rem !default; +$rfs-unit: rem !default; -@if $rfs-font-size-unit != rem and $rfs-font-size-unit != px { - @error "`#{$rfs-font-size-unit}` is not a valid unit for $rfs-font-size-unit. Use `px` or `rem`."; +@if $rfs-unit != rem and $rfs-unit != px { + @error "`#{$rfs-unit}` is not a valid unit for $rfs-unit. Use `px` or `rem`."; } -// Breakpoint at where font-size starts decreasing if screen width is smaller +// Breakpoint at where values start decreasing if screen width is smaller $rfs-breakpoint: 1200px !default; $rfs-breakpoint-unit: px !default; @@ -24,16 +24,19 @@ $rfs-breakpoint-unit: px !default; @error "`#{$rfs-breakpoint-unit}` is not a valid unit for $rfs-breakpoint-unit. Use `px`, `em` or `rem`."; } -// Resize font size based on screen height and width +// Resize values based on screen height and width $rfs-two-dimensional: false !default; // Factor of decrease $rfs-factor: 10 !default; -@if type-of($rfs-factor) != "number" or $rfs-factor <= 1 { +@if type-of($rfs-factor) != number or $rfs-factor <= 1 { @error "`#{$rfs-factor}` is not a valid $rfs-factor, it must be greater than 1."; } +// Mode. Possibilities: "min-media-query", "max-media-query" +$rfs-mode: min-media-query !default; + // Generate enable or disable classes. Possibilities: false, "enable" or "disable" $rfs-class: false !default; @@ -43,51 +46,63 @@ $rfs-rem-value: 16 !default; // Safari iframe resize bug: https://github.com/twbs/rfs/issues/14 $rfs-safari-iframe-resize-bug-fix: false !default; -// Disable RFS by setting $enable-responsive-font-sizes to false -$enable-responsive-font-sizes: true !default; +// Disable RFS by setting $enable-rfs to false +$enable-rfs: true !default; -// Cache $rfs-base-font-size unit -$rfs-base-font-size-unit: unit($rfs-base-font-size); +// Cache $rfs-base-value unit +$rfs-base-value-unit: unit($rfs-base-value); -// Remove px-unit from $rfs-base-font-size for calculations -@if $rfs-base-font-size-unit == "px" { - $rfs-base-font-size: $rfs-base-font-size / ($rfs-base-font-size * 0 + 1); +// Remove px-unit from $rfs-base-value for calculations +@if $rfs-base-value-unit == px { + $rfs-base-value: $rfs-base-value / ($rfs-base-value * 0 + 1); } -@else if $rfs-base-font-size-unit == "rem" { - $rfs-base-font-size: $rfs-base-font-size / ($rfs-base-font-size * 0 + 1 / $rfs-rem-value); +@else if $rfs-base-value-unit == rem { + $rfs-base-value: $rfs-base-value / ($rfs-base-value * 0 + 1 / $rfs-rem-value); } // Cache $rfs-breakpoint unit to prevent multiple calls $rfs-breakpoint-unit-cache: unit($rfs-breakpoint); // Remove unit from $rfs-breakpoint for calculations -@if $rfs-breakpoint-unit-cache == "px" { +@if $rfs-breakpoint-unit-cache == px { $rfs-breakpoint: $rfs-breakpoint / ($rfs-breakpoint * 0 + 1); } -@else if $rfs-breakpoint-unit-cache == "rem" or $rfs-breakpoint-unit-cache == "em" { +@else if $rfs-breakpoint-unit-cache == rem or $rfs-breakpoint-unit-cache == "em" { $rfs-breakpoint: $rfs-breakpoint / ($rfs-breakpoint * 0 + 1 / $rfs-rem-value); } -// Internal mixin that adds disable classes to the selector if needed. -@mixin _rfs-disable-class { - @if $rfs-class == "disable" { - // Adding an extra class increases specificity, which prevents the media query to override the font size - &, - .disable-responsive-font-size &, - &.disable-responsive-font-size { +// Calculate the media query value +$rfs-mq-value: if($rfs-breakpoint-unit == px, #{$rfs-breakpoint}px, #{$rfs-breakpoint / $rfs-rem-value}#{$rfs-breakpoint-unit}); +$rfs-mq-property-width: if($rfs-mode == max-media-query, max-width, min-width); +$rfs-mq-property-height: if($rfs-mode == max-media-query, max-height, min-height); + +// Internal mixin used to determine which media query needs to be used +@mixin _rfs-media-query { + @if $rfs-two-dimensional { + @media (#{$rfs-mq-property-width}: #{$rfs-mq-value}), (#{$rfs-mq-property-height}: #{$rfs-mq-value}) { @content; } } @else { - @content; + @media (#{$rfs-mq-property-width}: #{$rfs-mq-value}) { + @content; + } } } -// Internal mixin that adds enable classes to the selector if needed. -@mixin _rfs-enable-class { - @if $rfs-class == "enable" { - .enable-responsive-font-size &, - &.enable-responsive-font-size { +// Internal mixin that adds disable classes to the selector if needed. +@mixin _rfs-rule { + @if $rfs-class == disable and $rfs-mode == max-media-query { + // Adding an extra class increases specificity, which prevents the media query to override the property + &, + .disable-rfs &, + &.disable-rfs { + @content; + } + } + @else if $rfs-class == enable and $rfs-mode == min-media-query { + .enable-rfs &, + &.enable-rfs { @content; } } @@ -96,91 +111,192 @@ $rfs-breakpoint-unit-cache: unit($rfs-breakpoint); } } -// Internal mixin used to determine which media query needs to be used -@mixin _rfs-media-query($mq-value) { - @if $rfs-two-dimensional { - @media (max-width: #{$mq-value}), (max-height: #{$mq-value}) { +// Internal mixin that adds enable classes to the selector if needed. +@mixin _rfs-media-query-rule { + + @if $rfs-class == enable { + @if $rfs-mode == min-media-query { @content; } + + @include _rfs-media-query { + .enable-rfs &, + &.enable-rfs { + @content; + } + } } @else { - @media (max-width: #{$mq-value}) { + @if $rfs-class == disable and $rfs-mode == min-media-query { + .disable-rfs &, + &.disable-rfs { + @content; + } + } + @include _rfs-media-query { @content; } } } -// Responsive font size mixin -@mixin rfs($fs, $important: false) { - // Cache $fs unit - $fs-unit: if(type-of($fs) == "number", unit($fs), false); +// Helper function to get the formatted non-responsive value +@function rfs-value($values) { + // Convert to list + $values: if(type-of($values) != list, ($values,), $values); - // Add !important suffix if needed - $rfs-suffix: if($important, " !important", ""); + $val: ''; - // If $fs isn't a number (like inherit) or $fs has a unit (not px or rem, like 1.5em) or $ is 0, just print the value - @if not $fs-unit or $fs-unit != "" and $fs-unit != "px" and $fs-unit != "rem" or $fs == 0 { - font-size: #{$fs}#{$rfs-suffix}; - } - @else { - // Remove unit from $fs for calculations - @if $fs-unit == "px" { - $fs: $fs / ($fs * 0 + 1); + // Loop over each value and calculate value + @each $value in $values { + @if $value == 0 { + $val: $val + ' 0'; } - @else if $fs-unit == "rem" { - $fs: $fs / ($fs * 0 + 1 / $rfs-rem-value); + @else { + // Cache $value unit + $unit: if(type-of($value) == "number", unit($value), false); + + @if $unit == px { + // Convert to rem if needed + $val: $val + ' ' + if($rfs-unit == rem, #{$value / ($value * 0 + $rfs-rem-value)}rem, $value); + } + @else if $unit == rem { + // Convert to px if needed + $val: $val + ' ' + if($rfs-unit == px, #{$value / ($value * 0 + 1) * $rfs-rem-value}px, $value); + } + @else { + // If $value isn't a number (like inherit) or $value has a unit (not px or rem, like 1.5em) or $ is 0, just print the value + $val: $val + ' ' + $value; + } } + } + + // Remove first space + @return unquote(str-slice($val, 2)); +} - // Set default font size - $rfs-static: if($rfs-font-size-unit == rem, #{$fs / $rfs-rem-value}rem, #{$fs}px); +// Helper function to get the responsive value calculated by RFS +@function rfs-fluid-value($values) { + // Convert to list + $values: if(type-of($values) != list, ($values,), $values); - // Only add the media query if the font size is bigger than the minimum font size - @if $fs <= $rfs-base-font-size or not $enable-responsive-font-sizes { - font-size: #{$rfs-static}#{$rfs-suffix}; + $val: ''; + + // Loop over each value and calculate value + @each $value in $values { + @if $value == 0 { + $val: $val + ' 0'; } + @else { - // Calculate the minimum font size for $fs - $fs-min: $rfs-base-font-size + ($fs - $rfs-base-font-size) / $rfs-factor; + // Cache $value unit + $unit: if(type-of($value) == "number", unit($value), false); - // Calculate difference between $fs and the minimum font size - $fs-diff: $fs - $fs-min; + // If $value isn't a number (like inherit) or $value has a unit (not px or rem, like 1.5em) or $ is 0, just print the value + @if not $unit or $unit != px and $unit != rem { + $val: $val + ' ' + $value; + } - // Base font-size formatting - $min-width: if($rfs-font-size-unit == rem, #{$fs-min / $rfs-rem-value}rem, #{$fs-min}px); + @else { + // Remove unit from $value for calculations + $value: $value / ($value * 0 + if($unit == px, 1, 1 / $rfs-rem-value)); - // Use `vmin` if two-dimensional is enabled - $variable-unit: if($rfs-two-dimensional, vmin, vw); + // Only add the media query if the value is greater than the minimum value + @if abs($value) <= $rfs-base-value or not $enable-rfs { + $val: $val + ' ' + if($rfs-unit == rem, #{$value / $rfs-rem-value}rem, #{$value}px); + } + @else { + // Calculate the minimum value + $value-min: $rfs-base-value + (abs($value) - $rfs-base-value) / $rfs-factor; - // Calculate the variable width between 0 and $rfs-breakpoint - $variable-width: #{$fs-diff * 100 / $rfs-breakpoint}#{$variable-unit}; + // Calculate difference between $value and the minimum value + $value-diff: abs($value) - $value-min; - // Set the calculated font-size - $rfs-fluid: calc(#{$min-width} + #{$variable-width}) #{$rfs-suffix}; + // Base value formatting + $min-width: if($rfs-unit == rem, #{$value-min / $rfs-rem-value}rem, #{$value-min}px); - // Breakpoint formatting - $mq-value: if($rfs-breakpoint-unit == px, #{$rfs-breakpoint}px, #{$rfs-breakpoint / $rfs-rem-value}#{$rfs-breakpoint-unit}); + // Use `vmin` if two-dimensional is enabled + $variable-unit: if($rfs-two-dimensional, vmin, vw); - @include _rfs-disable-class { - font-size: #{$rfs-static}#{$rfs-suffix}; - } + // Calculate the variable width between 0 and $rfs-breakpoint + $variable-width: #{$value-diff * 100 / $rfs-breakpoint}#{$variable-unit}; - @include _rfs-media-query($mq-value) { - @include _rfs-enable-class { - font-size: $rfs-fluid; + // Return the calculated value + $val: $val + ' ' + if($value < 0, calc(-#{$min-width} - #{$variable-width}), calc(#{$min-width} + #{$variable-width})); } + } + } + } + + // Remove first space + @return unquote(str-slice($val, 2)); +} + +// RFS mixin +@mixin rfs($values, $property: font-size) { + @if $values != null { + $val: rfs-value($values); + $fluidVal: rfs-fluid-value($values); + + // Do not print the media query if responsive & non-responsive values are the same + @if $val == $fluidVal { + #{$property}: $val; + } + @else { + @include _rfs-rule { + #{$property}: if($rfs-mode == max-media-query, $val, $fluidVal); // Include safari iframe resize fix if needed min-width: if($rfs-safari-iframe-resize-bug-fix, (0 * 1vw), null); } + + @include _rfs-media-query-rule { + #{$property}: if($rfs-mode == max-media-query, $fluidVal, $val); + } } } } -// The font-size & responsive-font-size mixins use RFS to rescale the font size -@mixin font-size($fs, $important: false) { - @include rfs($fs, $important); +// Shorthand helper mixins +@mixin font-size($value) { + @include rfs($value); +} + +@mixin padding($value) { + @include rfs($value, padding); +} + +@mixin padding-top($value) { + @include rfs($value, padding-top); +} + +@mixin padding-right($value) { + @include rfs($value, padding-right); +} + +@mixin padding-bottom($value) { + @include rfs($value, padding-bottom); +} + +@mixin padding-left($value) { + @include rfs($value, padding-left); +} + +@mixin margin($value) { + @include rfs($value, margin); +} + +@mixin margin-top($value) { + @include rfs($value, margin-top); +} + +@mixin margin-right($value) { + @include rfs($value, margin-right); +} + +@mixin margin-bottom($value) { + @include rfs($value, margin-bottom); } -@mixin responsive-font-size($fs, $important: false) { - @include rfs($fs, $important); +@mixin margin-left($value) { + @include rfs($value, margin-left); } |