Skip to content

Generate SCSS and CSS vars from tokens file #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ryan-ludwig wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Generate SCSS and CSS vars from tokens file #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18cab58
refactor!: add value property for use with Style Dictionary tool
ryan-ludwig Nov 24, 2021
18ee8f7
feat: add style-dictionary to generate SCSS and CSS variables from ou…
ryan-ludwig Nov 24, 2021
d90da05
fix: update references to primitives.json to use value property
ryan-ludwig Nov 24, 2021
8e44694
docs: update readme to show SCSS and CSS usage
ryan-ludwig Nov 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
.DS_Store
node_modules/
dist/
.nuxt/
npm-debug.log*
.eslintcache
Expand Down
32 changes: 31 additions & 1 deletion @kiva/kv-tokens/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,40 @@ The package contains

## Using the Design Definitions

### With JavaScript

```js
const designTokens = require("@kiva/kv-tokens/primitives.json");

const primaryTextColor = designTokens.colors.theme.DEFAULT.text.primary;
const primaryTextColor = designTokens.colors.theme.DEFAULT.text.primary.value;
```

### With SCSS

```scss
@import "./node_modules/@kiva/kv-tokens/dist/scss/_variables";

body {
background-color: $colors-theme-default-background-primary;
color: $colors-theme-default-text-primary;
font-size: #{$font-sizes-base-lg}px;
}
```

### With CSS Custom Properties

```html
<link
rel="stylesheet"
href="./node_modules/@kiva/kv-tokens/dist/css/variables.css"
/>
<style>
body {
background-color: var(--colors-theme-default-background-primary);
color: var(--colors-theme-default-text-primary);
font-size: calc(var(--font-sizes-base-lg) * 1px);
}
</style>
```

## Using the Tailwind Preset
Expand Down
36 changes: 35 additions & 1 deletion @kiva/kv-tokens/configs/kivaColors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const buildCSSVarsFromTokens = (theme) => {

const properties = Object.keys(theme[category]);
properties.forEach((property) => {
customProperties[`--${twPrefix}-${property}`] = hexToRGB(theme[category][property]);
customProperties[`--${twPrefix}-${property}`] = hexToRGB(theme[category][property].value);
});
});
return customProperties;
Expand Down Expand Up @@ -78,8 +78,42 @@ const buildColorChoices = (themeProperty) => {
return property;
};

/**
* Reshapes an object from
* {
* brand: {
* 100: {
* value: "somehex"
* },
* 200: {
* value: "somehex"
* }
* ...
* }
* }
*
* to
*
* {
* brand: {
* 100: "somehex",
* 200: "somehex"
* ...
* }
* }
*/

const buildTailwindColorObjectFromTokens = (tokenGroup) => {
const ret = {};
Object.keys(tokenGroup).forEach((group) => {
ret[group] = tokenGroup[group].value;
});
return ret;
};

module.exports = {
buildColorChoices,
buildTailwindColorObjectFromTokens,
defaultTheme,
darkTheme,
darkGreenTheme,
Expand Down
Loading