LiftKit is a UI framework that makes you a better designer without even realizing it. At its core, it's a platform-agnostic system of formulas for scaling, spacing, and color that automatically enforce high-detail design principles behind the scenes. You get easy utility classes, and LiftKit applies golden ratio scaling, optical symmetry, and contrast ratio checks for you under the hood.
- The following instructions are easier to read on our website: See Documentation
This is the official repository. Currently, it only has support for Next.js without Tailwind. The project is mmaintained by Chainlift, which is itself maintained entirely by part-time contributors. So while we do plan to expand support to every framework imaginable, we are currently limited by time and availability.
Community contributors are responsible for their own forks. However, we help out however we can by adding serious contributors to our internal Slack, where they can communicate and collaborate with everyone else working on the project.
Not officially supported by Chainlift, but we do communicate with the owners. Contact each project's owner for support.
We strongly prefer that contributors work with us directly to maintain the system's integrity.
If interested in contributing and being listed on our site and this readme, contact [email protected] with a brief introduction and description of how you'd like to help.
This documentation assumes the following:
- You already have Node.js, npm, and Git installed on your local machine
- You’re familiar with basic terminal commands like
cd
-
Paste the following command into your terminal to clone the template:
git clone https://github.com/Chainlift/liftkit-template.git
-
cd
into the newly-created project.- If you get an error that says
direnv: error
, just ignore it. It's a bug we'll fix soon.
- If you get an error that says
-
Run:
npm install
-
Install the components you need (see section 2 below).
-
Import LiftKit’s CSS into your app’s
globals.css
:@import url("@/lib/css/index.css");
A blank Next.js project with LiftKit Core’s config files pre-installed—fastest way to get up and running.
-
cd
into your project’s root directory. -
Install LiftKit CLI as a dev dependency:
npm install @chainlift/liftkit --save-dev
-
Initialize LiftKit:
npx liftkit init
- If prompted to add an
add
script topackage.json
, say yes. - If prompted to install shadcn as a devDependency, say yes.
- If prompted to add an
-
Install the components you need (see section 2 below).
-
Import LiftKit’s CSS into your app’s
globals.css
:@import url("@/lib/css/index.css");
It adds two files to your project root:
components.json
tailwind.config.ts
You do not need Tailwind itself to use LiftKit—just the config file for now.
LiftKit Core is just the base config. LiftKit Components are the actual UI components (with their CSS). At build time, unused CSS is tree-shaken away.
Method | Instructions | Command |
---|---|---|
Everything | All components, CSS, and types | npm run add all |
One Component | Specified component only (with its CSS and types) | npm run add component-name-kebab-case |
Base | CSS and types only | npm run add base |
If warned about React 19 compatibility, add
--force
and proceed.
- I only installed one component, but it installed multiple. Why?
Some components import others. E.g., installing
Badge
also brings inIcon
. - Why did it install CSS for components I’m not using? By design—to let you play freely. Unused styles are removed at build time.
- How can I get rid of unused CSS? It’s automatically removed at build time.
- Does LiftKit require Tailwind?
No—only a
tailwind.config.ts
file is needed (a requirement of the current registry). Tailwind itself is not a dependency.
Warning: It’s currently a dumpster fire. We’re working on improvements—contributors welcome!
- View File on Figma (opens in new tab)
-
We know. We’ll fix it soon.
- Buttons adjust padding based on icon presence, and padding values aren’t controllable via props.
- Our only option was to list everything explicitly—clearly a bad idea in hindsight.
-
Figma doesn’t support margins or
em
units, so we converted everything to pixels (assuming1rem = 16px
). -
Variables are organized into collections:
- Global collection = base
LkSizeUnit
variables - Text Spacing Vals = subsets per
LkFontClass
, simulating spacing props like.m-bottom-xs
- Global collection = base
- View on Made in Webflow (opens in new tab)