# @kcko/bootstrap4-font-size-helper

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

Latest version **2.0.0** (published 2019-02-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install @kcko/bootstrap4-font-size-helper
pnpm add @kcko/bootstrap4-font-size-helper
yarn add @kcko/bootstrap4-font-size-helper
bun add @kcko/bootstrap4-font-size-helper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2019-02-15 |
| First published | 2019-02-15 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Roman Janko |
| Maintainers | kcko |
| Keywords | scss, bootstrap 4, mixin, font size, utility, helper, responsive, breakpoints |

## Links

- npm: https://www.npmjs.com/package/@kcko/bootstrap4-font-size-helper
- Repository: https://github.com/Kcko/bootstrap4-font-size-helper
- Homepage: https://github.com/Kcko/bootstrap4-font-size-helper#readme
- Issues: https://github.com/Kcko/bootstrap4-font-size-helper/issues
- npm.io page: https://npm.io/package/@kcko/bootstrap4-font-size-helper

## Dependencies (1)

- [bootstrap](https://npm.io/package/bootstrap.md) 4.x

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2019-02-15
- 1.0.0 — 2019-02-15

## README

# 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
```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](http://files.rjwebdesign.cz/i2/20190215-162522.png)](http://files.rjwebdesign.cz/f/20190215-162324.mp4)

---
_Source: https://npm.io/package/@kcko/bootstrap4-font-size-helper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._