2.0.0 • Published 5 years ago

@kcko/bootstrap4-font-size-helper v2.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
5 years ago

bootstrap4-font-size-helper

Simple mixin which extends boostrap to help you solve the font size in bootstrap defined breakpoints

  • version 2.0.0
  • last update 15/02/2019

how to install and use

  • Download package directly from github or install via npm install @kcko/bootstrap4-font-size-helper or with yarn yarn add @kcko/bootstrap4-font-size-helper
  • import _core.scss to your project via command @import "core";
  • generate required font sizes with @include bootstrap-font-size-maker();

mixin option

  • map params
  • @param decimal|int $font-size-start - size from
  • @param decimal|int $font-size-end - size to
  • @param decimal|int $step - step between size from and size to
  • @param string $classname - classname (prefix)
  • @param string $separator - class separator between whole number and decimal number eg: "_", and your class will looks like this fs-1_4 (1.4rem), can be ommited or unfilled (empty string)
  • @param string $font-unit - type of unit (rem, px, em, or any ...), default rem like in BS

default settings

'font-size-start': 0.1,
'font-size-end': 6,
'step': 0.1,
'classname': 'fs',
'separator': '_',
'font-unit': 'rem'

example of use

  • @include bootstrap-font-size-maker(); will be rendered with default settings
  • @include bootstrap-font-size-maker(('classname': 'fs-helper')); - will be rendered as .fs-helper-{breakpoint}-{size}

you can override all values from default settings

@include bootstrap-font-size-maker((
'font-size-start': 1,
'font-size-end': 10,
'step': 0.5,
'classname': 'helper-fs',
'separator': '',
'font-unit': 'px'
));

or you can override only a part

@include bootstrap-font-size-maker((
'font-size-start': 3,
'font-unit': 'px',
'separator': '---',
));

in html

<div class="fs-2 fs-sm-3 fs-md-4 fs-lg-5 fs-xl-6" style="padding: 1rem; margin: 1rem;">
  <div style="color: red;" class="d-block d-sm-none">xs</div>
  <div style="color: blue;" class="d-none d-sm-block d-md-none">sm</div>
  <div style="color: green;" class="d-none d-md-block d-lg-none">md</div>
  <div style="color: purple;" class="d-none d-lg-block d-xl-none">lg</div>
  <div style="color: gold;" class="d-none d-xl-block">xl</div>
  <div>
    Font size testing
  </div>
</div>

This example will work when we keep default settings :)

video example

Watch the video