UNDER CONSTRUCTION

This project is currently in very early stages. Please understand that many things are subject to change without notice untill stable is announced.

Installation

Tailwind makes it super easy to install a plugin using npm, yarn, etc…

Tailwindcss

For a full Installation of tailwind please see their docs

Liftkit plugin

npm i -D liftkit-tailwindcss

Basic configuration

To add the plugin simply copy the require portion below.

/** tailwind.config.js **/
/** @type {import('tailwindcss').Config} */
module.exports = {
  // ...
  plugins: [
    require('liftkit-tailwindcss')({
        usePrefix: true
    }),
  ]
}

Features

This covers the classes that are added when installed.

Scaling System

The scaling system is applied to all relavent options inside the tailwind system. It can be adressed by its lk prefix. For example padding-lk-sm will result in the correct scale. The math works as follows: let B = base value to which the system scales. let P = the power this is raised to. in B^P = value; positive values result in order of magnitude high numbers. negative results in sqrt values smaller than the original.

classvalueBP
2xs0.2360821.618-3
xs0.3819821.618-2
sm0.6180461.618-1
md11.6180
lg1.6181.6181
xl2.6179241.6182
2xl4.2358011.6183

Typography

classDefault Weight ClassEmphasized Weight ClassSize ClassLine HeightLetter Spacing
text-display-1font-normalfont-bold4.235em1.129-0.022
text-display-2font-normalfont-bold2.618em1.272-0.0
text-title-1font-normalfont-bold2.058em1.272-0.0
text-title-2font-normalfont-semibold1.618em1.272-0.02
text-title-3font-normalfont-semibold1.272em1.272-0.017
text-headingfont-semiboldfont-bold1.129em1.272-0.014
text-subheadingfont-normalfont-semibold0.885em1.272-0.007
text-bodyfont-normalfont-semibold1em1.618-0.011
text-calloutfont-normalfont-semibold0.943em1.272-0.009
text-labelfont-mediumfont-bold0.835em1.272-0.004
text-captionfont-normalfont-semibold0.786em1.272-0.007
text-overlinefont-normalfont-semibold0.786em1.2720.0618