@lotte-innovate/ui-component-test 0.1.6 → 0.1.8

package/README.md

@@ -1,163 +1,163 @@
-# radix-ui 라이브러리 활용 Storybook UI Component 만들기
-
-<br />
-
-## 사전 설치 라이브러리
-
-- radix-ui
-  - 주요 컴포넌트 사용 시 활용할 Headless UI 라이브러리
-
-```shell
-npm install @radix-ui/react-popover@latest -E
-```
-
-- storybook
-  - 컴포넌트 관리를 위해 사용
-
-```shell
-npx sb init
-npx storybook@latest add @storybook/addon-styling-webpack
-```
-
-- clsx
-  - 조건부 className 작성을 위해 사용
-
-```shell
-npm i clsx
-```
-
-- tailwind-merge
-  - 스타일 충돌 없이 자바스크립트에서 tailwind CSS 클래스를 효율적으로 병합하는 기능을 가진 라이브러리
-
-```shell
-npm i tailwind-merge
-```
-
-- class-variance-authority (CVA)
-  - 일관성 있는 UI를 정의하고 사용할 수 있도록 도와주는 툴로써 shadcn/ui 컴포넌트의 핵심 도구
-
-```shell
-npm i class-variance-authority
-```
-
-<br />
-
-## 실행
-
-- 스토리북 실행
-
-```shell
-npm run storybook
-```
-
-> 접속주소(포트 6006 사용 시): `http://localhost:6006`
-
-- 웹페이지 실행
-
-```shell
-npm run dev
-```
-
-> 접속주소(포트 3000 사용 시): `http://localhost:3000`
-
-## package publish
-
-- 타입스크립트 컴파일
-
-```shell
-npm run publish:npm
-```
-
-- npm package 배포 시
-
-  - npm 로그인
-
-  ```shell
-  npm login
-  ```
-
-  - package.json 버전 수정 후 컴파일 진행
-
-  ```shell
-  npm run publish:npm
-  ```
-
-  - 패키지 배포
-
-  ```shell
-  npm publish
-  ```
-
-  - npm scope 배포
-    - npm 로그인 후, 조직 생성 시 @계정명 으로 scope 생성 
-  scope로 생성된 패키지는 npm publish 시, 아래 옵션 추가 
-
-  ```shell
-  npm publish --access=public
-  ```
-
-
-- npm package 미배포시
-
-  - package.json 버전 수정 후 컴파일 진행
-
-  ```shell
-  npm run publish:npm
-  ```
-
-  - dist/ 파일 및 설정파일 추출 후 전달
-
-## 사용자 이용 방법
-
-### npm 배포 시
-
-- npm package 설치
-
-```sh
-npm install <package_name>
-```
-
-### npm 미배포시
-
-- 전달 받은 package 모듈 파일을 node_modules/ 폴더에 추가
-
-### tailwind 설정 방법
-
-- tailwind config 파일 설정
-
-```js
-// tailwind.config.ts
-import type { Config } from 'tailwindcss';
-// UI 라이브러리 tailwind config 파일 호출
-// >>>>>>>> 추가
- const packageTailwindConfig = require('ui-component-test/tailwind.config.js');
-// >>>>>>>>
-
-const config: Config = {
-  content: [
-    './src/pages/**/*.{js,ts,jsx,tsx,mdx,zip}',
-    './src/components/**/*.{js,ts,jsx,tsx,mdx,zip}',
-    './src/app/**/*.{js,ts,jsx,tsx,mdx,zip}',
-// 해당 프로젝트 css 표준 컴포넌트에 적용 가능
-// >>>>>>>> 추가
-    './node_modules/ui-component-test/**/*.{js,ts,jsx,tsx,mdx,zip}',
-// >>>>>>>>
-  ],
-  theme: {
-    extend: {
-      backgroundImage: {
-        'gradient-radial': 'radial-gradient(var(--tw-gradient-stops))',
-        'gradient-conic': 'conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))',
-      },
-      colors: {},
-// UI 라이브러리 tailwind config 파일 적용
-// >>>>>>>> 추가
-      ...packageTailwindConfig?.theme?.extend,
-// >>>>>>>>
-    },
-  },
-  plugins: [],
-};
-export default config;
-
-```
+# radix-ui 라이브러리 활용 Storybook UI Component 만들기
+
+<br />
+
+## 사전 설치 라이브러리
+
+- radix-ui
+  - 주요 컴포넌트 사용 시 활용할 Headless UI 라이브러리
+
+```shell
+npm install @radix-ui/react-popover@latest -E
+```
+
+- storybook
+  - 컴포넌트 관리를 위해 사용
+
+```shell
+npx sb init
+npx storybook@latest add @storybook/addon-styling-webpack
+```
+
+- clsx
+  - 조건부 className 작성을 위해 사용
+
+```shell
+npm i clsx
+```
+
+- tailwind-merge
+  - 스타일 충돌 없이 자바스크립트에서 tailwind CSS 클래스를 효율적으로 병합하는 기능을 가진 라이브러리
+
+```shell
+npm i tailwind-merge
+```
+
+- class-variance-authority (CVA)
+  - 일관성 있는 UI를 정의하고 사용할 수 있도록 도와주는 툴로써 shadcn/ui 컴포넌트의 핵심 도구
+
+```shell
+npm i class-variance-authority
+```
+
+<br />
+
+## 실행
+
+- 스토리북 실행
+
+```shell
+npm run storybook
+```
+
+> 접속주소(포트 6006 사용 시): `http://localhost:6006`
+
+- 웹페이지 실행
+
+```shell
+npm run dev
+```
+
+> 접속주소(포트 3000 사용 시): `http://localhost:3000`
+
+## package publish
+
+- 타입스크립트 컴파일
+
+```shell
+npm run publish:npm
+```
+
+- npm package 배포 시
+
+  - npm 로그인
+
+  ```shell
+  npm login
+  ```
+
+  - package.json 버전 수정 후 컴파일 진행
+
+  ```shell
+  npm run publish:npm
+  ```
+
+  - 패키지 배포
+
+  ```shell
+  npm publish
+  ```
+
+  - npm scope 배포
+    - npm 로그인 후, 조직 생성 시 @계정명 으로 scope 생성 
+  scope로 생성된 패키지는 npm publish 시, 아래 옵션 추가 
+
+  ```shell
+  npm publish --access=public
+  ```
+
+
+- npm package 미배포시
+
+  - package.json 버전 수정 후 컴파일 진행
+
+  ```shell
+  npm run publish:npm
+  ```
+
+  - dist/ 파일 및 설정파일 추출 후 전달
+
+## 사용자 이용 방법
+
+### npm 배포 시
+
+- npm package 설치
+
+```sh
+npm install <package_name>
+```
+
+### npm 미배포시
+
+- 전달 받은 package 모듈 파일을 node_modules/ 폴더에 추가
+
+### tailwind 설정 방법
+
+- tailwind config 파일 설정
+
+```js
+// tailwind.config.ts
+import type { Config } from 'tailwindcss';
+// UI 라이브러리 tailwind config 파일 호출
+// >>>>>>>> 추가
+ const packageTailwindConfig = require('ui-component-test/tailwind.config.js');
+// >>>>>>>>
+
+const config: Config = {
+  content: [
+    './src/pages/**/*.{js,ts,jsx,tsx,mdx,zip}',
+    './src/components/**/*.{js,ts,jsx,tsx,mdx,zip}',
+    './src/app/**/*.{js,ts,jsx,tsx,mdx,zip}',
+// 해당 프로젝트 css 표준 컴포넌트에 적용 가능
+// >>>>>>>> 추가
+    './node_modules/ui-component-test/**/*.{js,ts,jsx,tsx,mdx,zip}',
+// >>>>>>>>
+  ],
+  theme: {
+    extend: {
+      backgroundImage: {
+        'gradient-radial': 'radial-gradient(var(--tw-gradient-stops))',
+        'gradient-conic': 'conic-gradient(from 180deg at 50% 50%, var(--tw-gradient-stops))',
+      },
+      colors: {},
+// UI 라이브러리 tailwind config 파일 적용
+// >>>>>>>> 추가
+      ...packageTailwindConfig?.theme?.extend,
+// >>>>>>>>
+    },
+  },
+  plugins: [],
+};
+export default config;
+
+```