@lotte-innovate/ui-component-test 0.0.37 → 0.0.40

package/README.md

@@ -1,163 +1,133 @@
-# 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;
-
-```
+# LOTTE UI COMPONENT LIBRARY
+
+<br />
+
+## 목차
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Components](#components)
+- [License](#license)
+
+## Introduction
+
+모든 L-UI 구성 요소를 내보내는 단일 패키지입니다.
+
+일관되고 통일된 컴포넌트를 제공하며 사용자 정의 및 재사용 가능합니다.
+
+이 라이브러리는 React로 구축된 프로젝트를 지원합니다.
+
+## Installation
+
+패키지를 설치하기 위해 아래 명령어를 사용합니다.
+
+```bash
+  npm i @lotte-innovate/lui
+```
+
+```bash
+  yarn add @lotte-innovate/lui
+```
+
+## Setup
+
+패키지를 설치한 후 css 스타일을 프로젝트로 가져옵니다.
+
+프로젝트 App 진입 파일에 다음 줄을 추가해줍니다.
+
+```
+  import '@lotte-innovate/lui/dist/globals.css';
+```
+
+## Usage
+
+React 프로젝트에서 컴포넌트를 사용하는 방법에 대한 예시입니다.
+
+```javascript
+import React from 'react';
+import { Button } from '@lotte-innovate/lui';
+
+const App = () => {
+  return (
+    <div>
+      <Button onClick={() => alert('Button clicked!')}>Click Me</Button>
+    </div>
+  );
+};
+
+export default App;
+```
+
+컴포넌트에서 아이콘을 사용하려면, 다음과 같은 방법으로 아이콘을 가져올 수 있습니다.
+
+```javascript
+import React from 'react';
+import { IconButton } from '@lotte-innovate/lui';
+import { MagnifyingGlassIcon } from '@radix-ui/react-icons';
+
+const App = () => {
+  return (
+    <div>
+      <IconButton>
+        <MagnifyingGlassIcon />
+      </IconButton>
+    </div>
+  );
+};
+
+export default App;
+```
+
+## Components
+
+<br />
+
+<details>
+  <summary>컴포넌트 목록</summary>
+
+| 구분                  | 종류                                                                                                                                           |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| Typography 컴포넌트   | Text, Header                                                                                                                                   |
+| 기본 컴포넌트         | Avatar, Badge, Button, Icon Button, Label                                                                                                      |
+| 입력 컴포넌트         | Checkbox, Checkbox Group, Checkbox Cards, Radio, Radio Group, Radio Cards, Select, Slider, Switch, Text Area, Text Field, Toggle, Toggle Group |
+| 네비게이션 컴포넌트   | Menubar, Navigation Menu, Tabs, Tab Nav                                                                                                        |
+| 레이아웃 컴포넌트     | Aspeact Ratio, Card, Inset, Scroll Area, Separator, Table                                                                                      |
+| 피드백 컴포넌트       | Alert Dialog, Dialog, Hover Card, Popover, Toast, Tooltip                                                                                      |
+| 로딩 컴포넌트         | Progress, Skeleton, Spinner,                                                                                                                   |
+| 메뉴 및 선택 컴포넌트 | Context Menu, Dropdown Menu, Segmented Control                                                                                                 |
+| 기타 컴포넌트         | Accordian, Callout                                                                                                                             |
+
+</details>
+<details>
+	<summary>차트 목록</summary>
+
+| 구분      | 종류          |
+| --------- | ------------- |
+| 비교 차트 | Bar, Line     |
+| 구성 차트 | Pie, Doughnut |
+| 분포 차트 | Bubble        |
+| 관계 차트 | Radar         |
+
+</details>
+
+<details>
+  <summary>공통 Props 목록</summary>
+
+| name       | description                                       | 단계     | option                                        |
+| ---------- | ------------------------------------------------- | -------- | --------------------------------------------- |
+| Color      | 27가지 색상을 라이트/다크/알파/알파다크 모드 제공 | 1~12단계 | blue, crimson, teal, orange, purple, amber... |
+| Radius     | 컴포넌트의 둥글기 적용                            | 5단계    | none, small, medium, large, full              |
+| Scaling    | 컴포넌트의 비율                                   | 5단계    | 90%, 95%, 100%, 105%, 110%                    |
+| Weight     | 컴포넌트의 텍스트 굵기                            | 4단계    | regular, medium, semibold, bold               |
+| Appearance | 컴포넌트의 디자인 스타일                          | 6단계    | classic, ghost, outline, soft, solid, surface |
+| Size       | 컴포넌트의 크기                                   | 5단계    | x-small, small, medium, large, x-large        |
+
+</details>
+
+<br />
+
+## License
+
+@lotte-innovate