docs(ai): add packaged AI guides for Web, SW and OrgChart
- Shared entry point docs/ai/AI_GUIDE.md (type selection Web / SW / OrgChart / mixed, steps 1-7, package style separation, report format, examples A-D) and AGENTS_SNIPPET.md, copied into every package ai/ folder - New ai/ docs for @hm-design/ui and @hm-design/org-chart (+ org-chart-react pointer): AI_USAGE, COMPONENT_CATALOG, DESIGN_RULES, COMPOSITION_PATTERNS - SW ai/ linked to the shared guide; catalog lists every Props type explicitly - "ai" added to package files of ui, org-chart, org-chart-react - scripts/ai-docs.mjs: sync:ai-docs / check:ai-docs (copies, files, catalog <-> exports, links) - Maintenance guide and verification record under docs/ai
This commit is contained in:
1 parent
e8409eff44
commit
fb74cd756f
34 files changed
+2396
-6
No files matched your search
@@ -30,4 +30,8 @@ For Dashboard work status colors, explicitly load the optional status stylesheet
|
||||
|
||||
The status stylesheet defines only `--hm-dashboard-status-active`, `--hm-dashboard-status-hold`, `--hm-dashboard-status-done` and `--hm-dashboard-status-issue`. It does not automatically style `Badge`, buttons or `data-status` attributes. Consumers must map these variables to their existing component styles; the repository's `docs/patterns/dashboard-layout.md` shows the Badge mapping. `done` resolves the existing white palette token in each `:root` / `[data-hm-theme]` scope. The other colors preserve the approved Dashboard values and are not additional Runtime Theme tokens.
|
||||
|
||||
From the HMDesignSystem repository, run `npm run build -w @hm-design/ui`. `npm pack` runs this build automatically. Only `dist/`, this README and the package manifest are packed; source and Storybook files are excluded.
|
||||
From the HMDesignSystem repository, run `npm run build -w @hm-design/ui`. `npm pack` runs this build automatically. Only `dist/`, `ai/`, this README and the package manifest are packed; source and Storybook files are excluded.
|
||||
|
||||
## AI coding tools
|
||||
|
||||
AI coding tools should read [`ai/AI_GUIDE.md`](./ai/AI_GUIDE.md) first (shared HMDesign entry point: choose Web / SW / OrgChart / mixed, then reuse → props → composition → minimal custom). Web-specific rules: [`ai/AI_USAGE.md`](./ai/AI_USAGE.md), [`ai/COMPONENT_CATALOG.md`](./ai/COMPONENT_CATALOG.md), [`ai/DESIGN_RULES.md`](./ai/DESIGN_RULES.md), [`ai/COMPOSITION_PATTERNS.md`](./ai/COMPOSITION_PATTERNS.md). To make a consumer project pick them up automatically, copy [`ai/AGENTS_SNIPPET.md`](./ai/AGENTS_SNIPPET.md) into its root `AGENTS.md` (see `AI_GUIDE.md` §9).
|
||||
@@ -0,0 +1,16 @@
|
||||
## HMDesign 디자인 시스템
|
||||
|
||||
<!-- HMDesign 패키지의 ai/AGENTS_SNIPPET.md에서 복사. 아래 "사용 유형"을 프로젝트에 맞게 고치거나, 정하지 않았으면 그 줄을 지운다. -->
|
||||
|
||||
HMDesign 사용 유형: Web | SW | OrgChart | 혼합(영역별로 적기)
|
||||
|
||||
화면·컴포넌트를 구현하거나 수정하기 전에 다음을 지킨다.
|
||||
|
||||
1. 설치된 HMDesign 패키지의 공통 가이드를 먼저 읽는다: `node_modules/@hm-design/<설치된 패키지>/ai/AI_GUIDE.md` (`ui`, `sw`, `org-chart`, `org-chart-react` 중 아무 사본이나 내용이 같다).
|
||||
2. 위 "사용 유형"이 없고 요청으로도 정할 수 없으면 코드 작성 전에 "어떤 HMDesign 디자인 시스템을 사용하시겠습니까? 1. Web 2. SW 3. OrgChart 4. 혼합 사용"을 묻는다. 정해져 있으면 다시 묻지 않는다.
|
||||
3. 선택한 패키지의 `ai/AI_USAGE.md` → `COMPONENT_CATALOG.md` → `DESIGN_RULES.md` → `COMPOSITION_PATTERNS.md` 순으로 필요한 절을 읽는다.
|
||||
- Web: `node_modules/@hm-design/ui/ai/`
|
||||
- SW: `node_modules/@hm-design/sw/ai/`
|
||||
- OrgChart: `node_modules/@hm-design/org-chart/ai/` (React는 `node_modules/@hm-design/org-chart-react/ai/AI_USAGE.md`도)
|
||||
4. 기존 컴포넌트 → Props → 조합 → (없는 부분만) 패키지 토큰으로 신규 구현 순서를 지킨다. 패키지 파일 수정·내부 경로 import·구현 복사·새 디자인 값 생성은 하지 않는다.
|
||||
5. Web / SW / OrgChart 스타일을 영역별로 분리하고, 완료 후 AI_GUIDE의 결과 보고 형식으로 재사용·신규·토큰·검증·NOT VERIFIED를 보고한다.
|
||||
@@ -0,0 +1,213 @@
|
||||
# HMDesign AI 작업 가이드 — 공통 진입점
|
||||
|
||||
> 이 파일은 HMDesign 패키지(`@hm-design/ui`, `@hm-design/sw`, `@hm-design/org-chart`, `@hm-design/org-chart-react`)의 `ai/AI_GUIDE.md`에 **같은 내용으로** 들어 있습니다. 원본은 HMDesign 저장소 `docs/ai/AI_GUIDE.md`이며 패키지 사본은 `npm run sync:ai-docs`로 갱신합니다. 사본을 직접 고치지 않습니다.
|
||||
|
||||
사용자가 "HMDesign 패키지를 기준으로 화면을 구현해 주세요"처럼 요청하면 AI 코딩 도구는 이 파일의 1~6단계를 순서대로 따릅니다. 이 문서와 각 패키지의 `ai/` 문서는 실제 공개 API·CSS에서 확인한 내용만 적습니다. 여기에 없는 컴포넌트·Props·토큰은 없는 것으로 취급합니다.
|
||||
|
||||
## 0. 읽는 순서
|
||||
|
||||
1. **이 파일**(어느 패키지의 사본이든 같음)
|
||||
2. 선택한 패키지의 `ai/AI_USAGE.md` → `ai/COMPONENT_CATALOG.md` → `ai/DESIGN_RULES.md` → `ai/COMPOSITION_PATTERNS.md`
|
||||
3. API가 의심스러우면 그 패키지의 `dist/*.d.ts`(공개 진입점에서 export되는 것만)
|
||||
|
||||
| 유형 | 패키지 | 지침 위치(설치 후) | JS 진입점 | CSS |
|
||||
|---|---|---|---|---|
|
||||
| ① Web UI | `@hm-design/ui` | `node_modules/@hm-design/ui/ai/` | `@hm-design/ui`, `@hm-design/ui/theme` | `@hm-design/ui/tailwind.css` + `@hm-design/ui/theme.css`(Tailwind CSS 4 필요), 선택 `@hm-design/ui/dashboard-status.css` |
|
||||
| ② SW UI | `@hm-design/sw` | `node_modules/@hm-design/sw/ai/` | `@hm-design/sw` | `@hm-design/sw/styles.css` |
|
||||
| ③ OrgChart | `@hm-design/org-chart`(Core) + React면 `@hm-design/org-chart-react` | `node_modules/@hm-design/org-chart/ai/` (React 어댑터 안내는 `node_modules/@hm-design/org-chart-react/ai/AI_USAGE.md`) | `@hm-design/org-chart`, `@hm-design/org-chart-react`, 선택 `@hm-design/org-chart-react/hm-dialog` | `@hm-design/org-chart/engine.css`, `@hm-design/org-chart/style.css`(URL로 전달 — Shadow DOM 안에 로드) |
|
||||
| 기타 | `@hm-design/center-graphic` | AI 지침 없음. 패키지 `README.md`만 | `@hm-design/center-graphic` | 자동 import |
|
||||
|
||||
모든 패키지는 서로 독립입니다(`@hm-design/org-chart-react`만 Core에 의존, `@hm-design/ui`는 `/hm-dialog`를 쓸 때만 선택 peer). React·React DOM `^19`는 peer입니다.
|
||||
|
||||
## 1단계. 사용 목적 확인
|
||||
|
||||
다음 순서로 판단하고, **판단되면 다시 묻지 않습니다.**
|
||||
|
||||
1. 소비 프로젝트의 `AGENTS.md`·`CLAUDE.md` 등에 `HMDesign 사용 유형:` 설정이 있으면 그대로 따릅니다(§9).
|
||||
2. 사용자 요청이 유형을 분명히 말하면 그대로 따릅니다.
|
||||
- Web: 웹 화면, 관리자·업무 화면, 목록·검색·Form, 대시보드, GNB/LNB, Dialog, Table …
|
||||
- SW: 데스크톱 SW, 뷰어, 도면·CAD, SW Header, 툴바, 레이어/색상/선스타일, 속성창·SW Popup …
|
||||
- OrgChart: 조직도, 조직 계층·직원 카드, 조직 JSON/CSV/Excel 시각화 …
|
||||
- 둘 이상이 함께 나오면 ④ 혼합(예: "업무 화면 안에 조직도" = Web + OrgChart).
|
||||
3. 위로 정할 수 없으면 코드 작성 전에 **그대로** 묻습니다.
|
||||
|
||||
> 어떤 HMDesign 디자인 시스템을 사용하시겠습니까?
|
||||
>
|
||||
> 1. Web
|
||||
> 2. SW
|
||||
> 3. OrgChart
|
||||
> 4. 혼합 사용
|
||||
|
||||
- `package.json`에 설치된 패키지가 하나뿐이어도 그것만으로 유형을 확정하지 않습니다(설치가 덜 된 상태일 수 있음). 요청 내용과 맞을 때만 근거로 씁니다.
|
||||
- 혼합을 고르면 영역별 패키지(예: "페이지 = Web, 가운데 영역 = OrgChart")를 확인합니다.
|
||||
- **OrgChart가 포함되고 생성 방식이 없으면** 같은 메시지에서 다음도 묻습니다(이미 말했으면 묻지 않음): "조직도만 기존 페이지에 삽입할까요(Chart Only), 아니면 레이아웃까지 구성한 새 페이지 전체를 생성할까요(Full Page)?" 상세는 `@hm-design/org-chart/ai/AI_USAGE.md` §1.
|
||||
- 선택한 패키지가 설치되어 있지 않으면 설치가 필요하다고 보고합니다. 다른 HMDesign 패키지나 임의 라이브러리로 대신하지 않습니다.
|
||||
|
||||
## 2단계. 패키지 분석
|
||||
|
||||
1. `node_modules/@hm-design/<패키지>/package.json`의 `version`·`exports`·`peerDependencies`를 확인합니다. `exports`에 없는 경로(`src/...`, `dist/components/...`)는 import하지 않습니다.
|
||||
2. 그 패키지의 `ai/` 문서를 §0 순서로 읽습니다. 필요한 절만 읽고 전체 `dist`를 훑지 않습니다.
|
||||
3. 카탈로그와 실제 `dist/index.d.ts`가 다르면 **`.d.ts`가 기준**입니다. 차이를 결과 보고에 적습니다.
|
||||
4. 소비 프로젝트의 기존 CSS 진입점·폰트·빌드 도구(Vite 등)·이미 쓰는 디자인 시스템을 확인합니다. 기존 프로젝트의 디자인 시스템을 바꾸지 않습니다.
|
||||
|
||||
## 3단계. 화면 분석
|
||||
|
||||
요청 화면을 항목으로 나누고 항목마다 판단을 기록합니다.
|
||||
|
||||
| 요청 항목 | 판단 | 근거(카탈로그의 실제 이름) |
|
||||
|---|---|---|
|
||||
| 예: 상단 메뉴 | 재사용 | Web `GNB` + `GNBMobileMenu` |
|
||||
| 예: 레이어 선택 | 재사용 | SW `SWHeaderLayerMenu` |
|
||||
| 예: 검색 상자(SW) | 신규 | SW 카탈로그에 없음 → `SWHeaderInput` 재사용 + SW 토큰 |
|
||||
|
||||
판단 값은 **재사용**(그대로) / **Props 설정**(기존 Variant·Props) / **조합**(기존 컴포넌트 배치) / **신규**(소비 프로젝트에 최소 구현) 중 하나입니다.
|
||||
|
||||
## 4단계. UI 구현
|
||||
|
||||
우선순위(위가 먼저):
|
||||
|
||||
1. 선택 패키지의 기존 컴포넌트·Pattern을 그대로 사용
|
||||
2. 기존 Variant / Props / Callback으로 해결
|
||||
3. 기존 컴포넌트 조합(배치용 CSS만 소비 프로젝트에 작성)
|
||||
4. 조합으로 안 되는 부분만 **소비 프로젝트에** 새로 구현 — 패키지 토큰만 읽고, 안쪽에 기존 컴포넌트를 재사용
|
||||
|
||||
규칙:
|
||||
|
||||
- `node_modules` 안 패키지 파일을 수정하지 않습니다. 패키지 `dist` 구현이나 내부 CSS 블록을 복사해 같은 컴포넌트를 다시 만들지 않습니다.
|
||||
- 이미 있는 컴포넌트와 같은 역할의 컴포넌트를 새로 만들지 않습니다(예: Web에 `Dialog`가 있는데 자체 Modal 작성 금지).
|
||||
- 새 디자인 값을 만들지 않습니다. 색·크기·간격·radius·그림자는 각 패키지 `DESIGN_RULES.md`의 토큰·확인값만 씁니다. 값이 없으면 추측하지 말고 사용자에게 확인합니다.
|
||||
- 공통: Font Weight는 400 / 500 / 700만 씁니다(600 없음). Light/Dark 분기를 만들지 않습니다. 새 컴포넌트 CSS에 `html`·`body`·`*` 전역 규칙을 넣지 않습니다. 새 class는 소비 프로젝트 접두사(예: `app-`)를 씁니다.
|
||||
- 요청에 없는 메뉴·통계·설명·다운로드·외부 API·AI 입력 UI를 추가하지 않습니다. 필요해 보이면 제안으로만 보고합니다.
|
||||
|
||||
### 없는 UI를 같은 스타일로 만들 때 확인할 항목
|
||||
|
||||
신규 항목마다 아래를 선택 패키지 `DESIGN_RULES.md`에서 찾아 그대로 적용합니다. 찾을 수 없는 항목은 "값 없음 — 사용자 확인 필요"로 보고합니다.
|
||||
|
||||
| 항목 | Web(`@hm-design/ui`) | SW(`@hm-design/sw`) | OrgChart |
|
||||
|---|---|---|---|
|
||||
| 토큰·CSS 변수 | `--hm-sem-*`, `--hm-color-*`, `--hm-radius-*`(`:root`) | `--hm-sw-header-*`, `--hm-sw-property-*`(`SWTheme` 범위) | `--hm-orgchart-*` 공개 입력(Shadow DOM 상속) |
|
||||
| 색·Typography | DESIGN_RULES §2·§3 | DESIGN_RULES §2·§3 | DESIGN_RULES §2·§3 |
|
||||
| 크기·여백 | DESIGN_RULES §4 | DESIGN_RULES §1 | 카드·간격 변경 금지(승인 디자인) |
|
||||
| Border·Radius·배경·그림자 | DESIGN_RULES §2·§4 | DESIGN_RULES §2·§8 | 공개 입력만 |
|
||||
| 아이콘 | `lucide-react`(패키지 의존성) | 패키지 내장 SVG만, 새 아이콘은 사용자 제공 | Core 내장 |
|
||||
| 스크롤바 | `ScrollArea`(Radix), DESIGN_RULES §6 | 전용 디자인 없음 — 브라우저 기본(AI_USAGE §2) | Core 내부 Zoom/Pan |
|
||||
| Hover / Active / Focus / Disabled | DESIGN_RULES §5 | DESIGN_RULES §4 | Core 내장 |
|
||||
| Popup·Panel | `Dialog`·`AlertDialog`·`Sheet`·`Drawer`·`Popover` | `SWPopup` + `SWPopupSection`/`SWPopupRow` | Core 팝업 / HM Dialog / 어댑터 |
|
||||
| 동작·키보드 | Radix 동작 유지 | 카탈로그 "공통 키보드" | Core 키보드(Pan, Alt+M 이동 등) |
|
||||
|
||||
## 5단계. 패키지별 디자인 분리 (혼합 사용 포함)
|
||||
|
||||
각 패키지의 스타일 범위는 다음과 같습니다(실제 CSS 기준).
|
||||
|
||||
| 패키지 | 스타일이 적용되는 범위 | 주의 |
|
||||
|---|---|---|
|
||||
| Web | `theme.css`의 토큰은 `:root, [data-hm-theme]`. `tailwind.css`는 Tailwind base에서 `*`(border·outline), `body`(배경·글자), `html`(글꼴)을 **문서 전체에** 적용. 앱이 import하는 `tailwindcss`의 Preflight도 전역 | Web CSS를 넣은 문서에서는 다른 영역에도 전역 초기화가 적용됨 |
|
||||
| SW | 토큰은 `.hm-sw-header`와 `.hm-sw-theme`(`<SWTheme>`)에만 정의. 전역 선택자 없음 | Header 밖 SW 부품은 반드시 `<SWTheme>` 안 |
|
||||
| OrgChart | Core가 자기 open Shadow DOM에만 CSS 로드. 호스트 CSS selector는 안쪽에 닿지 않고 **Custom Property 상속만** 통과 | 호스트 class로 카드 모양을 바꾸려 하지 않음 |
|
||||
|
||||
혼합 규칙:
|
||||
|
||||
1. 영역마다 하나의 패키지를 정하고 그 영역의 신규 UI는 그 패키지의 토큰만 읽습니다. Web 토큰(`--hm-sem-*`)을 SW 영역에, SW 토큰(`--hm-sw-*`)을 Web 영역에 쓰지 않습니다. OrgChart 내부는 `--hm-orgchart-*`만 씁니다.
|
||||
2. 다른 패키지 컴포넌트는 **문서에 허용된 지점에서만** 씁니다.
|
||||
- SW `SWPopup`의 `children` 안 Web 컨트롤(SW 카탈로그가 허용, 예: Popup 하단 `Button`)
|
||||
- OrgChart Full Page의 바깥 레이아웃 = Web(또는 요청된 패키지)
|
||||
- OrgChart React의 직원 팝업 = 선택 `@hm-design/org-chart-react/hm-dialog`(Web `Dialog`, Web Theme CSS 필요)
|
||||
3. 패키지 class(`hm-sw-*`, `hm-orgchart-*`, Web `data-slot`)를 소비 코드에서 덮어쓰지 않습니다. 배치는 `className`·`style`과 소비 프로젝트 class로 합니다.
|
||||
4. **Web + SW를 한 문서에 함께 쓰면** Web의 전역 base(위 표)가 SW 화면에도 적용됩니다. SW는 자기 범위에서 버튼 등을 초기화하지만 이 조합의 시각 결과는 패키지에서 검증된 적이 없습니다(NOT VERIFIED). 이 조합이면 브라우저에서 SW 부품의 글꼴·테두리·배경을 직접 확인하고 차이를 보고합니다. 가능하면 Web CSS가 없는 SW 전용 화면(별도 entry)으로 분리합니다.
|
||||
5. Web Scoped Theme(`[data-hm-theme]`)는 body Portal(Select·Popover·DatePicker 팝업)에 전달되지 않습니다. Web 영역만 다른 테마로 바꾸려면 Global Theme를 쓰거나 차이를 보고합니다.
|
||||
|
||||
## 6단계. 디자인 검증
|
||||
|
||||
소비 프로젝트에서 실제로 실행한 것만 PASS로 적습니다.
|
||||
|
||||
1. Typecheck(`tsc --noEmit` 등)와 Production Build
|
||||
2. 브라우저 렌더링: 재사용한 컴포넌트가 HM 외형으로 보이는지(CSS 진입점 누락 확인), 신규 UI가 같은 토큰을 쓰는지
|
||||
3. 상태·동작: Hover / Focus(키보드) / Disabled, Popup 열기·닫기·Escape·Focus 복귀, 선택 패키지의 핵심 동작
|
||||
4. 폭: Web 390 / 768 / 1280 / 1440px, SW는 대상 창 폭(Header는 반응형 More 포함), OrgChart는 캔버스 크기·초기 Fit
|
||||
5. 혼합이면 영역 경계에서 스타일 침범이 없는지(§5)
|
||||
6. 실행하지 못한 항목은 `NOT VERIFIED`로 남깁니다.
|
||||
|
||||
## 7단계. 결과 보고 형식
|
||||
|
||||
```md
|
||||
## HMDesign 적용 결과
|
||||
- 사용 유형: Web | SW | OrgChart(Chart Only|Full Page) | 혼합(영역별: …)
|
||||
- 패키지·버전: @hm-design/ui 0.1.0, …
|
||||
- 재사용한 컴포넌트: …(Props 설정 포함)
|
||||
- 조합한 부분: …
|
||||
- AI가 새로 구현한 부분: 파일 경로 · 이유(카탈로그에 없음) · 안쪽에서 재사용한 컴포넌트
|
||||
- 적용한 디자인 토큰: --hm-… (신규 UI가 읽은 것)
|
||||
- 카탈로그와 .d.ts 차이: 없음 | …
|
||||
- 검증: Typecheck PASS · Build PASS · 브라우저(폭/상태) … · NOT VERIFIED: …
|
||||
- 제안(구현하지 않음): …
|
||||
```
|
||||
|
||||
## 8. 상황별 예시
|
||||
|
||||
### 예시 A — Web 화면 (목록 + 검색)
|
||||
|
||||
- 읽기: `node_modules/@hm-design/ui/ai/` → COMPOSITION_PATTERNS "목록 화면"
|
||||
- 재사용: `LNB`(또는 `GNB`) 중 **하나**, `PageHeader`, `Card`, `FilterBar` + `FilterBarSearch` + `FilterBarActions`, `DataTable` + `useDataTable`, `Button`
|
||||
- 신규(필요 시만): 카탈로그에 없는 콘텐츠 블록 → 소비 프로젝트 컴포넌트, `--hm-sem-*` 토큰과 `Card` 재사용
|
||||
|
||||
```css
|
||||
/* src/index.css */
|
||||
@import "tailwindcss";
|
||||
@import "@hm-design/ui/tailwind.css";
|
||||
@import "@hm-design/ui/theme.css";
|
||||
```
|
||||
|
||||
```tsx
|
||||
import { Button, Card, CardContent, FilterBar, FilterBarActions, FilterBarSearch, PageHeader, PageHeaderContent, PageHeaderTitle } from "@hm-design/ui"
|
||||
```
|
||||
|
||||
### 예시 B — SW 뷰어
|
||||
|
||||
- 읽기: `node_modules/@hm-design/sw/ai/` → COMPOSITION_PATTERNS "6. 파일 열기 + 도구 막대", 예제 `ai/examples/ExampleF-ViewerToolbar.tsx`
|
||||
- 재사용: `SWHeader`(`documentOpenPlacement="header"`, `controls`, `tools`), `SWToolGroup` + `SWToolButton`(Model/Layout 탭, Fit 등), `SWPopup` + `SWPopupSection` + `SWPopupRow` + `SWHeaderInput`(설정 Popup)
|
||||
- 신규: SW에 없는 기능(예: 검색) → 소비 프로젝트 컴포넌트, `<SWTheme>` 안, `--hm-sw-header-*` 토큰, 안쪽 입력은 `SWHeaderInput`(예제 `ExampleD-SearchExtension.tsx`)
|
||||
|
||||
```tsx
|
||||
import { SWHeader, SWPopup, SWTheme, SWToolButton, SWToolGroup } from "@hm-design/sw"
|
||||
import "@hm-design/sw/styles.css"
|
||||
```
|
||||
|
||||
### 예시 C — 조직도만 (Chart Only)
|
||||
|
||||
- 읽기: `node_modules/@hm-design/org-chart/ai/` → COMPOSITION_PATTERNS "1. Chart Only"
|
||||
- 재사용: React `OrgChart`(`@hm-design/org-chart-react`) 또는 Vanilla `createOrgChart`, 데이터 `JsonOrgChartDataSource` + `validateOrgChartDataset`
|
||||
- 필수 옵션: `layoutMode="auto"` + `presentationMode="chart-only"`(초기 Fit·직접 휠 Zoom이 기본)
|
||||
- **추가하지 않음:** 페이지 제목·통계·설명·Zoom 버튼 바·외부 회색 배경·Navigation. Fixed Chart Only는 미지원(`TypeError`)
|
||||
|
||||
```tsx
|
||||
import { OrgChart } from "@hm-design/org-chart-react"
|
||||
import { JsonOrgChartDataSource } from "@hm-design/org-chart"
|
||||
import engineUrl from "@hm-design/org-chart/engine.css?url" // Vite. 다른 도구는 실제 배포 URL
|
||||
import coreUrl from "@hm-design/org-chart/style.css?url"
|
||||
```
|
||||
|
||||
### 예시 D — Web + OrgChart (Full Page)
|
||||
|
||||
- 영역: 페이지 레이아웃·제목·필터 = Web, 조직도 영역 = OrgChart
|
||||
- 읽기: Web `ai/` + OrgChart `ai/COMPOSITION_PATTERNS.md` "2. Full Page"
|
||||
- 재사용: Web `LNB`/`GNB` 중 하나, `PageHeader`, `Card`, `Select`·`Label`(회사 선택 등 요청된 컨트롤만) + OrgChart `OrgChart`(`selectedCompanyIds` 등 Props로 연결)
|
||||
- 직원 팝업을 Web Dialog로: `import { OrgChart } from "@hm-design/org-chart-react/hm-dialog"` + `employeePopup="hm-dialog"`(Web CSS 진입점 필요)
|
||||
- 분리: 조직도 카드·색은 OrgChart 기본 유지. Web 토큰을 조직도에 넣지 않음(바꿔야 하면 `--hm-orgchart-*` 공개 입력만)
|
||||
|
||||
## 9. 소비 프로젝트 설정 — AI가 이 지침을 찾게 하기
|
||||
|
||||
AI 코딩 도구는 보통 **프로젝트 루트의** `AGENTS.md`(Codex 등)·`CLAUDE.md`(Claude Code)·도구별 규칙 파일만 자동으로 읽고 `node_modules`는 읽지 않습니다. 패키지 설치만으로 지침이 자동 적용되지는 않으므로 소비 프로젝트에서 한 번 연결합니다.
|
||||
|
||||
1. 패키지에 들어 있는 `ai/AGENTS_SNIPPET.md`를 루트 `AGENTS.md`(없으면 새로 만듦)에 붙여 넣고 `HMDesign 사용 유형:` 줄을 프로젝트에 맞게 고칩니다. 정하지 않았으면 그 줄을 지워 AI가 1단계에서 묻게 합니다.
|
||||
```bash
|
||||
cat node_modules/@hm-design/ui/ai/AGENTS_SNIPPET.md >> AGENTS.md
|
||||
```
|
||||
(PowerShell: `Get-Content node_modules/@hm-design/ui/ai/AGENTS_SNIPPET.md | Add-Content AGENTS.md`. 설치한 아무 HMDesign 패키지의 사본이나 같습니다.)
|
||||
2. Claude Code는 `CLAUDE.md`에 `@AGENTS.md` 한 줄을 두면 같은 내용을 읽습니다. 다른 도구(Cursor 규칙 등)는 그 도구의 규칙 파일에 같은 내용을 넣습니다.
|
||||
3. 패키지를 업데이트한 뒤 스니펫이 바뀌었는지 확인합니다(스니펫은 경로 안내만 하므로 보통 그대로 둡니다).
|
||||
|
||||
자동으로 되지 않는 것: 패키지 설치 시 루트 파일 생성(`postinstall` 없음), 도구가 `node_modules`를 스스로 탐색하는 것. 위 연결이 없으면 사용자가 "node_modules/@hm-design/…/ai/AI_GUIDE.md를 먼저 읽어"라고 요청해야 합니다.
|
||||
|
||||
## 10. 문서 갱신 (HMDesign 저장소 유지보수자)
|
||||
|
||||
컴포넌트를 추가·수정하면 같은 변경에서 해당 패키지 `ai/COMPONENT_CATALOG.md`와 필요한 `DESIGN_RULES.md`·`COMPOSITION_PATTERNS.md`를 갱신하고 `npm run check:ai-docs`를 통과시킵니다. 절차는 저장소 `docs/ai/MAINTAINING.md`(패키지 미포함)에 있습니다.
|
||||
@@ -0,0 +1,62 @@
|
||||
# @hm-design/ui — AI 코딩 도구 사용 안내 (Web UI)
|
||||
|
||||
먼저 [AI_GUIDE.md](./AI_GUIDE.md)(공통 1~7단계)를 읽고 사용 유형이 **Web** 또는 Web이 포함된 혼합일 때 이 폴더를 씁니다. 이 폴더(`node_modules/@hm-design/ui/ai/`)의 내용은 `@hm-design/ui` 0.1.0의 공개 Export(`src/index.ts` → `dist/index.d.ts`)와 `theme.css`에서 확인한 값만 적습니다.
|
||||
|
||||
| 문서 | 내용 |
|
||||
|---|---|
|
||||
| [COMPONENT_CATALOG.md](./COMPONENT_CATALOG.md) | 공개 컴포넌트 44종·Pattern 8종·Theme API, HM 전용 Props·Variant |
|
||||
| [DESIGN_RULES.md](./DESIGN_RULES.md) | 실제 토큰(`--hm-sem-*` 등), 색·Typography·크기·상태·스크롤바·Overlay 규칙 |
|
||||
| [COMPOSITION_PATTERNS.md](./COMPOSITION_PATTERNS.md) | 화면 유형별 조합(목록·Form·Dashboard·확인창·측면 상세)과 Navigation 단일 모드 |
|
||||
|
||||
## 1. 작업 순서 (필수)
|
||||
|
||||
1. **Pattern을 먼저 본다.** 화면 단위 요구(목록 검색, 상단/좌측 메뉴, Dashboard, 페이지 제목, 로딩)는 [COMPOSITION_PATTERNS.md](./COMPOSITION_PATTERNS.md) §0 표에서 Pattern을 고른다.
|
||||
2. **컴포넌트를 찾는다.** [COMPONENT_CATALOG.md](./COMPONENT_CATALOG.md)에서 요청 항목과 같은 역할을 찾는다. 같은 역할이 있으면 새로 만들지 않는다.
|
||||
3. **Variant·Props로 맞춘다.** `Button`의 `variant` × `appearance`, `Input`/`Select`/`DatePicker`/`Combobox`의 `size`, `Card`·`Tabs`의 `surface` 등 기존 Props로 해결한다. `<Button>`처럼 기본 API만으로 HM 외형이 적용된다. `hm-*` class를 붙이거나 Story 전용 class로 외형을 보정하지 않는다.
|
||||
4. **조합한다.** 여러 컴포넌트를 배치하고 배치용 레이아웃(flex/grid, 간격)만 소비 프로젝트에 작성한다.
|
||||
5. **없을 때만 새로 만든다.** 소비 프로젝트에 작성하고, 외형은 [DESIGN_RULES.md](./DESIGN_RULES.md)의 토큰만 `var(--…)`로 읽으며, 안쪽에는 기존 컴포넌트(`Card`, `Button`, `Label` …)를 재사용한다.
|
||||
6. **추측하지 않는다.** 카탈로그·`dist/index.d.ts`에 없는 Export·Props·토큰은 없다. 기본 HTML·임의 CSS·`data-slot` 흉내로 HM 컴포넌트를 모방하지 않는다(레이아웃·콘텐츠용 HTML은 허용).
|
||||
7. **실제로 검증한다.** [AI_GUIDE.md](./AI_GUIDE.md) 6단계.
|
||||
|
||||
## 2. 설치·Import
|
||||
|
||||
```tsx
|
||||
import { Button, Card, Dialog, DataTable, useDataTable } from "@hm-design/ui"
|
||||
import { applyRuntimeTheme, resetRuntimeTheme, loadRuntimeTheme } from "@hm-design/ui/theme"
|
||||
```
|
||||
|
||||
앱 CSS 진입점(Tailwind CSS 4 통합이 처리하는 파일)에 이 순서로 넣는다.
|
||||
|
||||
```css
|
||||
@import "tailwindcss";
|
||||
@import "@hm-design/ui/tailwind.css";
|
||||
@import "@hm-design/ui/theme.css";
|
||||
/* Dashboard 업무 상태 색이 필요할 때만 */
|
||||
@import "@hm-design/ui/dashboard-status.css";
|
||||
```
|
||||
|
||||
- 공개 진입점은 `.`, `./theme`, `./theme.css`, `./tailwind.css`, `./dashboard-status.css`뿐이다. `@hm-design/ui/dist/components/...` 같은 내부 경로를 import하지 않는다.
|
||||
- Peer: `react`, `react-dom` `^19.0.0`, `tailwindcss` `^4.0.0`. Tailwind CSS 4가 없는 프로젝트에서는 HM 외형이 적용되지 않는다(설치가 필요하다고 보고).
|
||||
- `tailwind.css`가 패키지의 compiled class를 `@source`로 등록하므로 shadcn CLI 설치나 `components.json`이 필요 없다.
|
||||
- Noto Sans KR 글꼴과 OFL 라이선스는 `theme.css`에 포함된다(`dist/fonts/`).
|
||||
- 아이콘은 패키지 의존성인 `lucide-react`를 쓴다.
|
||||
|
||||
## 3. 스타일 규칙
|
||||
|
||||
- HM이 값을 정한 속성은 Theme Token으로 적용되어 있고, 정하지 않은 속성은 shadcn 기본 그대로다. 새 화면에서도 같은 구분을 지킨다.
|
||||
- `className`은 배치 확장용이다. HM 컴포넌트에 HEX·RGB·임의 px Spacing/Radius를 덮어쓰지 않는다.
|
||||
- Light/Dark 분기 없음. `dark:` 분기·Dark Token을 추가하지 않는다.
|
||||
- 테마 변경은 Runtime Theme(`applyRuntimeTheme(root, theme)`, `loadRuntimeTheme(root, url)`)만 쓴다. `theme`은 `{ schemaVersion: 1, tokens: { "color.bg.content": "#…" } }` 형식이며 키는 `runtimeThemeContract`에 있는 것만 유효하다.
|
||||
- 한 페이지의 Navigation은 GNB / LNB / DASHBOARD 중 하나다([COMPOSITION_PATTERNS.md](./COMPOSITION_PATTERNS.md) §1).
|
||||
|
||||
## 4. 접근성 기본
|
||||
|
||||
- 입력 항목명은 `Label htmlFor`와 control `id`를 연결한다(`useId`). placeholder는 항목명이 아니다. `SelectTrigger`·`Combobox`도 `id` 또는 `aria-labelledby`를 연결한다.
|
||||
- Dialog·AlertDialog·Sheet·Drawer는 Title(필요 시 Description)을 넣는다. Escape와 Trigger Focus 복귀는 Radix 동작을 그대로 쓴다.
|
||||
- 기존 컴포넌트의 `aria-*` 연결 속성을 임의로 덮어쓰지 않는다.
|
||||
|
||||
## 5. 이 패키지에 없는 것
|
||||
|
||||
- 공개 Form Pattern, Empty·Error 전용 컴포넌트, Stepper, Tree, Chart(그래프) 컴포넌트는 없다. Form은 `Label` + `Input`/`Textarea`/`Select`/`Checkbox`/`RadioGroup`/`Switch`를 `Card` 안에 조합하고, 빈 목록은 `DataTable`의 `emptyMessage`, 오류 안내는 `Alert`로 만든다.
|
||||
- Badge에 success / warning / information variant는 없다(HM Theme에 상태 팔레트가 아직 없음). 새 상태색을 만들지 않는다.
|
||||
- 상세 컴포넌트 문서·Storybook은 HMDesign 저장소(`docs/components/<name>.md`, `docs/patterns/`)에 있고 패키지에는 포함되지 않는다. 패키지만 있을 때는 이 폴더와 `.d.ts`가 기준이다.
|
||||
@@ -0,0 +1,125 @@
|
||||
# @hm-design/ui 컴포넌트 카탈로그 (Web UI)
|
||||
|
||||
기준: `@hm-design/ui` 0.1.0, 공개 Export(`src/index.ts` → `dist/index.d.ts`, `dist/theme/index.d.ts`). 모든 컴포넌트 import는 `from "@hm-design/ui"`, Theme API는 `from "@hm-design/ui/theme"`입니다. **이 표에 없는 이름은 공개 API가 아닙니다.** 저장소의 `npm run check:ai-docs`가 이 문서와 실제 Export의 일치를 검사합니다.
|
||||
|
||||
- **구조:** shadcn/ui(Radix) 구조와 공개 API를 유지하고 외형만 HM Theme로 바꿨습니다. 아래 "HM Props"에 없는 Props는 shadcn·Radix 원래 Props입니다.
|
||||
- **상태 소유:** 대부분 Radix처럼 `open`/`onOpenChange`, `value`/`onValueChange`(Controlled)와 `default*`(Uncontrolled)를 지원합니다.
|
||||
- **외형 보정 금지:** HM 외형은 기본 API만으로 적용됩니다. `className`은 배치용이며 색·간격·radius를 덮어쓰지 않습니다.
|
||||
|
||||
## 1. Form
|
||||
|
||||
| 컴포넌트 (Export) | 용도 | HM Props·Variant (기본값) |
|
||||
|---|---|---|
|
||||
| `Button`, `buttonVariants` / 타입 `ButtonAppearance` | 작업 실행 | `variant`: `primary`(기본) · `secondary`(Brown) · `modify`(Orange) · `destructive`(Red) · `cancel`(Gray), 별칭 `default`(=primary) · `outline`(=primary+outline), 호환 `ghost` · `link`(HM 외형 없음). `appearance`: `brand`(기본) · `solid` · `outline`. `size`: HM 규격은 `sm`(28) · `default`(34) · `lg`(42), `xs`·`icon*`는 shadcn 기본. `asChild` |
|
||||
| `Input` / 타입 `InputSize` | 한 줄 입력 | `size`: `small`(28) · `medium`(34) · `large`(42, 기본). 상태는 native `disabled`·`readOnly`·`aria-invalid` |
|
||||
| `Textarea` / 타입 `TextareaResize` | 여러 줄 입력 | `resize`: `vertical`(기본) · `none` · `both` |
|
||||
| `Select`, `SelectTrigger`, `SelectValue`, `SelectContent`, `SelectItem`, `SelectGroup`, `SelectLabel`, `SelectSeparator`, `SelectScrollUpButton`, `SelectScrollDownButton` / 타입 `SelectSize` | 목록 선택 | `SelectTrigger size`: `medium`(34) · `large`(44, 기본). Content·Item은 Trigger 크기를 따름 |
|
||||
| `Label` | 입력 라벨 | 없음. `htmlFor` ↔ control `id` 연결 |
|
||||
| `Checkbox` | 복수 선택 | 없음(Radix) |
|
||||
| `RadioGroup`, `RadioGroupItem` | 단일 선택 | 없음(Radix) |
|
||||
| `Switch` | 켜기·끄기 | 없음(Radix) |
|
||||
| `Slider` | 범위 값 | 없음(Radix) |
|
||||
| `Toggle`, `toggleVariants` | 선택 상태 버튼 | `variant`: `default` · `outline`, `size`: `default` · `sm` · `lg` |
|
||||
| `ToggleGroup`, `ToggleGroupItem` | 선택 버튼 묶음 | `variant`, `size`(Toggle과 같음), `spacing` |
|
||||
|
||||
**Button 조합 규칙(필수).** 디자인이 있는 조합만 씁니다. TypeScript가 통과해도 아래에 없는 조합은 디자인이 없습니다.
|
||||
|
||||
| variant | 허용 appearance |
|
||||
|---|---|
|
||||
| `primary` | `brand`, `solid`, `outline` |
|
||||
| `secondary` | `brand`, `solid`, `outline` |
|
||||
| `modify` | `brand`, `solid` (outline 없음) |
|
||||
| `cancel` | `solid`, `outline` (brand 없음) |
|
||||
| `destructive` | `solid`, `outline` (brand 없음) |
|
||||
|
||||
- `brand`는 페이지 대표 실행 1개에만 씁니다(팝업 안 금지). 일반 실행·저장·확인은 `solid`, 반복·보조·표 행 작업은 `outline`.
|
||||
- 결정 세트(취소 + 저장/확인/삭제)는 같은 `appearance`·`size`: 예) `<Button variant="cancel" appearance="solid">취소</Button>` + `<Button appearance="solid">저장</Button>`.
|
||||
- 기본값이 `brand`이므로 `variant="cancel"`·`"destructive"`만 쓰면 미지원 조합이 됩니다. 항상 `appearance`를 명시합니다.
|
||||
- 검색 영역: 조회 `primary`/`solid` + 초기화 `cancel`/`outline`, 같은 size.
|
||||
|
||||
## 2. Overlay
|
||||
|
||||
| 컴포넌트 (Export) | 용도 | HM Props·주의 |
|
||||
|---|---|---|
|
||||
| `Dialog`, `DialogTrigger`, `DialogContent`, `DialogHeader`, `DialogTitle`, `DialogDescription`, `DialogBody`, `DialogFooter`, `DialogClose`, `DialogOverlay`, `DialogPortal` | 모달 | `DialogBody`(HM 추가: 본문 여백·스크롤, Header·Footer 고정). `DialogContent showCloseButton`(기본 true), `DialogFooter showCloseButton`(기본 false) |
|
||||
| `AlertDialog`, `AlertDialogTrigger`, `AlertDialogContent`, `AlertDialogHeader`, `AlertDialogTitle`, `AlertDialogDescription`, `AlertDialogFooter`, `AlertDialogAction`, `AlertDialogCancel`, `AlertDialogOverlay`, `AlertDialogPortal` | 작업 확인 | `AlertDialogAction`: `variant`(기본 `primary`)·`appearance`(기본 `solid`)·`size`. `AlertDialogCancel`: `variant`(기본 `cancel`)·`appearance`(기본 `solid`). 삭제 확인 = Action `variant="destructive"` |
|
||||
| `Sheet`, `SheetTrigger`, `SheetContent`, `SheetHeader`, `SheetTitle`, `SheetDescription`, `SheetBody`, `SheetFooter`, `SheetClose`, `SheetOverlay`, `SheetPortal` | 측면 패널 | `SheetContent side`: `right`(기본) · `left` · `top` · `bottom`, `showCloseButton`(기본 true) |
|
||||
| `Drawer`, `DrawerTrigger`, `DrawerContent`, `DrawerHeader`, `DrawerTitle`, `DrawerDescription`, `DrawerBody`, `DrawerFooter`, `DrawerClose`, `DrawerOverlay`, `DrawerPortal` | 하단 슬라이드(vaul) | 드래그 동작은 vaul 기본 |
|
||||
| `Popover`, `PopoverTrigger`, `PopoverContent`, `PopoverAnchor`, `PopoverClose` | 보조 팝업 | 없음 |
|
||||
| `Tooltip`, `TooltipTrigger`, `TooltipContent`, `TooltipProvider` | 보조 설명 | 없음 |
|
||||
| `HoverCard`, `HoverCardTrigger`, `HoverCardContent` | Hover 카드 | 없음 |
|
||||
| `DropdownMenu`, `DropdownMenuTrigger`, `DropdownMenuContent`, `DropdownMenuItem`, `DropdownMenuCheckboxItem`, `DropdownMenuRadioGroup`, `DropdownMenuRadioItem`, `DropdownMenuLabel`, `DropdownMenuSeparator`, `DropdownMenuShortcut`, `DropdownMenuGroup`, `DropdownMenuPortal`, `DropdownMenuSub`, `DropdownMenuSubTrigger`, `DropdownMenuSubContent` | 작업 메뉴 | `DropdownMenuItem variant`: `default` · `destructive`, `inset` |
|
||||
| `ContextMenu`, `ContextMenuTrigger`, `ContextMenuContent`, `ContextMenuItem`, `ContextMenuCheckboxItem`, `ContextMenuRadioGroup`, `ContextMenuRadioItem`, `ContextMenuLabel`, `ContextMenuSeparator`, `ContextMenuShortcut`, `ContextMenuGroup`, `ContextMenuPortal`, `ContextMenuSub`, `ContextMenuSubTrigger`, `ContextMenuSubContent` | 우클릭 메뉴 | DropdownMenu와 같음 |
|
||||
| `Toaster`, `toast` / 타입 `ExternalToast`, `ToasterProps` | 토스트(sonner) | 앱에 `<Toaster />` 한 번, 호출은 `toast("…")` |
|
||||
|
||||
## 3. Navigation (컴포넌트)
|
||||
|
||||
| 컴포넌트 (Export) | 용도 | HM Props |
|
||||
|---|---|---|
|
||||
| `Tabs`, `TabsList`, `TabsTrigger`, `TabsContent` / 타입 `TabsPanelSurface` | 탭 | `TabsList fill`(기본 true = 균등 폭 Primary Fill, false = Legacy), `TabsList panelSurface`: `content`(기본) · `surface` — 실제 배경(Card `surface`)과 맞춤 |
|
||||
| `Breadcrumb`, `BreadcrumbList`, `BreadcrumbItem`, `BreadcrumbLink`, `BreadcrumbPage`, `BreadcrumbSeparator`, `BreadcrumbEllipsis` | 현재 경로 | `BreadcrumbLink asChild` |
|
||||
| `Pagination`, `PaginationContent`, `PaginationItem`, `PaginationLink`, `PaginationPrevious`, `PaginationNext`, `PaginationEllipsis` | 페이지 선택 | `PaginationLink isActive`, `size`(기본 `icon`) |
|
||||
| `NavigationMenu`, `NavigationMenuList`, `NavigationMenuItem`, `NavigationMenuTrigger`, `NavigationMenuContent`, `NavigationMenuLink`, `NavigationMenuIndicator`, `NavigationMenuViewport` | 링크 메뉴 | `NavigationMenu viewport` |
|
||||
| `Menubar`, `MenubarMenu`, `MenubarTrigger`, `MenubarContent`, `MenubarItem`, `MenubarCheckboxItem`, `MenubarRadioGroup`, `MenubarRadioItem`, `MenubarLabel`, `MenubarSeparator`, `MenubarShortcut`, `MenubarGroup`, `MenubarPortal`, `MenubarSub`, `MenubarSubTrigger`, `MenubarSubContent` | 메뉴 막대 | DropdownMenu와 같음 |
|
||||
|
||||
페이지 Navigation(상단·좌측 메뉴)은 컴포넌트가 아니라 Pattern `GNB` / `LNB` / `DashboardLayout` 중 하나를 씁니다(§6).
|
||||
|
||||
## 4. Data & Display
|
||||
|
||||
| 컴포넌트 (Export) | 용도 | HM Props |
|
||||
|---|---|---|
|
||||
| `Card`, `CardHeader`, `CardTitle`, `CardDescription`, `CardAction`, `CardContent`, `CardFooter` / 타입 `CardSurface` | 콘텐츠 묶음 | `surface`: `surface`(White, 기본) · `content`(Beige), `size`: `default` · `sm` |
|
||||
| `Table`, `TableHeader`, `TableBody`, `TableFooter`, `TableRow`, `TableHead`, `TableCell`, `TableCaption` | 표(표시만) | 없음. 정렬·선택·페이지가 필요하면 Pattern `DataTable` |
|
||||
| `Badge`, `badgeVariants` | 상태·라벨 | `variant`: `default` · `secondary` · `destructive` · `outline`(success/warning/info 없음), `asChild` |
|
||||
| `Alert`, `AlertTitle`, `AlertDescription` | 안내·경고 | `variant`: `default` · `destructive` |
|
||||
| `Avatar`, `AvatarImage`, `AvatarFallback` | 사용자 이미지 | `size`: `default` · `sm` · `lg` |
|
||||
| `Separator` | 구분선 | 없음 |
|
||||
| `Progress` | 진행률 | 없음 |
|
||||
| `Skeleton` | 로딩 자리 | 없음 |
|
||||
| `ScrollArea`, `ScrollBar` | 스크롤 영역(HM 스크롤바) | 없음. 스크롤바 외형은 DESIGN_RULES §6 |
|
||||
| `AspectRatio` | 비율 유지 | 없음 |
|
||||
| `Carousel`, `CarouselContent`, `CarouselItem`, `CarouselPrevious`, `CarouselNext`, `useCarousel` / 타입 `CarouselApi` | 슬라이드(embla) | `opts`, `plugins`, `orientation`, `setApi` |
|
||||
| `Accordion`, `AccordionItem`, `AccordionTrigger`, `AccordionContent` | 접고 펼치기 | 없음 |
|
||||
| `Collapsible`, `CollapsibleTrigger`, `CollapsibleContent` | 영역 접기 | 없음 |
|
||||
| `ResizablePanelGroup`, `ResizablePanel`, `ResizableHandle` | 크기 조절 | `ResizableHandle withHandle` |
|
||||
|
||||
## 5. Search & Date
|
||||
|
||||
| 컴포넌트 (Export) | 용도 | HM Props |
|
||||
|---|---|---|
|
||||
| `Calendar` | 달력(react-day-picker) | react-day-picker Props |
|
||||
| `DatePicker` / 타입 `DatePickerSize` | 날짜 입력 | `value`·`defaultValue`(Date), `onValueChange`, `controlled`, `placeholder`, `size`: `medium` · `large`(기본), `format`(기본 `YYYY.MM.DD`), `calendarProps`(disabled·startMonth·endMonth·locale·captionLayout·weekStartsOn·today) |
|
||||
| `Combobox` / 타입 `ComboboxOption`, `ComboboxSize` | 검색 가능한 선택 | `options: { value, label, disabled? }[]`(필수), `value`·`defaultValue`, `onValueChange`, `controlled`, `placeholder`, `searchPlaceholder`, `emptyText`, `size`: `medium` · `large`(기본) |
|
||||
| `Command`, `CommandInput`, `CommandList`, `CommandEmpty`, `CommandGroup`, `CommandItem`, `CommandSeparator`, `CommandShortcut` | 명령 검색(cmdk) | 없음 |
|
||||
|
||||
## 6. Pattern (업무 화면 단위)
|
||||
|
||||
Pattern은 위 컴포넌트를 조합한 것이며 자체 primitive 외형을 추가하지 않습니다. 조합 예시는 [COMPOSITION_PATTERNS.md](./COMPOSITION_PATTERNS.md).
|
||||
|
||||
| Pattern (Export) | 용도 | 주요 Props |
|
||||
|---|---|---|
|
||||
| `DataTable`, `useDataTable`, `DataTableColumnHeader`, `DataTablePagination`, `DataTableViewOptions`, `dataTableSelectColumn` / 타입 `DataTableColumnDef`, `DataTableInstance`, `DataTableOptions`, `DataTableProps` | 데이터 표(TanStack Table v9: 정렬·필터·선택·페이지·열 표시) | `useDataTable({ columns, data, … })`(columns·data는 참조 안정), `DataTable table loading emptyMessage pagination(기본 true) pageSizeOptions`, `DataTableColumnHeader column title`, `DataTableViewOptions table label labels`, `dataTableSelectColumn()` |
|
||||
| `FilterBar`, `FilterBarSearch`, `FilterBarActions` / 타입 `FilterBarProps`, `FilterBarSearchProps` | 조회 조건 행(레이아웃) | `FilterBar layout`: `default` · `list-basic`(가운데) · `list-extended`(추가 조건 왼쪽). `FilterBarSearch value onValueChange size`(기본 `medium`) `placeholder`(기본 "검색") |
|
||||
| `GNB`, `GNBBrand`, `GNBNav`, `GNBUtilities`, `GNBUser`, `GNBMobileMenu`, `GNBMobileLink`, `GNBMobileGroup` / 타입 `GNBUserProps`, `GNBMobileMenuProps` | 상단 Navigation | `GNB sticky`, `GNBBrand asChild`, `GNBUser name description`, `GNBMobileMenu title side open defaultOpen onOpenChange`, `GNBMobileLink active asChild`, `GNBMobileGroup label` |
|
||||
| `LNB`, `LNBBrand`, `LNBNav`, `LNBItem`, `LNBGroup`, `LNBProfile` / 타입 `LNBGroupProps`, `LNBProfileProps` | 좌측 Navigation(3뎁스까지 `LNBGroup` 중첩) | `LNBItem active asChild`, `LNBGroup label current`, `LNBProfile name description` |
|
||||
| `LNBMobileHeader`, `LNBMobileBrand`, `LNBMobileMenu`, `LNBMobileLink`, `LNBMobileGroup` / 타입 `LNBMobileMenuProps` | LNB 모바일 Header + Sheet | `LNBMobileMenu title side open defaultOpen onOpenChange`, `LNBMobileLink active` |
|
||||
| `PageHeader`, `PageHeaderContent`, `PageHeaderTitle`, `PageHeaderDescription`, `PageHeaderActions` | 페이지 제목·설명·주요 작업 | HTML 속성만 |
|
||||
| `DashboardLayout`, `DashboardHeader`, `DashboardMain`, `DashboardContent`, `DashboardSidebar` / 타입 `DashboardLayoutProps` | Dashboard 전용 레이아웃(Header 48px, 최소 폭 960px·내부 스크롤) | `DashboardLayout header sidebar children`. **신규 화면은 `sidebar`·`DashboardSidebar`를 쓰지 않음**(호환성 전용) |
|
||||
| `dashboardStatusDefinitions`, `dashboardStatusAttributes`, `dashboardFilterDefinitions`, `dashboardFilterIds`, `countDashboardFilter`, `matchesDashboardFilter` / 타입 `DashboardStatusId`, `DashboardStatusDefinition`, `DashboardStatusRecord`, `DashboardStatusTone`, `DashboardFilterId`, `DashboardFilterDefinition` | Dashboard 업무 상태·필터 계약(데이터 helper) | 색은 `@hm-design/ui/dashboard-status.css`의 `--hm-dashboard-status-active` · `-hold` · `-done` · `-issue` 변수만 제공. Badge 등 자동 스타일 없음 — 소비자가 연결 |
|
||||
| `LoadingScreen` | 전체·부분 로딩 | `fullscreen`(기본 false), `children`(기본 "Loading") |
|
||||
|
||||
## 7. Theme API (`@hm-design/ui/theme`)
|
||||
|
||||
| Export | 용도 |
|
||||
|---|---|
|
||||
| `applyRuntimeTheme(root, theme)` → `boolean` | `root`(예: `document.documentElement` 또는 `[data-hm-theme]` 요소)에 Runtime Theme 적용. 잘못된 입력은 전체 거부(false) |
|
||||
| `resetRuntimeTheme(root)` | 적용한 값 제거, HM Default로 복원 |
|
||||
| `isRuntimeTheme(value)` | 형식 검사 |
|
||||
| `fetchRuntimeTheme(url, request?)`, `resolveRuntimeTheme(theme, defaults?)`, `loadRuntimeTheme(root, url, options?)` / 타입 `RuntimeThemeLoadOptions` | URL의 Theme JSON 불러오기·병합·적용 |
|
||||
| `runtimeThemeContract`, `defaultRuntimeTheme` / 타입 `RuntimeTheme`, `RuntimeThemeToken` | 계약(토큰 키 → CSS 변수)과 HM Default 값. `RuntimeTheme = { schemaVersion: 1, tokens: Partial<Record<RuntimeThemeToken, string>> }` |
|
||||
|
||||
Theme JSON 원본·CDN은 패키지에 포함되지 않습니다(URL은 소비 앱이 정함).
|
||||
|
||||
## 8. 공개하지 않은 것
|
||||
|
||||
`cn`, 내부 `lib/utils`, 각 컴포넌트 파일의 비공개 helper, `components/ui/*` 직접 경로, `theme/*.css` 개별 파일은 공개 API가 아닙니다. shadcn CLI로 같은 컴포넌트를 소비 프로젝트에 다시 추가하지 않습니다(같은 이름의 중복 컴포넌트가 됨).
|
||||
@@ -0,0 +1,236 @@
|
||||
# Web(@hm-design/ui) 조합 패턴
|
||||
|
||||
모든 패턴은 공개 Export만 씁니다([COMPONENT_CATALOG.md](./COMPONENT_CATALOG.md)). 코드는 형태를 보여 주는 예이며, 실제 화면에서는 **요청된 메뉴·조건·버튼만** 넣습니다(예시의 항목을 요구사항으로 복사하지 않음).
|
||||
|
||||
## 0. 어떤 패턴을 고를까
|
||||
|
||||
| 요청 | 먼저 고를 것 | 조합 |
|
||||
|---|---|---|
|
||||
| 목록 검색·필터 | `FilterBar`(표가 없어도 먼저 검토), 표가 필요하면 `DataTable` | `PageHeader` 아래 `Card` 하나 안에 FilterBar + DataTable. 조건 → 조회 → 초기화, draft/applied 분리(§3) |
|
||||
| 업무 Dashboard | `DashboardLayout` + `DashboardHeader` + `DashboardMain` + `DashboardContent` | Header 48px, 최소 폭 960px·내부 가로 스크롤, Sidebar 없음. 상태는 Dashboard Status 계약(§6) |
|
||||
| Form(등록·수정) | 공개 Form Pattern 없음 | `Card` 안 `Label` + `Input`/`Textarea`/`Select`/`Checkbox`/`RadioGroup`/`Switch`, `useId`·`htmlFor`, 오류는 `aria-invalid` + 메시지, 첫 오류 Focus(§4) |
|
||||
| 서비스 상단 메뉴 | `GNB` + `GNBMobileMenu` | 요청된 경로만 Desktop·Mobile에 같게. Sidebar 없음(§1) |
|
||||
| 계층 좌측 메뉴 | `LNB` + `LNBMobileHeader`/`LNBMobileMenu` | 3뎁스까지 `LNBGroup` 중첩(§1) |
|
||||
| 작업 확인 | `AlertDialog`(또는 `Dialog`) | Title/Description, 취소/진행, Escape·Trigger Focus 복귀. 취소·삭제 모두 Solid(§5) |
|
||||
| 측면 상세 | `Sheet` | 메뉴 대체로 쓰지 않음 |
|
||||
| 하단 작업 | `Drawer` | desktop 취소→실행, mobile 실행 위·취소 아래 |
|
||||
| 초기·부분 로딩 | `LoadingScreen` 또는 `Skeleton` / `DataTable loading` | 기존 콘텐츠 유지 여부는 요구사항으로 결정 |
|
||||
| 빈 목록·오류 | `DataTable emptyMessage` / 콘텐츠 HTML / `Alert` | 별도 Empty 컴포넌트 만들지 않음 |
|
||||
| 패키지에 없는 블록 | 소비 프로젝트 신규 | `Card`·`Button` 등 재사용 + [DESIGN_RULES.md](./DESIGN_RULES.md) 토큰(§7) |
|
||||
|
||||
## 1. Navigation 단일 모드 (필수)
|
||||
|
||||
한 페이지 = 하나의 Navigation: **GNB ONLY** · **LNB ONLY** · **DASHBOARD ONLY** 중 하나.
|
||||
|
||||
| 모드 | 구조 | 금지 |
|
||||
|---|---|---|
|
||||
| GNB | `GNB`(+ `GNBMobileMenu`) + Content | Sidebar·LNB·Dashboard와 혼합 |
|
||||
| LNB | `LNB`(Desktop) + `LNBMobileHeader`/`LNBMobileMenu`(모바일 <1024px) + Content | GNB·Dashboard와 혼합 |
|
||||
| DASHBOARD | `DashboardLayout header={<DashboardHeader/>}` + Content | Sidebar·LNB·GNB(`sidebar` prop·`DashboardSidebar`는 호환성 전용) |
|
||||
|
||||
- 요청이 모드를 말하지 않으면 화면 목적(서비스 상단 메뉴 = GNB, 계층 업무 메뉴 = LNB, 운영 현황 = DASHBOARD)으로 고르고 **선택 근거를 보고**합니다. 임의로 Sidebar를 추가하지 않습니다.
|
||||
- 혼합 요청(GNB + LNB 등)은 정책 충돌로 안내하고 하나를 고르게 합니다. Drawer·Hamburger 등 대체 메뉴를 추측해 만들지 않습니다.
|
||||
- Breadcrumb·FilterBar·사용자 Dropdown은 Navigation 모드가 아닙니다.
|
||||
|
||||
```tsx
|
||||
// LNB ONLY 골격
|
||||
<div className="grid grid-cols-1 lg:grid-cols-[var(--hm-lnb-width)_minmax(0,1fr)]">
|
||||
<LNB>
|
||||
<LNBBrand><span><small>업무 시스템</small><strong>서비스명</strong></span></LNBBrand>
|
||||
<LNBNav aria-label="서비스 메뉴">
|
||||
<LNBItem href="/list" active>목록</LNBItem>
|
||||
<LNBGroup label="관리" current>
|
||||
<LNBItem href="/admin/users">사용자</LNBItem>
|
||||
</LNBGroup>
|
||||
</LNBNav>
|
||||
</LNB>
|
||||
<div className="app-content-stack">
|
||||
<LNBMobileHeader>
|
||||
<LNBMobileMenu title="서비스 메뉴">
|
||||
<LNBMobileLink href="/list" active>목록</LNBMobileLink>
|
||||
<LNBMobileGroup label="관리"><LNBMobileLink href="/admin/users">사용자</LNBMobileLink></LNBMobileGroup>
|
||||
</LNBMobileMenu>
|
||||
<LNBMobileBrand href="/">서비스명</LNBMobileBrand>
|
||||
</LNBMobileHeader>
|
||||
<main className="app-page-content">…</main>
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
```css
|
||||
/* 소비 레이아웃(높이·스크롤)만. HM 면·간격은 그대로. --hm-lnb-width는 패키지 LNB 변수 */
|
||||
.app-content-stack { display: flex; flex-direction: column; min-height: 0; min-width: 0; }
|
||||
.app-page-content { position: relative; flex: 1; min-height: 0; min-width: 0; overflow: auto; }
|
||||
```
|
||||
|
||||
```tsx
|
||||
// GNB ONLY 골격 — NavigationMenu는 viewport={false} 필수
|
||||
<GNB sticky>
|
||||
<GNBMobileMenu title="메뉴"><GNBMobileLink href="/" active>대시보드</GNBMobileLink></GNBMobileMenu>
|
||||
<GNBBrand href="/"><span><small>업무 시스템</small><strong>서비스명</strong></span></GNBBrand>
|
||||
<GNBNav>
|
||||
<NavigationMenu viewport={false} aria-label="주 메뉴">
|
||||
<NavigationMenuList>
|
||||
<NavigationMenuItem><NavigationMenuLink href="/" active>대시보드</NavigationMenuLink></NavigationMenuItem>
|
||||
</NavigationMenuList>
|
||||
</NavigationMenu>
|
||||
</GNBNav>
|
||||
<GNBUtilities>
|
||||
<DropdownMenu>
|
||||
<DropdownMenuTrigger asChild><GNBUser name="홍길동" description="관리자"><Avatar><AvatarFallback>홍</AvatarFallback></Avatar></GNBUser></DropdownMenuTrigger>
|
||||
<DropdownMenuContent><DropdownMenuItem variant="destructive">로그아웃</DropdownMenuItem></DropdownMenuContent>
|
||||
</DropdownMenu>
|
||||
</GNBUtilities>
|
||||
</GNB>
|
||||
```
|
||||
|
||||
## 2. 페이지 제목
|
||||
|
||||
```tsx
|
||||
<PageHeader>
|
||||
<PageHeaderContent>
|
||||
<PageHeaderTitle>사용자 목록</PageHeaderTitle>
|
||||
<PageHeaderDescription>등록된 사용자를 조회합니다.</PageHeaderDescription>
|
||||
</PageHeaderContent>
|
||||
<PageHeaderActions>
|
||||
<Button appearance="brand">사용자 등록</Button>{/* 페이지 대표 실행 1개만 brand */}
|
||||
</PageHeaderActions>
|
||||
</PageHeader>
|
||||
```
|
||||
|
||||
## 3. 목록 화면 — FilterBar + DataTable (조회 버튼 적용)
|
||||
|
||||
`draft` = 입력 중 조건, `applied` = 목록에 적용한 조건. 조회 클릭에만 복사하고, 초기화는 두 상태와 페이지를 함께 비웁니다.
|
||||
|
||||
```tsx
|
||||
import { useMemo, useState } from "react"
|
||||
import {
|
||||
Button, Card, CardContent, DataTable, FilterBar, FilterBarActions, FilterBarSearch,
|
||||
Select, SelectContent, SelectItem, SelectTrigger, SelectValue, useDataTable,
|
||||
type DataTableColumnDef,
|
||||
} from "@hm-design/ui"
|
||||
|
||||
type User = { id: string; name: string; status: "active" | "inactive" }
|
||||
type Conditions = { query: string; status: string }
|
||||
const empty: Conditions = { query: "", status: "all" }
|
||||
const rows: User[] = [
|
||||
{ id: "U-1", name: "김한맥", status: "active" },
|
||||
{ id: "U-2", name: "이한맥", status: "inactive" },
|
||||
]
|
||||
const columns: DataTableColumnDef<User>[] = [ // 모듈 상수(참조 안정)
|
||||
{ accessorKey: "name", header: "이름" },
|
||||
{ accessorKey: "status", header: "상태", cell: ({ row }) => (row.original.status === "active" ? "활성" : "비활성") },
|
||||
]
|
||||
|
||||
export function UserList() {
|
||||
const [draft, setDraft] = useState<Conditions>({ ...empty })
|
||||
const [applied, setApplied] = useState<Conditions>({ ...empty })
|
||||
const data = useMemo(() => rows.filter(row =>
|
||||
row.name.toLocaleLowerCase().includes(applied.query.trim().toLocaleLowerCase()) &&
|
||||
(applied.status === "all" || row.status === applied.status)
|
||||
), [applied])
|
||||
const table = useDataTable({ columns, data, getRowId: row => row.id })
|
||||
const apply = () => { setApplied({ ...draft }); table.setPageIndex(0) }
|
||||
const reset = () => { setDraft({ ...empty }); setApplied({ ...empty }); table.setPageIndex(0) }
|
||||
return (
|
||||
<Card>
|
||||
<CardContent>
|
||||
<FilterBar layout="list-basic">
|
||||
<Select value={draft.status} onValueChange={status => setDraft(s => ({ ...s, status }))}>
|
||||
<SelectTrigger size="medium" aria-label="사용자 상태"><SelectValue /></SelectTrigger>
|
||||
<SelectContent>
|
||||
<SelectItem value="all">전체 상태</SelectItem>
|
||||
<SelectItem value="active">활성</SelectItem>
|
||||
<SelectItem value="inactive">비활성</SelectItem>
|
||||
</SelectContent>
|
||||
</Select>
|
||||
<FilterBarSearch value={draft.query} onValueChange={query => setDraft(s => ({ ...s, query }))} placeholder="이름 검색" />
|
||||
<FilterBarActions>
|
||||
<Button type="button" variant="primary" appearance="solid" onClick={apply}>조회</Button>
|
||||
<Button type="button" variant="cancel" appearance="outline" onClick={reset}>초기화</Button>
|
||||
</FilterBarActions>
|
||||
</FilterBar>
|
||||
<p role="status">조회 결과 {data.length}건</p>
|
||||
<DataTable table={table} emptyMessage="조건에 맞는 사용자가 없습니다." />
|
||||
</CardContent>
|
||||
</Card>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
- 정렬 Header: `header: ({ column }) => <DataTableColumnHeader column={column} title="이름" />`. 선택 열: `dataTableSelectColumn<User>()`를 columns 맨 앞에.
|
||||
- TanStack Table **v9** API입니다(v8의 `useReactTable`·`getCoreRowModel` 예제를 쓰지 않음). 필터: `table.setGlobalFilter`, `table.getColumn(id)?.setFilterValue`, 초기화 `resetGlobalFilter(true)`·`resetColumnFilters(true)`.
|
||||
- `ColumnDef.size`는 th/td 폭으로 연결되지 않습니다. 긴 ID는 셀 콘텐츠에 `whitespace-nowrap` 등을 주고 실제 폭을 확인합니다.
|
||||
|
||||
## 4. Form
|
||||
|
||||
```tsx
|
||||
const nameId = useId()
|
||||
<Card>
|
||||
<CardHeader><CardTitle>사용자 등록</CardTitle></CardHeader>
|
||||
<CardContent>
|
||||
<Label htmlFor={nameId}>이름</Label>
|
||||
<Input id={nameId} size="large" aria-invalid={error ? true : undefined} aria-describedby={error ? `${nameId}-error` : undefined} />
|
||||
{error && <p id={`${nameId}-error`} role="alert">{error}</p>}
|
||||
</CardContent>
|
||||
<CardFooter>
|
||||
<Button variant="cancel" appearance="solid">취소</Button>
|
||||
<Button appearance="solid">저장</Button>
|
||||
</CardFooter>
|
||||
</Card>
|
||||
```
|
||||
|
||||
- 결정 세트는 같은 `appearance`·`size`. 오류 메시지 색이 필요하면 `--hm-sem-status-error`(잠정 토큰) 또는 `Alert variant="destructive"`.
|
||||
|
||||
## 5. 확인창 (삭제)
|
||||
|
||||
```tsx
|
||||
<AlertDialog>
|
||||
<AlertDialogTrigger asChild><Button variant="destructive" appearance="outline">삭제</Button></AlertDialogTrigger>
|
||||
<AlertDialogContent>
|
||||
<AlertDialogHeader>
|
||||
<AlertDialogTitle>사용자를 삭제할까요?</AlertDialogTitle>
|
||||
<AlertDialogDescription>삭제한 사용자는 복구할 수 없습니다.</AlertDialogDescription>
|
||||
</AlertDialogHeader>
|
||||
<AlertDialogFooter>
|
||||
<AlertDialogCancel>취소</AlertDialogCancel>{/* 기본 cancel + solid */}
|
||||
<AlertDialogAction variant="destructive">삭제</AlertDialogAction>{/* 기본 solid */}
|
||||
</AlertDialogFooter>
|
||||
</AlertDialogContent>
|
||||
</AlertDialog>
|
||||
```
|
||||
|
||||
일반 작성·수정 모달은 `Dialog` + `DialogHeader` + `DialogBody`(스크롤) + `DialogFooter`, 버튼은 취소 Solid + 저장 Solid(팝업에 `brand` 금지).
|
||||
|
||||
## 6. Dashboard
|
||||
|
||||
```tsx
|
||||
<DashboardLayout header={<DashboardHeader>…요청된 제목·상태 필터만…</DashboardHeader>}>
|
||||
<DashboardMain>
|
||||
<DashboardContent>…</DashboardContent>
|
||||
</DashboardMain>
|
||||
</DashboardLayout>
|
||||
```
|
||||
|
||||
- 업무 상태: `dashboardStatusDefinitions`·`dashboardFilterDefinitions`·`matchesDashboardFilter`·`countDashboardFilter`로 필터·집계를 하고, 색은 `@hm-design/ui/dashboard-status.css`를 import한 뒤 `--hm-dashboard-status-active|hold|done|issue`를 소비 코드에서 Badge 등에 연결합니다(자동 스타일 없음). 새 상태색을 만들지 않습니다.
|
||||
|
||||
## 7. 패키지에 없는 블록 만들기
|
||||
|
||||
예: "통계 카드 4개".
|
||||
|
||||
1. 카탈로그 확인 → 통계 전용 컴포넌트 없음 → **조합**: `Card` + `CardHeader`/`CardTitle` + `CardContent`.
|
||||
2. 숫자 강조 등 Card 밖 스타일이 필요하면 소비 프로젝트 class(`app-stat-value`)를 만들고 토큰만 읽습니다.
|
||||
|
||||
```css
|
||||
.app-stat-grid { display: grid; gap: 16px; grid-template-columns: repeat(auto-fit, minmax(200px, 1fr)); }
|
||||
.app-stat-value { color: var(--hm-sem-fg-primary); font-weight: var(--hm-font-weight-bold); }
|
||||
.app-stat-label { color: var(--hm-sem-fg-secondary); }
|
||||
```
|
||||
|
||||
3. 간격 값(16px 등)은 레이아웃용입니다. 컴포넌트 내부 padding·radius는 바꾸지 않습니다.
|
||||
4. 결과 보고에 "신규: `StatCard`(소비 프로젝트) — Card 조합, 토큰 `--hm-sem-fg-primary`, `--hm-sem-fg-secondary`, `--hm-font-weight-bold`"처럼 남깁니다.
|
||||
|
||||
## 8. 혼합 사용과 함께 쓸 때
|
||||
|
||||
- **Web + OrgChart:** 페이지·제목·필터는 이 문서대로, 조직도 영역은 `@hm-design/org-chart/ai/COMPOSITION_PATTERNS.md` "Full Page". 조직도 안쪽에 Web 토큰을 넣지 않습니다.
|
||||
- **Web + SW:** SW Popup 안 하단 버튼 등 SW 문서가 허용한 지점에서만 Web 컴포넌트를 씁니다. Web CSS(Tailwind base 포함)는 문서 전체에 적용되므로 SW 영역을 브라우저에서 확인합니다([AI_GUIDE.md](./AI_GUIDE.md) §5).
|
||||
@@ -0,0 +1,113 @@
|
||||
# Web(@hm-design/ui) 디자인 규칙
|
||||
|
||||
출처: `@hm-design/ui/theme.css`(원본 `src/theme/primitives.css`·`default.css`·컴포넌트별 `theme/*.css`)에 실제 선언된 값. 이 문서와 그 CSS에 없는 값은 확정값이 아닙니다. 새 UI는 아래 변수를 `var(--…)`로 읽고 HEX·px 값을 새로 만들지 않습니다.
|
||||
|
||||
- 토큰 범위: `:root, [data-hm-theme]`. Runtime Theme(`@hm-design/ui/theme`)가 같은 변수를 바꿉니다.
|
||||
- Light/Dark 분기 없음. 컴포넌트 CSS에 `html`·`body`·`*` 규칙을 추가하지 않습니다.
|
||||
- 이름을 추측하지 않습니다. 특히 `--hm-sem-text-*`, `--hm-sem-border-*`, `--hm-sem-stroke-divider`는 **선언되어 있지 않습니다**(아래 표의 이름을 씀). 없는 토큰을 fallback 색으로 감추지 않습니다.
|
||||
- Tailwind utility로는 shadcn 매핑 utility(`bg-card`, `text-primary`, `text-muted-foreground` 등)를 쓸 수 있습니다. HM 값과 다를 수 있는 임의 utility 색(`bg-green-700` 등)은 쓰지 않습니다.
|
||||
|
||||
## 1. 기본 팔레트 (primitives → `--hm-sem-palette-*`)
|
||||
|
||||
| 역할 | 값 | 변수 |
|
||||
|---|---|---|
|
||||
| Green(주색) | `#123328` | `--hm-sem-palette-green-default` |
|
||||
| Green 진한 글자 | `#0A221D` | `--hm-sem-palette-green-dark-1` |
|
||||
| Green Focus·Active | `#266651` | `--hm-sem-palette-green-light-2` |
|
||||
| Green Tint(강조 면) | `#BDDFD4` | `--hm-sem-palette-green-tint` |
|
||||
| Beige(콘텐츠 면) | `#F5F0E5` | `--hm-sem-palette-beige-light` |
|
||||
| Warm neutral | dark `#6E6759`, mid `#9A9284`, pale `#DEDBD2`, muted `#F4F1EA` | `--hm-sem-palette-warm-neutral-dark` / `-mid` / `-pale` / `-muted` |
|
||||
| Red | `#D32F2F` | `--hm-sem-palette-red-danger` |
|
||||
| Gray placeholder | `#999999` | `--hm-sem-palette-neutral-gray-500` |
|
||||
| White / Black | `#FFFFFF` / `#000000` | `--hm-sem-palette-white` / `--hm-sem-palette-black` |
|
||||
|
||||
Brown·Orange 계열 팔레트(`--hm-sem-palette-brown-*`, `--hm-sem-palette-orange-*`)도 선언되어 있으며 Button `secondary`(Brown)·`modify`(Orange) 역할에 쓰입니다. 새 UI는 팔레트보다 §2의 Semantic 변수를 우선합니다.
|
||||
|
||||
## 2. Semantic 색·면 (새 UI가 읽는 변수)
|
||||
|
||||
| 역할 | 변수 | 기본 |
|
||||
|---|---|---|
|
||||
| 페이지·콘텐츠 배경 | `--hm-sem-bg-content` | Beige |
|
||||
| 카드·팝업 표면 | `--hm-sem-bg-surface` | White |
|
||||
| 보조 면 | `--hm-sem-bg-subtle` | warm-neutral-muted |
|
||||
| 브랜드 배경(gradient) | `--hm-sem-bg-brand`, `--hm-sem-bg-brown`, `--hm-sem-bg-orange` | 세로 gradient(GNB·Brand 버튼 면) |
|
||||
| 기본 글자 | `--hm-sem-fg-primary` | green-dark-1 |
|
||||
| 보조 글자 | `--hm-sem-fg-secondary` | warm-neutral-dark |
|
||||
| placeholder | `--hm-sem-fg-placeholder` | gray-500 |
|
||||
| 일반 테두리 | `--hm-sem-stroke-default` | warm-neutral-mid |
|
||||
| 입력 테두리 | `--hm-sem-stroke-input-default` | warm-neutral-pale |
|
||||
| Focus 테두리 | `--hm-sem-stroke-input-focus` | green-light-2 |
|
||||
| 주 액션 / 위 글자 | `--hm-sem-action-primary` / `--hm-sem-on-action-primary` | Green / White |
|
||||
| 취소 액션 | `--hm-sem-action-cancel` | warm-neutral-dark |
|
||||
| 위험 액션 | `--hm-sem-action-destructive` | Red |
|
||||
| 오류 상태(잠정) | `--hm-sem-status-error` | `#B3261E` |
|
||||
| 강조 면 / 위 글자 | `--hm-sem-accent` / `--hm-sem-on-accent` | green-tint / `#123328` |
|
||||
| 선택(Active) / 위 글자 | `--hm-sem-state-active` / `--hm-sem-on-state-active` | green-light-2 / White |
|
||||
| 하이라이트 | `--hm-sem-surface-highlight` | accent 45% |
|
||||
| Floating(Popover·Menu·Tooltip 류) | `--hm-sem-floating-background`, `-border-width`(1px), `-border-color`, `-radius`, `-shadow` | White, 입력 테두리, 4px, `0 0 12px` 검정 20% |
|
||||
| Overlay(Dim) | `--hm-sem-overlay-background` | 검정 10% |
|
||||
|
||||
## 3. Typography
|
||||
|
||||
| 항목 | 값 |
|
||||
|---|---|
|
||||
| 글꼴 | `--hm-font-family-base`: "Noto Sans KR", "Malgun Gothic", sans-serif (글꼴 파일 포함) |
|
||||
| Weight | **400 / 500 / 700만**(600 없음). `--hm-font-weight-medium`(500), `--hm-font-weight-bold`(700). 카드·Dialog 제목 700 |
|
||||
| Card 제목 | 20 / 28px / 700 (`--hm-card-title-*`) |
|
||||
| Dialog | 제목 20 / 28 / 700, 설명 14 / 20, 본문 16 / 24 (`--hm-dialog-*`) |
|
||||
| Button | sm 12/18, default 13/20, lg 15/22. Brand 700, Standard(solid·outline) 500 |
|
||||
| Input | small 12, medium 14, large 16 (weight 400) |
|
||||
|
||||
## 4. 크기·간격·Radius
|
||||
|
||||
| 항목 | 값 | 변수 |
|
||||
|---|---|---|
|
||||
| 기본 control 높이 | 34px | `--hm-control-height-md` |
|
||||
| Button 높이(min) | sm 28 · default 34 · lg 42, padding-x 10 · 14 · 18 | — |
|
||||
| Input 높이 | small 28 · medium 34 · large 42(기본), padding-x 10 · 12 · 12 | `--hm-input-*` |
|
||||
| Select Trigger 높이 | medium 34 · large 44(기본) | — |
|
||||
| Control radius | 4px | `--hm-radius-control-md` → `--hm-radius-button`, `--hm-radius-input`, `--hm-radius-select`, `--hm-radius-container` |
|
||||
| Card | border 1px, padding 24px, radius 4px, 그림자 없음 | `--hm-card-*` |
|
||||
| Dialog | radius 8px, padding 24px, Header 아래 16px, Footer 위 16px, 버튼 간격 8px, 그림자 `0 0 12px` 검정 20% | `--hm-dialog-*` |
|
||||
|
||||
## 5. 상태
|
||||
|
||||
| 상태 | 규칙(실제 CSS) |
|
||||
|---|---|
|
||||
| Button Hover·Pressed(brand·solid) | 면 위 검정 20% inset overlay. transition·눌림 이동 없음 |
|
||||
| Button Hover(outline) | 역할 색으로 채우고 흰 글자. Red outline은 Red 8% 면 |
|
||||
| Disabled | Button·Input·Select `opacity: 0.6` + `cursor: not-allowed`, 기본 면 유지 (전역 Disabled 토큰 아님) |
|
||||
| Input Focus | 테두리만 1.5px `--hm-sem-stroke-input-focus`(그림자·glow 없음) |
|
||||
| Invalid | `aria-invalid="true"` → 오류 테두리, 키보드 Focus 시 3px 50% ring |
|
||||
| ReadOnly(Input) | 상자 없이 글자만, 흐리지 않음 |
|
||||
| Focus(그 밖) | shadcn 기본 `focus-visible` ring 유지 |
|
||||
| 선택 | `--hm-sem-state-active` / `--hm-sem-on-state-active` |
|
||||
|
||||
새 상호작용 UI는 이 표의 같은 상태 규칙을 따르고, 가능하면 상태를 가진 기존 컴포넌트(`Button`, `Toggle`, `Input`)를 안쪽에 써서 상태를 다시 만들지 않습니다.
|
||||
|
||||
## 6. 스크롤바
|
||||
|
||||
- 스크롤 영역이 필요하면 `ScrollArea`(Radix)를 씁니다. 막대는 Hover·스크롤 중에 표시됩니다.
|
||||
- 값: 두께 10px(`--hm-scroll-area-scrollbar-size`), thumb `--hm-sem-stroke-default`, Hover `--hm-sem-fg-secondary`, radius 9999px.
|
||||
- 브라우저 기본 스크롤바를 CSS(`::-webkit-scrollbar`)로 새로 꾸미지 않습니다.
|
||||
|
||||
## 7. Overlay·Panel 레이아웃
|
||||
|
||||
- 모달 = `Dialog`(Header · Body(스크롤) · Footer). 확인 = `AlertDialog`. 측면 상세 = `Sheet`. 하단 작업 = `Drawer`. 비모달 보조 = `Popover`.
|
||||
- 새 Panel 모양이 필요하면 `Card`(White `surface` / Beige `content`)로 만듭니다. Floating 모양이 꼭 필요하면 `--hm-sem-floating-*`만 읽습니다.
|
||||
- Dim은 `--hm-sem-overlay-background`.
|
||||
- Scoped Theme(`[data-hm-theme]`)는 body Portal(SelectContent·PopoverContent·DatePicker 팝업)에 자동 전달되지 않습니다.
|
||||
|
||||
## 8. 아이콘
|
||||
|
||||
- `lucide-react`(패키지 의존성)의 아이콘을 씁니다. Button 안 아이콘 기본 크기는 16px(`size-4`, shadcn 기본).
|
||||
- 아이콘 색은 글자색을 상속합니다. 아이콘 전용 색 토큰은 없습니다.
|
||||
|
||||
## 9. 새 컴포넌트 체크리스트
|
||||
|
||||
1. 같은 역할의 기존 컴포넌트·Pattern이 없는지 [COMPONENT_CATALOG.md](./COMPONENT_CATALOG.md)에서 확인했다.
|
||||
2. 소비 프로젝트에 작성했고 패키지 파일·`hm-*`/`data-slot` 규칙을 덮어쓰지 않았다.
|
||||
3. 면·글자·테두리·radius는 §2·§4 변수만 읽는다. HEX·임의 px 없음.
|
||||
4. 버튼·입력·선택은 기존 컴포넌트를 안쪽에 썼다(상태 재구현 없음).
|
||||
5. Font Weight 400/500/700, 글꼴은 상속(`--hm-font-family-base`).
|
||||
6. Label·키보드·Focus 복귀·Disabled를 확인했다.
|
||||
@@ -25,7 +25,8 @@
|
||||
"./tailwind.css": "./dist/tailwind.css"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
"dist",
|
||||
"ai"
|
||||
],
|
||||
"scripts": {
|
||||
"typecheck": "tsc -p tsconfig.json",
|
||||
|
||||
Reference in new issue
Block a user