Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

DesignSystemLab/design-system

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

761 Commits
761 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

J Design System

jds-thumb

Introduction

๐Ÿ’Ž J Design System์€ ์—ฌ๋Ÿฌ ์žฌ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•œ ํ•ต์‹ฌ์ ์ธ UI ์ปดํฌ๋„ŒํŠธ๋ฅผ ๋‹ด์•„๋‚ด๊ณ  ์žˆ๋Š” React์—์„œ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” Design System UI Library ์ž…๋‹ˆ๋‹ค. ๋น ๋ฅด๊ณ  ์‰ฝ๊ฒŒ ์ ์šฉํ•  ์ˆ˜ ์žˆ๋Š” ๋‹จ์ˆœํ•œ ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ์ง€ํ–ฅํ•˜์˜€์œผ๋ฉฐ, ์›น ์ ‘๊ทผ์„ฑ์„ ์ตœ๋Œ€ํ•œ ์ค€์ˆ˜ํ•˜์˜€์Šต๋‹ˆ๋‹ค.

Why you should use J Design System

  • โšก๏ธ Compound Component ๊ตฌ์กฐ์™€ ์ผ๊ด€์„ฑ ์žˆ๋Š” ์†์„ฑ ๊ตฌ์กฐ๋ฅผ ํ†ตํ•ด ๊ฐ„๊ฒฐํ•œ ์‚ฌ์šฉ์ž ์ธํ„ฐํŽ˜์ด์Šค๋ฅผ ์œ ์ง€ํ•˜๋„๋ก ํ•˜์˜€์Šต๋‹ˆ๋‹ค.
  • ๐ŸŒˆ as ์†์„ฑ์„ ํ†ตํ•ด ์ปดํฌ๋„ŒํŠธ ๋‹คํ˜•์„ฑ์„ ์ง€์›ํ•˜๋„๋ก ๊ตฌํ˜„ํ–ˆ์Šต๋‹ˆ๋‹ค.
  • โš ๏ธ ์›น ์ ‘๊ทผ์„ฑ์„ ๊ณ ๋ คํ•ด ์ ์ ˆํ•œ html role์„ ์‚ฌ์šฉํ•˜์—ฌ ์ปดํฌ๋„ŒํŠธ๋ฅผ ๊ตฌ์„ฑํ•˜์˜€์Šต๋‹ˆ๋‹ค.
  • ๐Ÿงฉ ๋‹ค์–‘ํ•œ ์‚ฌ์šฉ ํ™˜๊ฒฝ์„ ๊ณ ๋ คํ•ด cjs, esm ๋ชจ๋“ˆ์„ ์ง€์›ํ•˜๋„๋ก ๋ฒˆ๋“ค๋ง์„ ๊ตฌ์„ฑํ•˜์˜€์Šต๋‹ˆ๋‹ค.
  • โŒจ๏ธ Uncontrolled Component ํŠน์„ฑ์„ ํ™œ์šฉํ•ด ์ธํ„ฐ๋ž™์…˜์ด ํ•„์š”ํ•œ ์ปดํฌ๋„ŒํŠธ๋“ค์„ ์ง€์›ํ•˜์˜€์Šต๋‹ˆ๋‹ค.
  • ๐Ÿ’ซ Form ๊ด€๋ จ ์ปดํฌ๋„ŒํŠธ๋“ค์€ React Hook Form์„ ์ง€์›ํ•ฉ๋‹ˆ๋‹ค.

Project Overview

Installation

๐Ÿ’… Emotion ํ™˜๊ฒฝ์—์„œ ๋™์ž‘ํ•˜๊ธฐ ๋•Œ๋ฌธ์— emotion dpendency๊ฐ€ ํ•„์š”ํ•ฉ๋‹ˆ๋‹ค.
React UI Component

npm install --save @jdesignlab/react @emotion/react@^11

SVG Icons

npm install --save @jdesignlab/react-icons @emotion/react@^11

์•„๋ž˜์™€ ๊ฐ™์ด ํ•„์š”ํ•œ UI ์ปดํฌ๋„ŒํŠธ๋ฅผ importํ•˜์—ฌ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ฐ ์ปดํฌ๋„ŒํŠธ์˜ README๋ฅผ ์ฐธ๊ณ ํ•˜์‹œ๋ฉด ์ž์„ธํ•œ ์ธํ„ฐํŽ˜์ด์Šค์™€ ์‚ฌ์šฉ๋ฒ•์„ ํ™•์ธํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ์•„๋ž˜ ๋งํฌ๋ฅผ ํด๋ฆญํ•˜์‹œ๋ฉด ๊ฐ ์ปดํฌ๋„ŒํŠธ์˜ README๋กœ ์ด๋™ํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

import { Text, TextInput, Button, Modal, ... } from '@jdesignlab/react';
import {Mail, Bell, Book, ...} from '@jdesignlab/react-icons'

Components

Box

Button

Card

Checkbox

Drawer

Dropdown

Flex

Input

Modal

Popover

Radio

Select

Stack

Tabs

Text

Textarea

Tooltip

Contributors

yondo123
yoycode
tooooo1 helen

Convention

Commit Convention

rule description
โœจ Feat ์ƒˆ๋กœ์šด ๊ธฐ๋Šฅ์„ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
๐ŸŽจ Style ์ฝ”๋“œ ์Šคํƒ€์ผ ๊ทœ์น™์„ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.
โž– Remove ์‚ฌ์šฉ๋˜์ง€ ์•Š๋Š” ํŒŒ์ผ ๋˜๋Š” ์ฝ”๋“œ๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.
๐Ÿ—๏ธ Structure ํ”„๋กœ์ ํŠธ ๊ตฌ์กฐ๋ฅผ ๋ณ€๊ฒฝํ•ฉ๋‹ˆ๋‹ค.
๐Ÿ”ง Modify ๊ธฐ๋Šฅ์— ์˜ํ–ฅ์„ ์ฃผ์ง€ ์•Š๋Š” ์ฝ”๋“œ๋ฅผ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.
๐Ÿ› Fix ๊ธฐ๋Šฅ์˜ ๋ฌธ์ œ ์‚ฌํ•ญ ๋˜๋Š” ์ „๋ฐ˜์ ์ธ ํ”„๋กœ์ ํŠธ ๋‚ด ์ด์Šˆ๋ฅผ ํ•ด๊ฒฐํ•ฉ๋‹ˆ๋‹ค.
โ™ป๏ธ Refactor ์„ฑ๋Šฅ์ด๋‚˜ ์ฝ”๋“œ์˜ ๊ตฌ์กฐ๋ฅผ ๊ฐœ์„ ํ•ฉ๋‹ˆ๋‹ค.
๐Ÿ“ Doc ๋ฌธ์„œ๋ฅผ ์ž‘์„ฑํ•˜๊ฑฐ๋‚˜ ํŽธ์ง‘ํ•ฉ๋‹ˆ๋‹ค.
๐Ÿคก Chore ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ๋™์ž‘์— ์˜ํ–ฅ์„ ์ฃผ์ง€ ์•Š๋Š” ์ฝ”๋“œ๋“ค์„ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค. (package version, configure)
๐Ÿš€ Deploy ํŒจํ‚ค์ง€๋ฅผ ๋ฐฐํฌํ•ฉ๋‹ˆ๋‹ค.
๐Ÿงช Test ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๋ฅผ ์ž‘์„ฑํ•ฉ๋‹ˆ๋‹ค.
๐Ÿ’„ Ui ์Šคํƒ€์ผ๋ง์„ ์œ„ํ•œ ์ฝ”๋“œ๋ฅผ ์ˆ˜์ •ํ•˜๊ฑฐ๋‚˜ ์ถ”๊ฐ€ํ•ฉ๋‹ˆ๋‹ค.
Morty Proxy This is a proxified and sanitized view of the page, visit original site.