yeun/open-color

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 242 Commits
.github		.github
builder		builder
docs		docs
templates		templates
tests		tests
.gitignore		.gitignore
.npmignore		.npmignore
.travis.yml		.travis.yml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
bower.json		bower.json
build_release		build_release
compile-templates.js		compile-templates.js
open-color.css		open-color.css
open-color.d.ts		open-color.d.ts
open-color.js		open-color.js
open-color.json		open-color.json
open-color.less		open-color.less
open-color.oco		open-color.oco
open-color.rcpx		open-color.rcpx
open-color.scss		open-color.scss
open-color.styl		open-color.styl
open-color.tex		open-color.tex
package-lock.json		package-lock.json
package.json		package.json

Repository files navigation

Open color

Open color is an open-source color scheme optimized for UI like font, background, border, etc.

Goals

All colors shall have adequate use
Provide general color for UI design
All colors will be beautiful in itself and harmonious
At the same brightness level, the perceived brightness will be constant

Note

The colors are subject to change in the future. Thus, using an Open color as a main identity color is not recommended.

Available Colors

available colors

Installation

$ npm install open-color

$ bower install open-color

Currently Supported Formats, Language Environments, Libraries

CSS, Sass, Less, Stylus, JSON, SVG, TeX, Open Color Tools (.oco), PowerPaint (.rcpx), Sketch (.sketchpalette), Inkscape, aco, clr, Tailwind, TypeScript

Variable Convention

Sass, SCSS

$oc-(color)-(number)

Less

@oc-(color)-(number)

Stylus

oc-(color)-(number)

CSS

--oc-(color)-(number)

oc: Abbreviation for Open color
(color): Color name such as gray, red, lime, etc.
(number): 0 to 9. Brightness spectrum.

How to Use

Import the file to your project and use the variables.

Example for Sass, SCSS

@import'path/open-color';
.body {
 background-color: $oc-gray-0;
 color: $oc-gray-7;
}
a {
 color: $oc-teal-7;
 &:hover,
 &:focus,
 &:active {
 color: $oc-indigo-7;
 }
}

Example for Tailwind CSS

module.exports = {
 presets: [require("./open-color.js")],
 purge: [],
 mode: "jit",
 darkMode: false,
 theme: {
 extend: {},
 },
 variants: {
 extend: {},
 },
 plugins: [],
};

Example for Less

@import 'path/open-color';
.body {
 background-color: @oc-gray-0;
 color: @oc-gray-7;
}
a {
 color: @oc-teal-7;
 &:hover,
 &:focus,
 &:active {
 color: @oc-indigo-7;
 }
}

Example for Stylus

@import 'path/open-color.styl'
.body
 background-color: oc-gray-0
 color: oc-gray-7
a
 color: oc-teal-7
 &:hover
 &:focus
 &:active
 color: oc-indigo-7

Example for CSS

@import 'path/open-color.css';
.body {
 background-color: var(--oc-gray-0);
 color: var(--oc-gray-7);
}
a {
 color: var(--oc-teal-7);
}
a:hover,
a:focus,
a:active {
 color: var(--oc-indigo-7);
}