@owp/core 2.5.45 → 2.5.48

package/dist/types/components/OwpPicker/OwpDateRangePicker.d.ts

@@ -2,32 +2,37 @@ import type { TextFieldProps } from '@mui/material';
 import { type DatePickerProps } from 'react-datepicker';
 type DatePickerValue = string | Date;
 interface OwnProps {
+    /** root className */
     className?: string;
+    /** 입력 label */
     label?: string;
+    /** TextField variant */
     variant?: TextFieldProps['variant'];
+    /** TextField sx */
     sx?: TextFieldProps['sx'];
+    /** 선택 range 값. `start,end` 문자열을 picker mode별 formatter 기준으로 파싱 */
     value?: DatePickerValue;
+    /** 입력 필드 전체 너비 사용 여부 */
     fullWidth?: boolean;
+    /** clear 버튼 표시 여부 */
     clearable?: boolean;
+    /** 오늘 이후 날짜 비활성화 여부 */
     disableFuture?: boolean;
+    /** 선택/clear 시 `start,end` formatter 문자열을 전달하는 handler */
     onChange?: (value?: DatePickerValue) => void;
+    /** 연도 range picker 사용 여부 */
     showYearPicker?: boolean;
+    /** 월 range picker 사용 여부 */
     showMonthPicker?: boolean;
+    /** calendar에 week number 표시 여부 */
     showWeekNumbers?: boolean;
+    /** custom input으로 쓰는 TextField props */
     textFieldProps?: Omit<TextFieldProps, 'value' | 'defaultValue' | 'onChange'>;
 }
 type OwpDatePickerProps = OwnProps & DatePickerProps;
 /**
- * OwpDateRangePicker 컴포넌트
- * @param className CSS 클래스명
- * @param label 입력 라벨
- * @param variant variant 값
- * @param sx sx 값
- * @param value 현재 값
- * @param fullWidth 전체 너비 사용 여부
- * @param clearable 초기화 가능 여부
- * @param disableFuture 미래 날짜 비활성화 여부
- * @param showWeekNumbers 캘린더 주차 표시 여부
+ * `start,end` 문자열 값을 사용하는 OWP DateRangePicker
+ * @param props range value formatter, calendar mode, clear/future 제어, TextField 표시 옵션
  */
 declare const OwpDateRangePicker: ({ className, label, variant, sx, value, fullWidth, clearable, disableFuture, onChange, minDate, maxDate, minTime, maxTime, showYearPicker, showMonthPicker, showWeekNumbers, textFieldProps, popperClassName: popperClassNameProp, popperContainer: popperContainerProp, ...datePickerProps }: OwpDatePickerProps) => import("react/jsx-runtime").JSX.Element;
 export { OwpDateRangePicker };

package/dist/types/components/OwpPicker/OwpTimePicker.d.ts

@@ -1,35 +1,40 @@
 import { type TextFieldProps } from '@mui/material';
 import { type TimePickerProps } from '@mui/x-date-pickers';
 import { type Dayjs } from '@/dayjs';
+/**
+ * TimePicker에서 허용하는 외부 value 타입
+ */
 export type OwpTimePickerValue = string | Date | Dayjs;
 interface OwnProps {
+    /** 입력 label */
     label?: string;
+    /** TextField variant */
     variant?: TextFieldProps['variant'];
+    /** TextField sx */
     sx?: TextFieldProps['sx'];
+    /** 선택 시간 값. 문자열은 `format` 기준으로 파싱 */
     value?: OwpTimePickerValue;
+    /** 표시/파싱 format. 초 포함 여부와 AM/PM 여부 판단에 사용 */
     format?: string;
+    /** 오전/오후 표시 사용 여부. 생략 시 `format`의 `A/a` 포함 여부로 결정 */
     useAmPm?: boolean;
+    /** 비어 있는 시간 section placeholder */
     placeholder?: string;
+    /** clear 버튼 표시 여부 */
     clearable?: boolean;
+    /** 입력 필드 전체 너비 사용 여부 */
     fullWidth?: boolean;
+    /** 선택/clear 시 정규화된 `HH:mm` 또는 `HH:mm:ss` 문자열을 전달하는 handler */
     onChange?: (value?: string) => void;
+    /** MUI X TimePicker slot props */
     slotProps?: TimePickerProps['slotProps'];
+    /** 외부 표시 TextField props */
     textFieldProps?: Omit<TextFieldProps, 'value' | 'defaultValue' | 'onChange'>;
 }
 type OwpTimePickerProps = OwnProps & Omit<TimePickerProps, 'value' | 'onChange' | 'label' | 'format' | 'ampm' | 'slotProps' | 'enableAccessibleFieldDOMStructure'>;
 /**
- * OwpTimePicker 컴포넌트
- * @param label 입력 라벨
- * @param variant variant 값
- * @param sx sx 값
- * @param value 현재 값, clear 버튼 동작 대상 값
- * @param format 시간 포맷
- * @param useAmPm 오전/오후 포맷 사용 여부
- * @param clearable 초기화 가능 여부
- * @param fullWidth 전체 너비 사용 여부
- * @param onChange onChange 핸들러, clear 버튼 활성화 조건
- * @param slotProps TimePicker slot props
- * @param textFieldProps TextField props
+ * MUI X TimePicker를 OWP 입력 UX와 `HH:mm` 계열 문자열 value로 감싼 time selector
+ * @param props value format, AM/PM 표시, clear 제어, TextField/slot 표시 옵션
  */
 declare const OwpTimePicker: ({ label, variant, sx, value, format, useAmPm, placeholder, clearable, fullWidth, onChange, textFieldProps, localeText, open: openProp, onOpen, onClose, slots, slotProps, ...timePickerProps }: OwpTimePickerProps) => import("react/jsx-runtime").JSX.Element;
 export { OwpTimePicker };

package/dist/types/components/OwpPicker/OwpWeekDatePicker.d.ts

@@ -1,34 +1,39 @@
 import { type TextFieldProps } from '@mui/material';
 import { type DatePickerProps } from 'react-datepicker';
+/**
+ * WeekDatePicker에서 허용하는 외부 value 타입
+ */
 export type WeekDatePickerValue = string | Date;
 interface WeekPickerProps {
+    /** root className */
     className?: string;
+    /** 입력 label */
     label?: string;
+    /** TextField variant */
     variant?: TextFieldProps['variant'];
+    /** TextField sx */
     sx?: TextFieldProps['sx'];
+    /** 선택 주차 값. `YYYY-WW`, `WW YYYY-MM-DD`, `YYYY-MM-DD`, Date 입력 지원 */
     value?: WeekDatePickerValue;
+    /** clear 버튼 표시 여부 */
     clearable?: boolean;
+    /** 오늘 이후 날짜 비활성화 여부 */
     disableFuture?: boolean;
+    /** 이전 호환용 prop. week picker에서는 월 선택 UI를 사용하지 않음 */
     showMonthPicker?: boolean;
+    /** onChange 값을 `YYYY-WW` 형식으로 반환할지 여부 */
     useYearWeekValue?: boolean;
+    /** 입력 필드 전체 너비 사용 여부 */
     fullWidth?: boolean;
+    /** 선택/clear 시 week value를 전달하는 handler */
     onChange?: (value?: WeekDatePickerValue) => void;
+    /** custom input으로 쓰는 TextField props */
     textFieldProps?: Omit<TextFieldProps, 'value' | 'defaultValue' | 'onChange'>;
 }
 type OwpWeekDatePickerProps = WeekPickerProps & DatePickerProps;
 /**
- * OwpWeekDatePicker 컴포넌트
- * @param className CSS 클래스명
- * @param label 입력 라벨
- * @param variant variant 값
- * @param sx sx 값
- * @param value 현재 값
- * @param onChange onChange 핸들러
- * @param fullWidth 전체 너비 사용 여부
- * @param showWeekNumbers 주 번호 표시 여부
- * @param useYearWeekValue YYYY-WW onChange value 사용 여부
- * @param clearable 초기화 가능 여부
- * @param disableFuture 미래 날짜 비활성화 여부
+ * ISO week 기준 날짜를 선택하고 week value로 반환하는 OWP WeekDatePicker
+ * @param props week value format, `YYYY-WW` 반환 옵션, clear/future 제어, TextField 표시 옵션
  */
 export declare const OwpWeekDatePicker: ({ className, label, variant, sx, value, onChange, fullWidth, showWeekNumbers, textFieldProps, clearable, disableFuture, showMonthPicker, useYearWeekValue, calendarClassName: calendarClassNameProp, calendarContainer: calendarContainerProp, open: openProp, openToDate: openToDateProp, onCalendarOpen, onCalendarClose, onClickOutside, onInputClick, renderCustomHeader: renderCustomHeaderProp, allowSameDay: allowSameDayProp, shouldCloseOnSelect: shouldCloseOnSelectProp, popperClassName: popperClassNameProp, popperContainer: popperContainerProp, preventOpenOnFocus, ...datePickerProps }: OwpWeekDatePickerProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/OwpPicker/constants/index.d.ts

@@ -1,17 +1,32 @@
+/** Year picker value format */
 export declare const VALUE_YEAR_FORMATTER = "YYYY";
+/** Month picker value format */
 export declare const VALUE_MONTH_FORMATTER = "YYYY-MM";
+/** Date picker value format */
 export declare const VALUE_DATE_FORMATTER = "YYYY-MM-DD";
+/** Time picker value format */
 export declare const VALUE_TIME_FORMATTER = "HH:mm";
+/** DateTime picker value format */
 export declare const VALUE_DATE_TIME_FORMATTER = "YYYY-MM-DD HH:mm";
+/** Second 단위까지 포함한 time value format */
 export declare const VALUE_TIME_SECOND_FORMATTER = "HH:mm:ss";
+/** Picker 입력 형식 오류 translation key */
 export declare const PICKER_INVALID_INPUT_MESSAGE_KEY = "Message.\uC62C\uBC14\uB978 \uD615\uC2DD\uC73C\uB85C \uC785\uB825\uD574\uC8FC\uC138\uC694.";
+/** Picker popper open/close transition 지속 시간(ms) */
 export declare const PICKER_TRANSITION_DURATION = 225;
+/** Picker surface transform transition 지속 시간(ms) */
 export declare const PICKER_TRANSFORM_TRANSITION_DURATION = 150;
+/** Picker exit transform 시작 지연 시간(ms) */
 export declare const PICKER_EXIT_TRANSFORM_DELAY = 75;
+/** 닫힘 직후 동일 click으로 picker가 재오픈되는 것을 막는 시간(ms) */
 export declare const PICKER_REOPEN_SUPPRESSION_DURATION: number;
+/** Time picker editor 한 section의 viewport 너비(px) */
 export declare const TIME_PICKER_EDITOR_SECTION_WIDTH = 64;
+/** Time picker editor item 너비(px) */
 export declare const TIME_PICKER_EDITOR_SECTION_ITEM_WIDTH = 56;
+/** MUI popper 느낌을 맞추는 picker editor surface shadow */
 export declare const OWP_PICKER_EDITOR_SURFACE_SHADOW: string;
+/** 선택된 time picker item의 hover/focus sx */
 export declare const TIME_PICKER_SELECTED_ITEM_SX: {
     '&:hover': {
         backgroundColor: string;

package/dist/types/components/OwpPicker/hooks/useOwpPickerPopperTransition.d.ts

@@ -1,5 +1,9 @@
+/** Picker popper가 DOM에 남아있는 동안의 animation 단계 */
 export type OwpPickerTransitionState = 'opening' | 'open' | 'closing' | 'closed';
-/** Picker popper visibility transition state */
+/**
+ * Picker popper의 render 유지 여부와 animation 상태 동기화
+ * @param open 외부에서 전달된 popper 열림 상태
+ */
 export declare const useOwpPickerPopperTransition: (open: boolean) => {
     shouldRender: boolean;
     state: OwpPickerTransitionState;

package/dist/types/components/OwpPicker/internal/CalendarContainer.d.ts

@@ -1,7 +1,7 @@
-import { ReactNode } from 'react';
+import type { ReactNode } from 'react';
 /**
- * CalendarContainer 컴포넌트
- * @param children 하위 콘텐츠
+ * react-datepicker calendar를 `#calendar-portal` DOM으로 portal render
+ * @param children calendar popper 콘텐츠
  */
 export declare const CalendarContainer: ({ children }: {
     children: ReactNode;

package/dist/types/components/OwpPicker/internal/DatePickerInput.d.ts

@@ -18,17 +18,17 @@ interface OwnProps {
     onInputKeyDown?: TextFieldKeyDownEventHandler;
 }
 /**
- * DatePickerInput 컴포넌트
- * @param value 현재 값
- * @param valueFormatter valueFormatter 값
- * @param useRange useRange 값
- * @param showTimeSelect showTimeSelect 값
- * @param showTimeSelectOnly showTimeSelectOnly 값
- * @param clearable 초기화 가능 여부
- * @param reset reset 값
- * @param onInputAreaClick 입력 영역 클릭 핸들러
- * @param onIconClick 아이콘 클릭 핸들러
- * @param ref forwardRef 참조
+ * DatePicker 표시 값을 input-like button으로 render하고 clear/icon action 제공
+ * @param value 현재 picker 값
+ * @param valueFormatter 표시 값 변환 format
+ * @param useRange range value 표시 여부
+ * @param showTimeSelect date/time 표시 모드 여부
+ * @param showTimeSelectOnly time-only 표시 모드 여부
+ * @param clearable 초기화 버튼 노출 여부
+ * @param reset value 초기화 callback
+ * @param onInputAreaClick 입력 영역 click callback
+ * @param onIconClick calendar icon click callback
+ * @param ref root button element 참조
  */
 export declare const DatePickerInput: import("react").ForwardRefExoticComponent<(Omit<import("@mui/material").StandardTextFieldProps & OwnProps, "ref"> | Omit<import("@mui/material").OutlinedTextFieldProps & OwnProps, "ref"> | Omit<import("@mui/material").FilledTextFieldProps & OwnProps, "ref">) & import("react").RefAttributes<unknown>>;
 export {};

package/dist/types/components/OwpPicker/internal/OwpDatePickerCalendarHeader.d.ts

@@ -1,4 +1,5 @@
 import type { ReactDatePickerCustomHeaderProps } from 'react-datepicker';
+/** Calendar header dropdown에서 전환 가능한 선택 view */
 export type OwpDatePickerCalendarHeaderView = 'monthYear' | 'year';
 interface OwpDatePickerCalendarHeaderProps extends ReactDatePickerCustomHeaderProps {
     className?: string;

package/dist/types/components/OwpPicker/utils/registerOwpDatePickerLocales.d.ts

@@ -0,0 +1,4 @@
+/**
+ * react-datepicker locale 등록
+ */
+export declare const registerOwpDatePickerLocales: () => void;

package/dist/types/components/OwpQuerySelector/OwpQuerySelector.d.ts

@@ -1,6 +1,6 @@
 import type { OwpQuerySelectorProps } from './types';
 /**
- * 원격 조회형 공통 선택기
- * @param props 원격 선택기 props
+ * API 응답 목록을 value/label resolver로 option화하는 원격 selector
+ * @param props API URL, query 조건, 응답 목록 key, value/label resolver, async search 설정
  */
 export declare const OwpQuerySelector: ({ apiUrl, asyncSearch, buildRequestQuery, className, filterOptions, forceEmptyOptions, multiple, query, queryKeyDeps, responseListKey, selectorType, value, valueKey, valueResolver, labelKey, labelResolver, onChange, defaultValue, showAllOption, textFieldProps, ...selectorBaseProps }: OwpQuerySelectorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/OwpQuerySelector/types/types.d.ts

@@ -1,10 +1,18 @@
 import type { OwpSelectorBaseChangeEvent, OwpSelectorBaseProps } from '@/components/OwpSelectorBase/types';
 type OwpQuerySelectorItem = Record<string, unknown>;
+/**
+ * Autocomplete keyword 검색 시 사용할 원격 조회 query builder 설정
+ */
 export interface OwpQuerySelectorAsyncSearch {
+    /** 전체 option 조회 시 기본 query에 병합할 조건 */
     buildAllQuery?: () => Record<string, unknown>;
+    /** 입력 keyword를 API query 조건으로 변환 */
     buildKeywordQuery: (keyword: string) => Record<string, unknown>;
+    /** 이미 선택된 id 목록을 option 조회 query 조건으로 변환 */
     buildSelectedQuery?: (selectedIds: string[]) => Record<string, unknown>;
+    /** keyword 입력 debounce 시간(ms) */
     debounceMs?: number;
+    /** 원격 검색을 시작할 최소 keyword 길이 */
     minLength?: number;
 }
 type OwpQuerySelectorValueConfig = {
@@ -22,24 +30,47 @@ type OwpQuerySelectorLabelConfig = {
     labelResolver: (item: OwpQuerySelectorItem) => string;
 };
 type OwpQuerySelectorSharedProps = Omit<OwpSelectorBaseProps, 'allOptions' | 'allValueMode' | 'disableClientFilter' | 'loading' | 'onChange' | 'options'> & {
+    /** option 목록 조회 API URL */
     apiUrl: string;
+    /** `query` 객체를 실제 request query로 변환하는 함수 */
     buildRequestQuery?: (query: Record<string, unknown>) => Record<string, unknown>;
+    /** API 응답 row 배열을 selector option 변환 전에 필터링 */
     filterOptions?: (items: OwpQuerySelectorItem[]) => OwpQuerySelectorItem[];
+    /** query 결과와 선택값을 모두 빈 option 상태로 강제 */
     forceEmptyOptions?: boolean;
+    /** selector value 변경 시 호출되는 change handler */
     onChange?: (event: OwpSelectorBaseChangeEvent) => void;
+    /** API 조회에 사용할 기본 query 조건 */
     query: Record<string, unknown>;
     /** 숨은 요청 조건용 React Query key 추가 deps */
     queryKeyDeps?: readonly unknown[];
+    /** API 응답 객체에서 목록 배열을 읽을 key. 기본값은 `resultData` */
     responseListKey?: string;
 };
+/**
+ * 원격 query selector 공통 props
+ */
 export type OwpQuerySelectorBaseProps = OwpQuerySelectorSharedProps & OwpQuerySelectorValueConfig & OwpQuerySelectorLabelConfig;
+/**
+ * Autocomplete 모드 query selector props
+ */
 export type OwpAutocompleteQuerySelectorProps = OwpQuerySelectorBaseProps & {
+    /** keyword 기반 원격 검색 설정 */
     asyncSearch?: OwpQuerySelectorAsyncSearch;
+    /** Autocomplete render mode */
     selectorType: 'autocomplete';
 };
+/**
+ * Select 모드 query selector props
+ */
 export type OwpSelectQuerySelectorProps = OwpQuerySelectorBaseProps & {
+    /** Select 모드에서는 asyncSearch 비활성 */
     asyncSearch?: never;
+    /** Select render mode */
     selectorType?: 'select';
 };
+/**
+ * 원격 조회 기반 selector props
+ */
 export type OwpQuerySelectorProps = OwpAutocompleteQuerySelectorProps | OwpSelectQuerySelectorProps;
 export {};

package/dist/types/components/OwpRequiredHelperText/OwpRequiredHelperText.d.ts

@@ -1,18 +1,22 @@
 import { type ReactNode } from 'react';
+/**
+ * 필수 표시가 포함될 수 있는 helper text props
+ */
 export interface OwpRequiredHelperTextProps {
+    /** helper text 내용. `message`보다 우선 */
     children?: ReactNode;
+    /** `children`이 없을 때 사용할 helper text 내용 */
     message?: ReactNode;
+    /** root 또는 clone 대상 element 추가 className */
     className?: string;
+    /** 필수 표시 `*` 노출 여부 */
     required?: boolean;
+    /** 필수 표시 위치 */
     requiredPosition?: 'left' | 'right';
 }
 /**
- * 필수 표시 안내 문구
- * @param children 안내 문구
- * @param message 안내 문구
- * @param className 추가 스타일 클래스
- * @param required 필수 표시 노출 여부
- * @param requiredPosition 필수 표시 위치
+ * helper text 좌우에 필수 표시를 합성하는 텍스트 wrapper
+ * @param props helper text 내용, 필수 표시 여부와 위치, 추가 className
  */
 declare function OwpRequiredHelperText({ children, message, className, required, requiredPosition, }: OwpRequiredHelperTextProps): import("react/jsx-runtime").JSX.Element;
 export { OwpRequiredHelperText };

package/dist/types/components/OwpScrollbars/OwpScrollbars.d.ts

@@ -19,8 +19,8 @@ type OwpScrollbarEventName = keyof typeof handlerNameByEvent;
 type OwpScrollbarHandlerName = (typeof handlerNameByEvent)[OwpScrollbarEventName];
 type OwpScrollbarEventCallback = (container: HTMLDivElement) => void;
 /**
- * OwpScrollbars 컴포넌트
- * @param props 컴포넌트 props
+ * PerfectScrollbar 기반 custom scrollbar wrapper
+ * @param props scroll event handler, route/children 변경 시 scroll reset 옵션, PerfectScrollbar 옵션
  * @param ref forwardRef 참조
  */
 declare const OwpScrollbars: import("react").ForwardRefExoticComponent<Partial<Record<OwpScrollbarHandlerName, OwpScrollbarEventCallback>> & {

package/dist/types/components/OwpSearchFilter/OwpSearchFilter.d.ts

@@ -8,13 +8,13 @@ interface OwpSearchFilterProps {
     skeleton?: boolean;
 }
 /**
- * OwpSearchFilter 컴포넌트
- * @param title 제목
- * @param children 하위 콘텐츠
- * @param actions 액션 영역
- * @param onSubmit 제출 핸들러
- * @param onReset 초기화 핸들러
- * @param skeleton 스켈레톤 모드 여부
+ * search field와 조회/초기화 action을 한 줄 form으로 구성
+ * @param title form 왼쪽 title 영역
+ * @param children 검색 field 콘텐츠
+ * @param actions 기본 조회/초기화 버튼 뒤에 붙일 action 영역
+ * @param onSubmit 조회 버튼 또는 form submit callback
+ * @param onReset 초기화 버튼 또는 form reset callback
+ * @param skeleton field 배치만 보여주는 skeleton 모드 여부
  */
 declare const OwpSearchFilter: ({ title, children, actions, onSubmit, onReset, skeleton, }: OwpSearchFilterProps) => import("react/jsx-runtime").JSX.Element;
 export { OwpSearchFilter };

package/dist/types/components/OwpSection/OwpSection.d.ts

@@ -17,19 +17,19 @@ interface OwpSectionProps {
     showDivider?: boolean;
 }
 /**
- * OwpSection 컴포넌트
- * @param className CSS 클래스명
- * @param title 제목
- * @param disableTitleIcon disableTitleIcon 값
- * @param headerProps headerProps props
- * @param titleContainerClassName 제목 영역 CSS 클래스명
- * @param titleIconClassName 제목 아이콘 CSS 클래스명
- * @param titleTextClassName 제목 텍스트 CSS 클래스명
- * @param leftSlot leftSlot 값
- * @param centerSlot centerSlot 값
- * @param actions 액션 영역
- * @param loading 로딩 상태
- * @param showDivider 구분선 표시 여부
+ * title, slot, action, divider를 갖는 page section header/body 구성
+ * @param className root className
+ * @param title section title 영역
+ * @param disableTitleIcon 기본 title icon 숨김 여부
+ * @param headerProps header container HTML 속성
+ * @param titleContainerClassName title container className
+ * @param titleIconClassName title icon className
+ * @param titleTextClassName title text className
+ * @param leftSlot title 오른쪽의 왼쪽 slot 영역
+ * @param centerSlot header 중앙 slot 영역
+ * @param actions header 오른쪽 action 영역
+ * @param loading header loading 표시 여부
+ * @param showDivider header/body 구분선 표시 여부
  */
 declare const OwpSection: ({ className, title, disableTitleIcon, headerProps, titleContainerClassName, titleIconClassName, titleTextClassName, actions, leftSlot, centerSlot, children, iconSize, loading, showDivider, }: OwpSectionProps) => import("react/jsx-runtime").JSX.Element;
 export { OwpSection };

package/dist/types/components/OwpSelectorBase/OwpSelectorAutocomplete.d.ts

@@ -4,8 +4,8 @@ interface OwpSelectorAutocompleteProps {
     props: OwpSelectorBaseProps;
 }
 /**
- * Autocomplete 기반 공통 선택기
- * @param props Autocomplete 렌더링 props
+ * Autocomplete UI로 `OwpSelectorBase` state를 render하는 selector
+ * @param props base selector 설정과 계산된 hook result
  */
 export declare const OwpSelectorAutocomplete: ({ hookResult, props }: OwpSelectorAutocompleteProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/OwpSelectorBase/OwpSelectorBase.d.ts

@@ -1,6 +1,6 @@
 import type { OwpSelectorBaseProps } from './types';
 /**
- * 공통 선택기 베이스
- * @param props 공통 선택기 props
+ * Select/Autocomplete 렌더러를 선택하고 공통 selection 상태를 연결하는 base selector
+ * @param props selector mode, option 목록, value/defaultValue, change handler, 표시 옵션
  */
 export declare const OwpSelectorBase: (props: OwpSelectorBaseProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/OwpSelectorBase/OwpSelectorSelect.d.ts

@@ -4,8 +4,8 @@ interface OwpSelectorSelectProps {
     props: OwpSelectorBaseProps;
 }
 /**
- * Select 기반 공통 선택기
- * @param props Select 렌더링 props
+ * MUI Select UI로 `OwpSelectorBase` state를 render하는 selector
+ * @param props base selector 설정과 계산된 hook result
  */
 export declare const OwpSelectorSelect: ({ hookResult, props }: OwpSelectorSelectProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/components/OwpSelectorBase/hooks/useOwpSelectorBase.d.ts

@@ -1,6 +1,6 @@
 import { type OwpSelectorBaseHookResult, type OwpSelectorBaseProps } from '../types';
 /**
- * 공통 선택기 상태 훅
- * @param props 공통 선택기 props
+ * 전체 선택, controlled/uncontrolled value, option merge를 관리하는 selector state Hook
+ * @param props option 목록, value/defaultValue, multiple/all option 설정, change handler
  */
 export declare const useOwpSelectorBase: ({ allOptions, allValueMode, defaultValue, multiple, name, onChange, options, showAllOption, value, }: OwpSelectorBaseProps) => OwpSelectorBaseHookResult;

package/dist/types/components/OwpSelectorBase/selectorBaseStyles.d.ts

@@ -1,6 +1,8 @@
+/** 전체 옵션 row label에 적용하는 강조 sx */
 export declare const SELECTOR_ALL_OPTION_LABEL_SX: {
     readonly fontWeight: 600;
 };
+/** 선택 값 영역에서 전체 옵션 label을 구분하는 sx */
 export declare const SELECTOR_ALL_VALUE_LABEL_SX: {
     readonly color: "text.primary";
     readonly mr: 0.5;

package/dist/types/components/OwpSelectorBase/types/types.d.ts

@@ -1,64 +1,117 @@
 import type { ReactNode } from 'react';
 import type { SelectProps, TextFieldProps } from '@mui/material';
+/** SelectorBase render mode */
 export type OwpSelectorType = 'select' | 'autocomplete';
+/** 전체 선택 값을 빈 문자열로 둘지, 개별 값을 join한 문자열로 둘지 결정 */
 export type OwpSelectorAllValueMode = 'empty' | 'joined';
+/** option이 비어 있을 때 전체 선택 상태를 어떻게 해석할지 결정 */
 export type OwpSelectorEmptyValueMode = 'all' | 'none';
+/** 단일 선택 표시 값의 text align */
 export type OwpSelectorValueTextAlign = 'left' | 'center' | 'right';
+/** SelectorBase option 항목 */
 export interface OwpSelectorBaseOption<T = unknown> {
+    /** form value로 전달되는 option 값 */
     value: string;
+    /** 사용자에게 표시되는 option label */
     label: ReactNode;
+    /** 원본 option 데이터 */
     raw?: T;
+    /** 선택 불가 여부 */
     disabled?: boolean;
 }
+/** native change event와 동일한 target shape을 제공하는 selector 변경 event */
 export interface OwpSelectorBaseChangeEvent {
+    /** form field name/value */
     target: {
+        /** selector name */
         name: string;
+        /** 선택 결과 value */
         value: string;
     };
 }
+/** Select와 Autocomplete 구현이 공유하는 selector 속성 */
 export interface OwpSelectorBaseProps {
+    /** 화면에 표시할 option 목록 */
     options: OwpSelectorBaseOption[];
+    /** 전체 선택 값 계산에 사용할 원본 option 목록 */
     allOptions?: OwpSelectorBaseOption[];
+    /** select 또는 autocomplete render mode */
     selectorType?: OwpSelectorType;
+    /** 전체 선택 시 value serialization 방식 */
     allValueMode?: OwpSelectorAllValueMode;
+    /** uncontrolled 초기 선택 값 */
     defaultValue?: string;
+    /** 전체 option 노출 여부 */
     showAllOption?: boolean;
+    /** selector 비활성화 여부 */
     disabled?: boolean;
+    /** Autocomplete client-side filtering 비활성화 여부 */
     disableClientFilter?: boolean;
+    /** error 상태 표시 여부 */
     error?: boolean;
+    /** full width 적용 여부 */
     fullWidth?: boolean;
+    /** helper text 영역 콘텐츠 */
     helperText?: ReactNode;
+    /** field label */
     label?: ReactNode;
+    /** loading 상태 표시 여부 */
     loading?: boolean;
+    /** loading 상태에서 표시할 문구 */
     loadingText?: ReactNode;
+    /** 다중 선택 여부 */
     multiple?: boolean;
+    /** change event target name */
     name?: string;
+    /** option이 없을 때 표시할 문구 */
     noOptionsText?: ReactNode;
+    /** 선택 값 변경 callback */
     onChange?: (event: OwpSelectorBaseChangeEvent) => void;
+    /** 입력 placeholder */
     placeholder?: string;
+    /** required 상태 표시 여부 */
     required?: boolean;
+    /** controlled 선택 값 */
     value?: string;
     /** 단일 선택 값 텍스트 정렬 */
     valueTextAlign?: OwpSelectorValueTextAlign;
+    /** root className */
     className?: string;
+    /** 내부 TextField로 전달할 부가 속성 */
     textFieldProps?: Omit<TextFieldProps, 'defaultValue' | 'error' | 'fullWidth' | 'helperText' | 'label' | 'onChange' | 'required' | 'value'>;
+    /** select 구현에서 내부 MUI Select로 전달할 부가 속성 */
     selectProps?: Omit<SelectProps<string>, 'defaultValue' | 'displayEmpty' | 'error' | 'fullWidth' | 'label' | 'multiple' | 'onChange' | 'required' | 'value'>;
+    /** Autocomplete controlled input value */
     autocompleteInputValue?: string;
-    /** 단일 Autocomplete 대용량 가상화 기준 옵션 수, false 비활성화 */
+    /** 단일 Autocomplete virtualization 적용 기준 option 수, false 비활성화 */
     autocompleteVirtualizationThreshold?: number | false;
+    /** Autocomplete input value 변경 callback */
     onAutocompleteInputChange?: (nextInputValue: string, reason: string) => void;
 }
+/** SelectorBase hook이 계산한 선택 상태와 selection helper 집합 */
 export interface OwpSelectorBaseHookResult {
+    /** 전체 option 표시 항목 */
     allOption: OwpSelectorBaseOption<null>;
+    /** 전체 선택을 표현하는 serialized value */
     allValue: string;
+    /** 현재 선택이 전체 선택으로 해석되는지 여부 */
     isAllSelected: boolean;
+    /** 전체 option 포함 여부가 반영된 최종 option 목록 */
     resolvedOptions: OwpSelectorBaseOption[];
+    /** 단일 선택에서 선택된 option */
     selectedOption: OwpSelectorBaseOption | null;
+    /** 다중 선택에서 선택된 option 목록 */
     selectedOptions: OwpSelectorBaseOption[];
+    /** serialized value를 분해한 선택 value 목록 */
     selectedValueList: string[];
+    /** 선택 값 초기화 */
     clearSelection: () => void;
+    /** 전체 선택 상태 복원 */
     restoreAllSelection: () => void;
+    /** 전체 option 선택 */
     selectAll: () => void;
+    /** 다중 선택 value 목록 적용 */
     selectMultipleValues: (nextSelectedValueList: string[]) => void;
+    /** 단일 선택 value 적용 */
     selectSingleValue: (nextValue: string) => void;
 }

package/dist/types/components/OwpSelectorBase/utils/querySelectorUtils.d.ts

@@ -1,6 +1,6 @@
 import type { OwpSelectorBaseChangeEvent, OwpSelectorBaseOption } from '../types';
 /**
- * 전체 선택 토큰 반환
+ * 전체 선택 token 반환
  */
 export declare const getSelectorAllToken: () => string;
 /**
@@ -14,7 +14,7 @@ export declare const splitSelectorValue: (value?: string) => string[];
  */
 export declare const joinSelectorValue: (valueList: string[]) => string;
 /**
- * 선택 변경 이벤트 생성
+ * 선택 변경 event 생성
  * @param name 필드 이름
  * @param value 선택 값
  */

package/dist/types/components/OwpSnackbarContent/OwpSnackbarContent.d.ts

@@ -1,2 +1,3 @@
 import { type CustomContentProps } from 'notistack';
+/** notistack custom snackbar content memoized component */
 export declare const OwpSnackbarContent: import("react").NamedExoticComponent<CustomContentProps & import("react").RefAttributes<HTMLDivElement>>;