Public interfaces & types

BGrid 컴포넌트에 전달하는 최상위 props입니다.

export interface BGridProps<T>

한 개 데이터 컬럼의 키, 제목, 너비, 렌더링 및 편집 동작을 정의합니다.

export interface BGridColumn<T>

원본 행 값과 그리드 상태를 함께 전달하는 행 래퍼 타입입니다.

export type BGridDataItem<T> = {
  values: T;
  status?: BGridDataItemStatus;
  /** Column instances directly edited since the data owner last cleared the edit state. */
  editedColumnIds?: string[];
  /** Stable key tokens whose underlying values changed since the data owner last cleared the change state. */
  changedKeys?: string[];
  checked?: boolean;
  parentItemIndex?: number;
  meta?: Record<string, any>;
};

셀 또는 헤더 콘텐츠의 가로 정렬 방향입니다.

export type AlignDirection = 'left' | 'center' | 'right';

getClipboardText에서 복사 문자열을 만들 때 사용하는 셀 컨텍스트입니다.

export interface BGridCellClipboardTextParams<T>

최상위 columns prop에서 width를 생략할 수 있게 만든 컬럼 입력 타입입니다.

export type BGridColumnWithOptionalWidth<T> = Partial<Pick<BGridColumn<T>, 'width'>> & Omit<BGridColumn<T>, 'width'>;

행의 신규·수정·삭제 상태를 나타냅니다.

export enum BGridDataItemStatus

컬럼 itemRender에 전달되는 셀 렌더링 컨텍스트입니다.

export interface BGridItemRenderProps<T>

편집 중 다음 셀로 이동할 방향입니다.

export type MoveDirection = 'prev' | 'next' | 'current';

컬럼 너비나 순서 변경 뒤 전달되는 컬럼 상태입니다.

export interface BGridChangeColumnsInfo<T>

onChangeData에 전달되는 실제 변경 목록과 병합 트랜잭션 범위입니다.

export interface BGridChangeDataMeta<T>

셀 클릭 콜백에 전달되는 행과 컬럼 정보입니다.

export interface BGridClickParams<T>

페이지 번호, 크기, 전체 개수와 페이지 변경 콜백을 정의합니다.

export interface BGridPage

정렬·필터 처리 후 원본 인덱스를 보존하는 처리 행입니다.

export interface BGridProcessedRow<T>

체크박스 또는 라디오 방식의 행 선택 상태와 변경 콜백입니다.

export interface BGridRowChecked<T>

전체 선택 상태를 선택·해제·부분 선택으로 표현합니다.

export type CheckedAll = true | false | 'indeterminate';

컬럼별 필터 형식, 값 추출 및 사용자 조건식을 정의합니다.

export interface BGridColumnFilterConfig<T>

본문 셀 메뉴의 실행 항목 또는 구분선을 정의합니다.

export type BGridContextMenuItem<T> =
  | {
      type?: 'item';
      id: string;
      label: React.ReactNode;
      icon?: React.ReactNode;
      shortcut?: string;
      disabled?: boolean;
      onSelect: (target: BGridContextMenuTarget<T>) => void | Promise<void>;
    }
  | {
      type: 'separator';
      id: string;
    };

본문 셀에서 확장 가능한 컨텍스트 메뉴 항목을 구성합니다.

export interface BGridContextMenuOptions<T>

본문 셀 컨텍스트 메뉴에 전달되는 표시·원본 행과 셀 문맥입니다.

export interface BGridContextMenuTarget<T>

클라이언트 처리 또는 수동 서버 처리 방식의 데이터 쿼리를 제어합니다.

export interface BGridDataControl

현재 적용된 정렬 및 필터 조건 전체입니다.

export interface BGridDataQuery

데이터 쿼리가 변경된 원인과 대상 컬럼을 설명합니다.

export interface BGridDataQueryChangeEvent

텍스트 및 숫자 필터에서 지원하는 비교 연산자입니다.

export type BGridFilterOperator = 'contains' | 'equals' | 'notEquals' | 'gt' | 'gte' | 'lt' | 'lte' | 'between';

값·텍스트·숫자 필터 조건의 판별 유니온입니다.

export type BGridFilterParam =
  | (BGridFilterParamBase & {
      type: 'values';
      values: BGridFilterValue[];
    })
  | (BGridFilterParamBase & {
      type: 'text';
      operator: 'contains' | 'equals' | 'notEquals';
      value: string;
    })
  | (BGridFilterParamBase & {
      type: 'number';
      operator: Exclude<BGridFilterOperator, 'contains'>;
      value?: number;
      min?: number;
      max?: number;
    });

값 목록 필터에서 사용할 수 있는 원시 값입니다.

export type BGridFilterValue = string | number | boolean | null;

검색 문자열 getter에 전달되는 표시·원본 행과 셀 문맥입니다.

export interface BGridSearchCellParams<T>

검색 입력과 이전·다음·닫기 버튼의 아이콘 슬롯입니다.

export interface BGridSearchIcons

검색 UI의 접근 가능한 이름, 상태 문구와 결과 수 형식을 설정합니다.

export interface BGridSearchLabels

검색 UI 열림 상태가 변경된 사용자 또는 surface 원인입니다.

export type BGridSearchOpenReason =
  | 'shortcut'
  | 'contextMenu'
  | 'external'
  | 'escape'
  | 'closeButton'
  | 'surfaceConflict';

현재 로드된 Grid 데이터의 셀 검색과 제어형 UI 상태를 설정합니다.

export interface BGridSearchOptions<T>

제어형 정렬 상태와 변경 콜백입니다.

export interface BGridSortInfo

한 컬럼의 정렬 키와 방향입니다.

export interface BGridSortParam

컬럼별 정렬·필터 툴박스 기능과 사용자 UI를 설정합니다.

export interface BGridToolboxConfig<T>

정렬·필터 툴박스의 아이콘을 교체하는 슬롯입니다.

export interface BGridToolboxIcons

컬럼 툴박스에 추가할 사용자 작업 항목입니다.

export interface BGridToolboxItem<T>

사용자 정의 컬럼 툴박스 렌더러에 전달되는 컨텍스트입니다.

export interface BGridToolboxRenderProps<T>

활성 셀의 절대 행·컬럼 인덱스를 나타냅니다.

export interface BGridCellAddress

변경 목록을 저장하거나 현재 편집 상호작용을 취소합니다.

export interface BGridCellCommitController<T>

내장 text 또는 plugin 편집기를 구분하는 컬럼 editor 설정입니다.

export type BGridCellEditorConfig<T> = BGridTextEditorConfig<T> | BGridPluginEditorConfig<T>;

현재 편집 셀과 시작 모드, 원래 값을 나타내는 편집 세션입니다.

export interface BGridCellEditSession extends BGridCellInteractionSessionBase

활성 셀을 이동할 키보드 방향과 경계 이동 종류입니다.

export type BGridCellMoveDirection =
  | 'up'
  | 'down'
  | 'left'
  | 'right'
  | 'home'
  | 'end'
  | 'pageUp'
  | 'pageDown'
  | 'first'
  | 'last'
  | 'next'
  | 'prev';

활성 셀의 제어 상태와 키보드 이동·편집·클릭 활성화 정책을 설정합니다.

export interface BGridCellNavigationOptions

셀 복사 제한 또는 Clipboard API 오류 정보입니다.

export interface BGridCellSelectionCopyError

셀 복사가 실패한 원인을 구분하는 문자열 유니온입니다.

export type BGridCellSelectionCopyErrorReason = 'maxClipboardCells' | 'maxClipboardTextLength' | 'clipboardWriteFailed';

셀 선택 영역의 시작과 끝 행·컬럼 인덱스입니다.

export interface BGridCellSelectionRange

key 또는 columnId로 지정하는 한 컬럼의 변경 제안입니다.

export type BGridCellValueChange<T> =
  | {
      key: BGridColumn<T>['key'];
      columnId?: never;
      value: unknown;
    }
  | {
      columnId: string;
      key?: never;
      value: unknown;
    };

컬럼 onChangeValue에 전달되는 변경 제안, 행 범위 및 최종 commit controller입니다.

export interface BGridChangeValueParams<T> extends BGridCellCommitController<T>

병합 셀 전파 대상 행과 변경 전후 값의 immutable preview입니다.

export interface BGridChangeValueRow<T>

commit 완료 뒤 활성 셀 이동을 설정합니다.

export interface BGridCommitOptions

아이콘 편집 세션을 실행하고 선택적으로 cleanup을 반환하는 callback입니다.

export type BGridEditorIconClickHandler<T> = (
  params: BGridEditorIconClickParams<T>,
) => void | (() => void) | Promise<void | (() => void)>;

editorIcon callback에 전달되는 셀 문맥과 commit controller입니다.

export interface BGridEditorIconClickParams<T> extends BGridEditorIconParams<T>, BGridCellCommitController<T>

셀 값 옆 편집 아이콘의 모양, 표시 조건과 callback을 설정합니다.

export interface BGridEditorIconConfig<T>

editorIcon 렌더링에 전달되는 canonical 셀 문맥입니다.

export interface BGridEditorIconParams<T>

에디터 플러그인 component에 전달되는 셀 문맥과 편집 수명주기 함수입니다.

export interface BGridEditorPluginProps<T> extends BGridTextEditorContext<T>

변경 요청을 시작한 text, plugin, itemRender 또는 아이콘 경로입니다.

export type BGridEditSource = 'text' | 'plugin' | 'itemRender' | 'editorIcon';

셀 영역에서 편집을 시작할 클릭 또는 더블클릭 조건입니다.

export type BGridEditTrigger = 'click' | 'dblclick';

내부 셀 이동에서 범위 확장, 경계 이동과 페이지 크기를 설정합니다.

export interface BGridMoveActiveCellOptions

앱 전용 에디터 플러그인의 식별자와 component를 정의합니다.

export interface BGridPluginEditorConfig<T>

내장 text 편집기의 직접 입력, blur와 값 변환 동작을 설정합니다.

export interface BGridTextEditorConfig<T>

text 편집기의 값 변환 함수에 전달되는 셀 컨텍스트입니다.

export interface BGridTextEditorContext<T>

지정 컬럼의 연속된 동일 값을 병합하는 기준입니다.

export interface BGridCellMergeColumn

기존 인덱스 범위 방식의 2단 그룹 헤더를 정의합니다.

export interface BGridColumnGroup

컬럼 ID와 자식 그룹을 재귀적으로 구성하는 임의 깊이 그룹 헤더 노드입니다.

export interface BGridColumnGroupNode

Bottom Bar에 고정된 가로 스크롤바의 표시 여부와 스타일을 설정합니다.

export interface BGridHorizontalScrollbarOptions extends BGridViewStyleProps

페이지네이션 표시 여부와 스타일을 설정합니다.

export interface BGridPaginationViewOptions extends BGridViewStyleProps

가로·세로 스크롤바 동작과 스타일 변형을 함께 설정합니다.

export interface BGridScrollbarOptions

스크롤바 표현 방식을 선택합니다.

export type BGridScrollbarVariant = 'native' | 'classic' | 'modern';

상태 표시줄에 표시할 React 노드 또는 렌더 함수입니다.

export type BGridStatusContent = React.ReactNode | ((context: BGridStatusContext) => React.ReactNode);

상태 표시줄 콘텐츠 함수에 전달되는 데이터 개수 정보입니다.

export interface BGridStatusContext

상태 표시줄의 표시 여부, 콘텐츠 및 스타일을 설정합니다.

export interface BGridStatusOptions extends BGridViewStyleProps

요약 행의 대상 컬럼, 병합 범위 및 렌더러를 정의합니다.

export interface BGridSummaryColumn<T>

요약 셀 렌더러에 전달되는 컬럼과 전체 데이터입니다.

export interface BGridSummaryItemRenderProps<T>

세로 스크롤바의 표시 및 스타일을 설정합니다.

export interface BGridVerticalScrollbarOptions extends BGridViewStyleProps

하위 표시 영역에 className과 인라인 style을 전달합니다.

export interface BGridViewStyleProps

행 드래그 순서 변경의 활성화, 핸들 및 완료 콜백을 정의합니다.

export interface BGridReorderInfo<T>

현재 드래그 중인 행의 출발 및 도착 인덱스입니다.

export interface BGridReorderingInfo

기본 집계 방식 또는 사용자 정의 집계 함수입니다.

export type BGridPivotAggregate<T> =
  | 'sum'
  | 'count'
  | 'avg'
  | 'min'
  | 'max'
  | 'first'
  | ((params: BGridPivotAggregateParams<T>) => any);

사용자 정의 피벗 집계 함수에 전달되는 값과 원본 행입니다.

export interface BGridPivotAggregateParams<T>

피벗 행·컬럼 축에서 사용할 필드를 정의합니다.

export interface BGridPivotField

피벗의 행 축, 컬럼 축, 값 및 빈 값 표시를 설정합니다.

export interface BGridPivotOptions<T>

피벗 값 영역의 집계와 셀 표시 방식을 정의합니다.

export interface BGridPivotValue<T> extends BGridPivotField

피벗 값 셀을 복사할 때 전달되는 전체 컨텍스트입니다.

export interface BGridPivotValueClipboardTextParams<T> extends Omit<BGridCellClipboardTextParams<Record<string, any>>, 'column'>,
    BGridPivotValueContext<T>

피벗 결과 셀의 원본 데이터 및 축 컨텍스트입니다.

export interface BGridPivotValueContext<T>

피벗 값 셀 렌더러에 전달되는 전체 컨텍스트입니다.

export interface BGridPivotValueItemRenderProps<T> extends Omit<BGridItemRenderProps<Record<string, any>>, 'column'>,
    BGridPivotValueContext<T>