diff --git a/packages/tailwindcss-plugin/README.md b/packages/tailwindcss-plugin/README.md index 748da9d..97fc434 100644 --- a/packages/tailwindcss-plugin/README.md +++ b/packages/tailwindcss-plugin/README.md @@ -25,6 +25,8 @@ pnpm add @krds-ui/tailwindcss-plugin ## 사용법 +### Setup + ```js // tailwind.config.js /** @type {import('tailwindcss').Config} */ @@ -37,7 +39,78 @@ export default { }; ``` +### Typography + +KRDS Design System의 타이포그래피 시스템 사용법입니다. + +```tsx +// Display +

Display L

// 66px +

Display M

// 50px +

Display S

// 40px + +// Heading +

Heading L

// 50px +

Heading M

// 40px +

Heading S

// 32px + +// Body +

Body L

// 19px +

Body M

// 17px +

Body S

// 15px + +// Mobile 대응 +

Display L Mobile

// 40px +

Body L Mobile

// 19px +``` + +### Color + +브랜드 컬러 시스템을 제공합니다. 각 색상은 0부터 100까지의 단계를 가지고 있습니다. + +```tsx +// Primary Colors +
Primary Default (#246BEB)
+
Primary 50
+
Primary 30
+ +// Secondary Colors +
Secondary Default (#003675)
+
Secondary 50
+ +// Gray Scale +
Gray 50
+
Gray 30
+ +// Point Colors +
Point Default (#E71825)
+
Danger Default (#EB003B)
+
Warning Default (#FFB724)
+
Success Default (#008A1E)
+``` + +### Breakpoints + +반응형 디자인을 위한 브레이크포인트를 제공합니다. + +```tsx +// 브레이크포인트 기준 +mobile: 360px ~ 600px +tablet: 601px ~ 1024px +desktop: 1025px ~ + +// 사용 예시 +
+ 반응형 너비 조절 +
+ +
+ 태블릿 이상에서만 표시 +
+``` + ## 포함된 테마 - Typography 스타일 (텍스트 크기, 행간, 글자 간격) - Color +- Breakpoints diff --git a/packages/tailwindcss-plugin/krds-plugin.js b/packages/tailwindcss-plugin/krds-plugin.js index 2c966c8..077aad9 100644 --- a/packages/tailwindcss-plugin/krds-plugin.js +++ b/packages/tailwindcss-plugin/krds-plugin.js @@ -4,6 +4,15 @@ module.exports = plugin( function({ addBase, addUtilities, addComponents, theme }) {}, { theme: { + screens: { + // If you need more info about this, check https://uiux.egovframe.go.kr/guide/style/style_05.html + // ~600px: mobile + mobile: '360px', + // 601px ~ 1024px: tablet + tablet: '601px', + // 1025px ~: desktop + desktop: '1025px', + }, extend: { colors: { primary: {