bitandblack-typography
v1.1.0
Published
Helps writing good typography in SCSS
Downloads
236
Maintainers
Readme
Bit&Black Typography
Helps writing good typography in SCSS.
Installation
This library is made for the use with NPM, Yarn and Composer. Use one of them to add it to your project:
Node
$ npm install bitandblack-typography
Yarn
$ yarn add bitandblack-typography
Composer
$ composer require bitandblack/typography
Usage
Typography provides some mixins which will make it easy to improve the typography on your page.
Balance ragged lines
Use @import balance-ragged-lines()
to get the width property.
You can define that variable globally or be calling the mixin:
$typo-balance-ragged-lines-value
. Default is103%
.
Box decoration break
Use @import box-decoration-break()
to get the box-decoration-break property.
You can define that variable globally or be calling the mixin:
$typo-box-decoration-break
. Default isclone
.
Columns
Use @import columns()
to get all the column related properties.
You can define those variables globally or be calling the mixin:
$typo-column-count
. Default is3
.$typo-column-gap
. Default is1rem
.
Color scheme
Use @import color-scheme-dark()
or @import color-scheme-light()
to make a difference in your layout depending on the users color scheme setting.
Hanging punctuation
Use @import hanging-punctuation()
to get the hanging-punctuation property.
You can define that variable globally or be calling the mixin:
$typo-hanging-punctuation
. Default isfirst last allow-end
.
Hyphens
Use @import hyphens()
to get all hyphen related properties.
You can define those variables globally or be calling the mixin:
$only-if-fully-supported
. Default isfalse
.$typo-hyphens-limit-before
. Default is3
.$typo-hyphens-limit-after
. Default is3
.$typo-hyphens-limit-word
. Default is6
.$typo-hyphens-limit-lines
. Default is3
.$typo-hyphens-limit-last
. Default isalways
.$typo-hyphens-limit-zone
. Default is8%
.
Indent
Use @import indent()
to get all indent related properties.
You can define those variables globally or be calling the mixin:
$typo-indent-value
. Default is1rem
.$typo-indent-first-element
. Default isfalse
.
Keep lines
Use @import keep-lines()
to get all properties to keep lines together.
You can define those variables globally or be calling the mixin:
$typo-orphans-value
. Default is2
.$typo-widows-value
. Default is2
.
Page break
Use @import page-break-before()
, @import page-break-inside()
or @import page-break-after()
to get the properties to keep elements together.
You can define those variables globally or be calling the mixin:
$typo-page-break-before
. Default isavoid
.$typo-page-break-inside
. Default isavoid
.$typo-page-break-after
. Default isavoid
.
SCSS and CSS
If you don't have the possibility to use the scss
files, you can use the pre-compiled css
file in the dist
folder. Please note, that you lose the possibility to configure the stylesheets by your needs then.
Help
If you have any questions, feel free to contact us under [email protected]
.
Further information about Bit&Black can be found under www.bitandblack.com.