@noraent/nora-datagrid 0.0.84 → 0.0.85

package/dist/buildPackage.json

@@ -1,6 +1,6 @@
 {
   "name": "@noraent/nora-datagrid",
-  "version": "0.0.84",
+  "version": "0.0.85",
   "module": "./dist/nora_datagrid.es.js",
   "main": "./dist/nora_datagrid.cjs.js",
   "private": false,

package/dist/common/constants/useEventCallback.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 항상 최신 상태를 유지 해야할떄 사용
+ */
 declare function useEventCallback<Fn extends (...args: any[]) => any = (...args: unknown[]) => unknown>(fn: Fn): Fn;
 declare function useEventCallback<Args extends unknown[], Return>(fn: (...args: Args) => Return): (...args: Args) => Return;
 export default useEventCallback;

package/dist/common/constants/utils.d.ts

@@ -1,5 +1,24 @@
 import { default as React } from 'react';
+/**
+ * 첫 마운트시 실행 되지 않습니다.
+ * 업데이트시 실행하고 싶다면 사용해주세요.
+ * @param callback
+ * @param deps
+ */
 declare function useUpdateEffect(callback: React.EffectCallback, deps: React.DependencyList): void;
+/**
+ * Array<Object> 경우 변경 감지하기 힘들기 때문에 별도 hook 구성함
+ * 깊은 비교를 통해 종속성 배열의 변경을 감지하는 커스텀 훅
+ * @param callback 실행할 효과 함수
+ * @param dependencies 종속성 배열
+ */
 export declare function useDeepCompareEffect<T>(callback: () => void | (() => void), dependencies: T[]): void;
+/**
+ * Array<Object> 경우 변경 감지하기 힘들기 때문에 별도 hook 구성함
+ * 깊은 비교와 팩토리 함수를 사용하는 메모이제이션 훅
+ * @param factory 계산을 수행하는 팩토리 함수
+ * @param deps 의존성 배열
+ * @returns 메모이제이션된 계산 결과
+ */
 export declare function useDeepCompareMemo<T>(factory: () => T, deps: any[]): T;
 export default useUpdateEffect;

package/dist/common/styled/index.d.ts

@@ -1,4 +1,11 @@
 import { foundation } from '../foundation';
+/**
+ * 💡 알림
+ * 본 섹션은 가이드의 가독성을 높이기 위해 추가되었습니다.
+ * 기능 개발에만 집중할 수 있도록 작성된 문서이며, UI 관련 가이드는 따로 제공되지 않습니다.
+ * 가이드가 아니므로 참고용으로만 활용해 주세요.
+ * 디자인 시스템을 개발할경우 색상이나 사이즈 처리 등 가이드로 사용하기에는 다소 부족한 부분이 있을 수 있습니다. 부득이하게 개발이 필요한 경우 해당부분을 고려하여 개발 해주세요.
+ */
 export declare const StyledButton: import('@emotion/styled').StyledComponent<{
     theme?: import('@emotion/react').Theme;
     as?: React.ElementType;
@@ -20,6 +27,9 @@ interface TypographyProps {
     color?: colorType;
 }
 type colorType = keyof typeof foundation.$scale.color;
+/**
+ * 정리 필요
+ */
 type variantType = keyof typeof variantMapping;
 declare const variantMapping: {
     KR_TITLE_H1: {

package/dist/hooks/useGridApiMethod.d.ts

@@ -1,3 +1,8 @@
 import { default as React } from 'react';
 import { DataGridPrivateApi, DataGridPublicApi, GirdApiCommon, Visibility } from '../types/dataGridProps';
+/**
+ * 객체나 함수를 등록하고 나중에 호출하거나 참조할 때 사용합니다.
+ * @private
+ * @namespace NoraDataGrid.init.useGridApiMethod
+ */
 export declare function useGridApiMethod(apiRef: React.MutableRefObject<GirdApiCommon<DataGridPrivateApi>>, apiMethods: Partial<DataGridPublicApi | DataGridPrivateApi>, visibility: Visibility): void;

package/dist/hooks/useGridApiRef.d.ts

@@ -1,3 +1,7 @@
 import { default as React } from 'react';
 import { GirdApi } from '../types/dataGridProps';
+/**
+ * 그리드 Ref Hook
+ * @returns
+ */
 export declare const useGridApiRef: <Api extends GirdApi>() => React.MutableRefObject<Api>;