Skip to content
/ cds Public

๐ŸงŠ ์ฐจ๊ฐ€์šด ๋””์ž์ธ ์‹œ์Šคํ…œ

License

Notifications You must be signed in to change notification settings

c-h-w-h/cds

Repository files navigation

๐ŸงŠ @cwhw/cds

์ฐจ๊ฐ€์šด ๋””์ž์ธ ์‹œ์Šคํ…œ (CDS, Cold Design System) ์€ React ์ปดํฌ๋„ŒํŠธ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ์ž…๋‹ˆ๋‹ค.

์ผ๊ด€์ ์ธ UI ๋””์ž์ธ๊ณผ ์ ‘๊ทผ์„ฑ์„ ๊ณ ๋ คํ•œ ์‚ฌ์šฉ์ž ์ธํ„ฐ๋ž™์…˜์„ ์ œ๊ณตํ•ฉ๋‹ˆ๋‹ค.

Storybook ๋ฌธ์„œ ์—์„œ ์ œ๊ณตํ•˜๋Š” ์ปดํฌ๋„ŒํŠธ์˜ ์ข…๋ฅ˜์™€ ์šฉ๋ก€๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Installation

npm install @chwh/cds
yarn add @chwh/cds

Usage

โš ๏ธ ์‚ฌ์šฉ์„ ์œ„ํ•ด ์ƒ์œ„ ์ปดํฌ๋„ŒํŠธ๋ฅผ CdsProvider๋กœ ๊ฐ์‹ธ์•ผ ํ•ฉ๋‹ˆ๋‹ค.

const App = () => {
  return (
    <CdsProvider>
      // ... your components
    </CdsProvider>
  );
};

๐Ÿ’… ์•„๋ž˜ ์ธํ„ฐํŽ˜์ด์Šค ์ค‘ ์ผ๋ถ€๋ฅผ ์žฌ์ •์˜ํ•œ ๊ฐ์ฒด๋ฅผ CdsProvider์˜ themeColor props๋กœ ์ „๋‹ฌํ•ด ํ…Œ๋งˆ ์ปฌ๋Ÿฌ๋ฅผ ๋ณ€๊ฒฝํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

type ColorSet = {
  primary: Property.Color;
  primaryLight: Property.Color;
  primaryDark: Property.Color;

  alert: Property.Color;
  info: Property.Color;
  success: Property.Color;
  warning: Property.Color;
  error: Property.Color;

  black: Property.Color;
  white: Property.Color;
  offWhite: Property.Color;
  background: Property.Color;
  gray100: Property.Color;
  gray200: Property.Color;
  gray300: Property.Color;
  gray400: Property.Color;
};

Contributors

@prayinforrain @iyu88 @se030 @leesunmin1231 @dohun31

About

๐ŸงŠ ์ฐจ๊ฐ€์šด ๋””์ž์ธ ์‹œ์Šคํ…œ

Resources

License

Stars

Watchers

Forks

Packages

No packages published