@x-plat/design-system 0.17.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  # Chart
2
2
 
3
- SVG 기반 차트를 렌더한다. line, bar, pie, doughnut 4가지 타입을 지원한다.
3
+ SVG 기반 차트를 렌더한다. `line`·`curve`·`bar`·`pie`·`doughnut` 다섯 모양을 지원한다.
4
4
 
5
5
  ```tsx
6
6
  import { Chart } from "@x-plat/design-system";
@@ -8,26 +8,53 @@ import { Chart } from "@x-plat/design-system";
8
8
 
9
9
  ## Props
10
10
 
11
+ <!-- props:Chart -->
11
12
  | Prop | 타입 | 기본값 | 설명 |
12
13
  |------|------|--------|------|
13
- | type `*` | `"line" \| "bar" \| "pie" \| "doughnut"` | — | 차트 타입 |
14
- | data `*` | `Record<string, number[]>` | — | 데이터셋 (key: 시리즈 이름, value: 값 배열) |
15
- | labels `*` | `string[]` | — | x축 라벨 배열 |
16
- | tooltip | `boolean` | `true` | 호버 시 툴팁 표시 |
14
+ | data * | `Record<string, number[]>` | - | 계열 이름 → 값 배열. 키 하나가 선/막대 하나가 된다 |
15
+ | labels * | `string[]` | - | x축 라벨. data 의 값 배열과 길이가 같아야 한다 |
16
+ | variant | `"line" \| "curve" \| "bar" \| "pie" \| "doughnut"` | - | 차트 종류 |
17
+ | type | `"line" \| "curve" \| "bar" \| "pie" \| "doughnut"` | - | **@deprecated** 모양 변형은 `variant` 로 받는다. `type` 은 상태 색 전용이다. 기존 사용처가 깨지지 않도록 계속 받는다 — 둘 다 주면 `variant` 가 이긴다. |
18
+ | legend | `boolean` | - | 계열 이름·색·합계를 차트 아래에 적는다. 안 주면 **원형·도넛만 켜진다** — 조각에는 제 이름을 적을 데가 없어서다. 선·곡선·막대는 축 라벨이 있어 지금까지 범례 없이 지냈고, 켜면 차트가 범례 높이만큼 길어지므로 기본값을 바꾸지 않는다. 필요한 곳에서 `legend` 를 주면 된다. |
19
+ | tooltip | `boolean` | `true` | 마우스를 올렸을 때 값 말풍선을 띄운다 |
20
+ | tooltipType | `"dark" \| "light"` | `"light"` | 말풍선 배색 |
21
+
22
+ `*` = 필수
23
+ <!-- /props:Chart -->
17
24
 
18
25
  ## 색상
19
26
 
20
- semantic categorical 토큰 기반으로 시리즈별 색상을 자동 배정한다. line/bar는 `LINE_BAR_PALETTES`, pie/doughnut는 `PIE_PALETTES`를 사용한다.
27
+ semantic categorical 토큰으로 계열마다 색을 자동 배정한다. `line`·`curve`·`bar` 는
28
+ `LINE_BAR_PALETTES`, `pie`·`doughnut` 는 `PIE_COLORS` 를 쓴다.
29
+
30
+ 계열 색은 **순번과 계열 이름 해시**로 정해진다 — `getPalette(LINE_BAR_PALETTES, 순번, 키)[2]`.
31
+ 이름이 같으면 어느 차트에서든 같은 색이 나온다. 범례 점도 같은 식으로 집으므로
32
+ 그림과 어긋나지 않는다.
33
+
34
+ ## 범례
35
+
36
+ `legend` 를 주면 계열 이름·색·합계를 차트 아래에 적는다.
37
+
38
+ 안 주면 **원형·도넛만 켜진다.** 조각에는 제 이름을 적을 데가 없어서다.
39
+ 선·곡선·막대는 축 라벨이 있어 지금까지 범례 없이 지냈고, 켜면 차트가 범례
40
+ 높이만큼 길어진다 — 그래서 기본값을 바꾸지 않았다. 필요한 곳에서 켜면 된다.
41
+
42
+ ```tsx
43
+ <Chart variant="bar" legend labels={…} data={…} /> {/* 켠다 */}
44
+ <Chart variant="pie" legend={false} labels={…} data={…} /> {/* 끈다 */}
45
+ ```
21
46
 
22
47
  ---
23
48
 
24
49
  ## 사용 예시
25
50
 
26
- ### Line
51
+ > 모양은 `variant` 로 준다. `type` 도 아직 받지만 `@deprecated` 다.
52
+
53
+ ### Line / Curve
27
54
 
28
55
  ```tsx
29
56
  <Chart
30
- type="line"
57
+ variant="line"
31
58
  labels={["1월", "2월", "3월", "4월"]}
32
59
  data={{
33
60
  매출: [100, 200, 150, 300],
@@ -36,23 +63,38 @@ semantic categorical 토큰 기반으로 시리즈별 색상을 자동 배정한
36
63
  />
37
64
  ```
38
65
 
66
+ `variant="curve"` 는 같은 데이터를 곡선으로 잇는다.
67
+
39
68
  ### Bar
40
69
 
41
70
  ```tsx
42
71
  <Chart
43
- type="bar"
72
+ variant="bar"
44
73
  labels={["서울", "부산", "대구"]}
45
74
  data={{ 방문자: [500, 300, 200] }}
46
75
  />
47
76
  ```
48
77
 
78
+ 계열이 여럿이라 어느 막대가 무엇인지 적어야 하면 `legend` 를 켠다.
79
+
80
+ ```tsx
81
+ <Chart
82
+ variant="bar"
83
+ legend
84
+ labels={["서울", "부산", "대구"]}
85
+ data={{ 방문자: [500, 300, 200], 가입자: [120, 90, 40] }}
86
+ />
87
+ ```
88
+
49
89
  ### Pie / Doughnut
50
90
 
51
91
  ```tsx
52
92
  <Chart
53
- type="doughnut"
93
+ variant="doughnut"
54
94
  labels={["모바일", "데스크톱", "태블릿"]}
55
95
  data={{ 점유율: [60, 30, 10] }}
56
96
  tooltip={false}
57
97
  />
58
98
  ```
99
+
100
+ 범례는 기본으로 켜져 있다. `legend={false}` 로 끈다.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@x-plat/design-system",
3
- "version": "0.17.0",
3
+ "version": "0.19.0",
4
4
  "description": "XPLAT UI Design System",
5
5
  "author": "XPLAT WOONG",
6
6
  "main": "dist/index.cjs",