From 8be4a7c086ef328c7ad9d230dd6be670fa808a6d Mon Sep 17 00:00:00 2001 From: YangJinSoo94 Date: Fri, 28 Feb 2025 16:58:50 +0900 Subject: [PATCH] =?UTF-8?q?README.md=20=EB=B0=8F=20chart.md=20=EC=83=9D?= =?UTF-8?q?=EC=84=B1=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/common/business_components/README.md | 22 +++++++++++ .../business_components/{ => src}/chart.md | 39 ++----------------- 2 files changed, 25 insertions(+), 36 deletions(-) create mode 100644 packages/common/business_components/README.md rename packages/common/business_components/{ => src}/chart.md (57%) diff --git a/packages/common/business_components/README.md b/packages/common/business_components/README.md new file mode 100644 index 000000000..597f49a5c --- /dev/null +++ b/packages/common/business_components/README.md @@ -0,0 +1,22 @@ +## business_components 패키지 +### 원앤올에서 제공받는 컴포넌트 외에 업무 파트에서 사용할 수 있는 별도 components 패키지지 +  1) 설정 + +    (1) tsconfig.json 'path'에 '@common/business_components' 변수를 추가 +```json +"paths": { + "@/*": ["./*"], + "@common/components/*": ["../../packages/common/components/src/*"], + "@common/components": ["../../packages/common/components/src/index"], + // 작성구문문 + "@common/business_components/*": ["../../packages/common/business_components/src/*"], + "@common/business_components": ["../../packages/common/business_components/src/index"] +} +``` +    (2) package.json 'dependencies'에 '@common/business_components' 추가 +```json +"dependencies": { + "@common/business_components": "workspace:*", + "next": "15.1.7" +}, +``` \ No newline at end of file diff --git a/packages/common/business_components/chart.md b/packages/common/business_components/src/chart.md similarity index 57% rename from packages/common/business_components/chart.md rename to packages/common/business_components/src/chart.md index ceacc3a69..f2d989375 100644 --- a/packages/common/business_components/chart.md +++ b/packages/common/business_components/src/chart.md @@ -2,34 +2,11 @@ ### 공통 모듈 중 Chart를 다양한 테마로 적용시킬 수 있도록 해주는 모듈   1. 차트 모듈 사용법 -    1-1) 설정 - -      (1) tsconfig.json 'path'에 '@common/business_components' 변수를 추가 -```json -"paths": { - "@/*": ["./*"], - "@common/components/*": ["../../packages/common/components/src/*"], - "@common/components": ["../../packages/common/components/src/index"], - // 작성구문문 - "@common/business_components/*": ["../../packages/common/business_components/src/*"], - "@common/business_components": ["../../packages/common/business_components/src/index"] -} -``` -      (2) package.json 'dependencies'에 '@common/business_components' 추가 -```json -"dependencies": { - "@common/business_components": "workspace:*", - "next": "15.1.7" -}, -``` - -    1-2) 호출방법 +    1-1) 호출방법       (1) 파일에 차트생성에 필요한 form, MainChart, MainConfig 임폴트 ```js -import type { ChartConfig } from "@common/business_components"; -import {MainChart} from "@common/business_components"; -import {CHART_FORM} from "@common/business_components"; +import {type ChartConfig, MainChart, CHART_FORM } from "@common/business_components"; ```       (2) ChartForm 지정 ```js @@ -74,14 +51,4 @@ return ( ); -``` -  - -  2. 차트 모듈 구조 - - - - - - - +``` \ No newline at end of file