@gdsc-yonsei/color v1.0.0

@gdsc-yonsei/color package

Semantic color system package for GDSC Yonsei chapter system.

For additional infos, refer to GDSC Yonsei chapter color system Figma page.

Getting Started

This package can be installed by using package manager.

We recommend using 'yarn' package manager.

# yarn (most recommmended)
yarn add @gdsc-yonsei/color

# npm
npm install --save @gdsc-yonsei/color

Usage

1. Semantic Colors 🎨

import { content, background } from '@gdsc-yonsei/color';

const ExampleComponent = () => {
   return (
      <main style={{ backgroundColor: background.common.primary.blue }}>
        <span style={{ color: content.tint.blue.a3.blue }}>
      </main>
   )
}

Semantic colors are color tokens which named after what they represents.

Colors are not exported itself, rather exported as a collection of usage.

We recommend using semantic colors using hooks(useSemanticColor) or css variables.

useSemanticColor hooks provides colorset of components according to predefined theme or custom theme. For more information, refer to the docs of useSemanticColor hooks.

If you wish to access color tokens by css variables, predefined css global variables are injected from \. Childrens of \ can access to css global variables by '--' prefix. Refer to example below for detailed usage.

🚨 Direct usage of color tokens is not recommended as each color tokens are automatically set by context. Import it when original color token string is required in particual situations.

import { useSemanticColor, ColorTheme } from '@gdsc-yonsei/color';

const ExampleComponent = () => {
   // get background color token object according to theme defined in <GlobalStylesProvider />
   const { background } = useSemanticColor();

   // for color token of particular color theme.
   const { button } = useSemanticColor(ColorTheme.Green); 

   return (
      <main style={{ backgroundColor: background.common.primary }}>
        <button style={{ backgroundColor: button.primary.background.common }}>
      </main>
   )
};

// if you are using styled-components or css
import styled from 'styled-components';

const Main = styled.main`
   // ...
   background-color: var(--background-common-primary);
   color: var(--background)
`;

const Button = styled.button`
   //...
   background-color: var(--button-primary-background-common);

   &:hover {
      background-color: var(--button-primary-background-active);
   }

   &:active {
      background-color: var(--button-primary-background-pressed);
   }
`

const ExampleComponent2 = () => {
   return (
      <Main>
         <Button />
         {...}
      </Main>
   )
};

2. GlobalStylesProvider & Theme 🌍

GlobalStylesProvider plays as a role of setting overall theme context and injecting css variables at the top of DOM tree.

Changing theme will automatically change all semantic color tokens. (No need to worry about changing colors according to themes :P )

Children components or elements which desire to use semantic color tokens should be under GlobalStylesProvider, so it is highly recommended to wrap overall application with \ at the uppermost component.

Predefined theme can be set by importing 'ColorTheme' enum. ColorTheme enum has four members, Blue, Green, Yellow, and Red. If unset, default theme is Blue(ColorTheme.Blue).

Details of each color theme can be found in Figma page.

import { GlobalStylesProvider } from '@gdsc-yonsei/color';

const MyGorgeousApp = () => {
   // if not given, default theme is set as blue(ColorTheme.Blue).
   return (
      <GlobalStylesProvider>
         {...}
      </GlobalStylesProvider>
   )
};

import { GlobalStylesProvider, ColorTheme } from '@gdsc-yonsei/color';

const MyGorgeousGreenApp = () => {
   // Red theme is set!
   return (
      <GlobalStylesProvider theme={ColorTheme.Red}>
         {...}
      </GlobalStylesProvider>
   )
};

3. Utility Functions 🔧

GDSC Yonsei semantic color system providers color utilities for free transformation of semantic colors.

getHexcode

declare function getHexcode(string, number): string;

getHexcode converts color & transparency into color hexcode. When passing color string and its transparency, the function returns the corresponding hexcode.

getRgba

declare function getRgba(string, number): string;

getRgba provides the same result as getHexcode functions, but returns color code as RGBA format(rgba(R, G, B, A)).

Build & Publish 🛠️

@gdsc-yonsei/color and gdsc-ys-web monorepo uses yarn berry as a package manager.

Before build, make sure all dependencies are ready by installing all packages.

yarn

For ready-to-use build command, we recommend using command as follows at the root folder of monorepo package.

yarn color ready

If build command is successfully executed, use publish command as follows at the root folder of monorepo package.

gdsc-ys-web monorepo uses lerna-lite for manaing & publishing packages.

yarn lerna publish

Bug Report 🐛 & Contribution 🤝

Looking for contribution and bug reports, feel free to leave any issues of PRs to this repository!