@bstage-sdk/design 0.13.0 → 0.14.1
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.
- package/README.md +13 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
# @bstage-sdk/design
|
|
2
2
|
|
|
3
|
-
bstage 커스텀 템플릿을 bstage 디자인 시스템에 맞추기 위한 **디자인 토큰**을
|
|
3
|
+
bstage 커스텀 템플릿을 bstage 디자인 시스템에 맞추기 위한 **디자인 토큰**을 제공합니다.
|
|
4
4
|
|
|
5
|
-
- 토큰 **이름**만
|
|
6
|
-
- 토큰 이름은
|
|
5
|
+
- 토큰 **이름**만 제공합니다(값은 복붙하지 않습니다). 게시된 화면에서는 플랫폼이 `:root`에 깔아둔 실제 값을 상속하고, 개발 중에는 이 패키지의 fallback CSS가 기본 bstage 톤을 보여줍니다.
|
|
6
|
+
- 토큰 이름은 **플랫폼 프런트엔드의 원본 정의에서 생성**되어 프로덕션과 항상 일치합니다 (`--user-mode-*` / `--admin-mode-*`).
|
|
7
7
|
|
|
8
|
-
> 값 배선(`bstage dev` 주입·프로덕션 제외)과 디자인 가이드(`AGENTS.md`) 통합은 별도 문서에서
|
|
8
|
+
> 값 배선(`bstage dev` 주입·프로덕션 제외)과 디자인 가이드(`AGENTS.md`) 통합은 별도 문서에서 다룹니다.
|
|
9
9
|
|
|
10
10
|
## 타깃 선택 — 서브패스로 구분
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
사용자 화면 / 운영자 화면 중 대상에 맞는 서브패스를 import 합니다.
|
|
13
13
|
|
|
14
14
|
```ts
|
|
15
15
|
import { color, shadow, textStyle, cssVar } from '@bstage-sdk/design/user'
|
|
16
|
-
//
|
|
16
|
+
// 운영자 화면: '@bstage-sdk/design/admin'
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## 사용
|
|
@@ -37,21 +37,21 @@ function ProfileCard() {
|
|
|
37
37
|
- **`textStyle(token)`** — 타이포그래피 인라인 스타일. user는 `'16/title/semibold'`, admin은 `'16/title/med'`
|
|
38
38
|
- **원자료**: `modeColors` / `flatColors` / `shadowTokens` / `typographyTokens` / `fontWeightMap` / `fontFamily`
|
|
39
39
|
|
|
40
|
-
값은 `var(--...)` 참조라, 실제 색은 얹힌 환경의 `:root`가
|
|
40
|
+
값은 `var(--...)` 참조라, 실제 색은 얹힌 환경의 `:root`가 결정합니다(게시된 화면=플랫폼, 개발=fallback CSS).
|
|
41
41
|
|
|
42
42
|
## CSS fallback
|
|
43
43
|
|
|
44
|
-
개발/미리보기에서 bstage 톤을 보려면 fallback CSS를 호스트 `:root`에
|
|
44
|
+
개발/미리보기에서 bstage 톤을 보려면 fallback CSS를 호스트 `:root`에 깝니다(자세한 자동 주입은 `bstage dev`):
|
|
45
45
|
|
|
46
46
|
```css
|
|
47
47
|
@import '@bstage-sdk/design/css/user.css'; /* light + dark */
|
|
48
|
-
/*
|
|
48
|
+
/* 운영자 화면: '@bstage-sdk/design/css/admin.css' (light 전용) */
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
이 CSS는 `:root`-scoped **fallback**
|
|
51
|
+
이 CSS는 `:root`-scoped **fallback** 입니다(`:host` 하드 주입 없음). 프로덕션 번들에는 포함하지 않습니다.
|
|
52
52
|
|
|
53
53
|
## 토큰 갱신 (유지보수자용)
|
|
54
54
|
|
|
55
|
-
토큰은 손으로 관리하지
|
|
56
|
-
`src/{user,admin}/tokens.generated.ts`로
|
|
57
|
-
빌드에 포함하지 않고,
|
|
55
|
+
토큰은 손으로 관리하지 않습니다. b.stage 디자인 시스템 원본(단일 기준)에서 생성해
|
|
56
|
+
`src/{user,admin}/tokens.generated.ts`로 커밋합니다. 원본이 이 저장소에 없으므로 생성 자체는
|
|
57
|
+
빌드에 포함하지 않고, 생성 결과만 두어 값이 프로덕션과 어긋나지 않게 합니다.
|