https://github.com/kaizenplatform/kaizen-ui-colors
Sass variables for Kaizen Platform UI colors
https://github.com/kaizenplatform/kaizen-ui-colors
Last synced: about 1 year ago
JSON representation
Sass variables for Kaizen Platform UI colors
- Host: GitHub
- URL: https://github.com/kaizenplatform/kaizen-ui-colors
- Owner: kaizenplatform
- Created: 2014-12-02T02:15:16.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-06-25T08:34:20.000Z (almost 8 years ago)
- Last Synced: 2024-04-14T10:08:19.050Z (about 2 years ago)
- Language: CSS
- Homepage: http://kaizenplatform.github.io/kaizen-ui-colors
- Size: 75.2 KB
- Stars: 5
- Watchers: 37
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
kaizen-ui-colors
================
[](https://circleci.com/gh/kaizenplatform/kaizen-ui-colors)
Sass Variables for Kaizen Platform UI Colors
## Preview
http://kaizenplatform.github.io/kaizen-ui-colors
## Installation
### Use from Compass Project
#### Gemfile
```rb
gem 'compass-kaizen-ui-colors', git: 'git@github.com:kaizenplatform/kaizen-ui-colors.git'
```
#### In your SASS file
```sass
@import "kaizen-ui-colors"
```
### Install with npm
```
npm install @kaizenplatform/kaizen-ui-colors
```
## Development
### Compile & show preview
```
npm run compile
```
## Use JSON Data in Node.js
First, install with npm.
```
npm install @kaizenplatform/kaizen-ui-colors
```
Then, you can load the JSON data.
```javascript
var json = require('kaizen-ui-colors');
```
```javascript
import json from 'kaizen-ui-colors';
```
## Use as TypeScript Library
`kaizen-ui-colors/lib` is an entry point which provides color schemas as TypeScript library.
### colors
`colors` module is a typed color schema.
You can import it and use as below:
```ts
import { colors } from 'kaizen-ui-colors/lib';
const color: string = colors.lava_lighter__febebe; // `name_modifier__hex`
```