@kiva/kv-tokens
v2.16.0
Published
The package contains
Downloads
569
Keywords
Readme
kv-tokens
The package contains
- A JSON file specifying the design definitions of Kiva's style guide.
- A custom Tailwind configuration set to Kiva's style guide that can be used as a preset for your Tailwind project.
Install
npm i --save-dev @kiva/kv-tokens
Using the Design Definitions
const designTokens = require("@kiva/kv-tokens/primitives.json");
const primaryTextColor = designTokens.colors.theme.DEFAULT.text.primary;
Using the Tailwind Preset
// tailwind.config.js
module.exports = {
presets: [require("@kiva/kv-tokens/configs/tailwind.config")],
// Project-specific customizations
theme: {
//...
},
content: [
//...
],
// ...
};
See the Tailwind documentation for more information on using a preset.
Notable Config Differences
Our Tailwind config has some differences to the standard install. Notably
- All Tailwind classes are prefixed with "tw-". E.g.,
tw-mb-1
instead ofmb-1
. - Themable color names instead of the default Tailwind colors. E.g.,
tw-bg-primary
instead oftw-bg-gray-500
. See our Storybook for possible names. - Our spacing scale is based on 8px rather Tailwind's default 4px.
Contribution Guidelines
The Kiva UI project is bound by a Code of Conduct.
Kiva welcomes outside contributions to our UI repository. If you have any ideas for a feature or improvement, create an issue and we can discuss whether it makes sense to create a pull request. Thanks for the help!