@croquiscom/pds 0.23.0 → 0.23.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/CHANGELOG.md +6 -0
- package/README.md +13 -7
- package/dist/images/{Images.stories.d.ts → Image.stories.d.ts} +0 -0
- package/dist/index.es.js +2 -2
- package/dist/index.es.js.map +1 -1
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -68,6 +68,10 @@ yarn storybook
|
|
|
68
68
|
│ │ ├── generated
|
|
69
69
|
│ │ ├── Icon.stories.tsx
|
|
70
70
|
│ │ └── Icon.stories.mdx
|
|
71
|
+
│ ├── images
|
|
72
|
+
│ │ ├── generated
|
|
73
|
+
│ │ ├── Images.stories.tsx
|
|
74
|
+
│ │ └── Images.stories.mdx
|
|
71
75
|
│ ├── global_styles
|
|
72
76
|
│ ├── themes
|
|
73
77
|
│ ├── styles
|
|
@@ -76,8 +80,10 @@ yarn storybook
|
|
|
76
80
|
│ ├── types
|
|
77
81
|
│ └── index.ts
|
|
78
82
|
└── tools
|
|
79
|
-
├── svgr-component-template.js
|
|
80
|
-
|
|
83
|
+
├── svgr-icons-component-template.js
|
|
84
|
+
├── svgr-icons-template.js
|
|
85
|
+
├── svgr-images-component-template.js
|
|
86
|
+
└── svgr-images-template.js
|
|
81
87
|
```
|
|
82
88
|
|
|
83
89
|
- **[COMPONENT]**: 컴포넌트 디렉토리 이름은 소문자, 구분자는 -로 (eg. toggle-switch) 작성합니다. 하위에는 관련 컴포넌트 파일과 해당 컴포넌트의 스토리북(`*.stories.tsx`) 파일을 포함합니다.
|
|
@@ -86,7 +92,7 @@ yarn storybook
|
|
|
86
92
|
- 각 컴포넌트 디렉토리와 src 하위의 `index.ts`를 통해 export 합니다.
|
|
87
93
|
- **global_styles**: 리셋 스타일을 포함한 글로벌 스타일을 포함합니다.
|
|
88
94
|
- 리셋 스타일을 위한 class 네임은 prefix로 `pds-`를 붙여줍니다.
|
|
89
|
-
- **
|
|
95
|
+
- **foundation**: color, typography와 같은 theme과 관련된 스타일, 스타일 토큰을 포함합니다.
|
|
90
96
|
- **styles**: 컴포넌트에 공용으로 사용할 스타일, 스타일 함수를 포함합니다.
|
|
91
97
|
- **hooks**: 커스텀 훅을 포함합니다.
|
|
92
98
|
- **stories**: 스토리북용 컴포넌트나 스타일, 컴포넌트 외의 스토리북 문서
|
|
@@ -95,12 +101,12 @@ yarn storybook
|
|
|
95
101
|
|
|
96
102
|
### 아이콘 추가
|
|
97
103
|
|
|
98
|
-
⚠️ SVGR을 통해 svg파일을 리액트 컴포넌트로 제네레이트합니다. `src/icons/generated` 하위에서 직접 수정하지 말아주세요!
|
|
104
|
+
⚠️ SVGR을 통해 svg파일을 리액트 컴포넌트로 제네레이트합니다. `src/[icons|images]/generated` 하위에서 직접 수정하지 말아주세요!
|
|
99
105
|
|
|
100
|
-
- `assets/icons`에 svg를 추가합니다.
|
|
106
|
+
- `assets/icons`, `assets/images`에 svg를 추가합니다.
|
|
101
107
|
- `yarn svgr`을 실행합니다.
|
|
102
|
-
- `src/icons/generated` 하위에 제네레이트된 아이콘 리액트 컴포넌트와 `src/icons/generated/index.ts`에 해당 컴포넌트의 export가 추가된 것을 확인합니다.
|
|
103
|
-
- `yarn storybook`을 실행하여 스토리북 내에서 Icon/Icons 메뉴로 이동하여 목록에서 해당 아이콘이 잘 추가되었는지 확입니다.
|
|
108
|
+
- `src/[icons|images]/generated` 하위에 제네레이트된 아이콘 리액트 컴포넌트와 `src/[icons|images]/generated/index.ts`에 해당 컴포넌트의 export가 추가된 것을 확인합니다.
|
|
109
|
+
- `yarn storybook`을 실행하여 스토리북 내에서 Icon/Icons, Image/Images 메뉴로 이동하여 목록에서 해당 아이콘이 잘 추가되었는지 확입니다.
|
|
104
110
|
|
|
105
111
|
### PR
|
|
106
112
|
|
|
File without changes
|