@zuoyo/viteui 0.0.2

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

@@ -0,0 +1,823 @@
+/**
+ * GridBase 组件类型定义
+ */
+import type { ComponentPublicInstance, CSSProperties } from 'vue';
+import type { ListBaseProps } from '../base/types';
+/**
+ * GridColumn Props 接口
+ */
+export interface GridColumnProps {
+    /**
+     * 字段名
+     */
+    field?: string;
+    /**
+     * 标题
+     */
+    title?: string;
+    /**
+     * 宽度
+     */
+    width?: number | string;
+    /**
+     * 行跨度
+     * @default 1
+     */
+    rowspan?: number | string;
+    /**
+     * 列跨度
+     * @default 1
+     */
+    colspan?: number | string;
+    /**
+     * 是否隐藏
+     * @default false
+     */
+    hidden?: boolean;
+    /**
+     * 是否可排序
+     * @default false
+     */
+    sortable?: boolean;
+    /**
+     * 是否可编辑
+     * @default false
+     */
+    editable?: boolean;
+    /**
+     * 编辑规则
+     */
+    editRules?: any[] | Record<string, any> | string;
+    /**
+     * 编辑消息
+     */
+    editMessages?: Record<string, any>;
+    /**
+     * 排序顺序
+     * @default 'asc'
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * 是否冻结
+     * @default false
+     */
+    frozen?: boolean;
+    /**
+     * 对齐方式
+     */
+    align?: 'left' | 'right' | 'center';
+    /**
+     * 标题对齐方式
+     */
+    halign?: 'left' | 'right' | 'center';
+    /**
+     * 排序函数
+     */
+    sorter?: (a: any, b: any) => number;
+    /**
+     * 标题类名
+     */
+    headerCls?: string;
+    /**
+     * 标题样式
+     */
+    headerStyle?: CSSProperties;
+    /**
+     * 单元格 CSS
+     */
+    cellCss?: string | Record<string, any> | ((row: any, value: any) => string | Record<string, any>);
+    /**
+     * 是否展开器
+     * @default false
+     */
+    expander?: boolean;
+    /**
+     * 是否可过滤
+     * @default true
+     */
+    filterable?: boolean;
+    /**
+     * 过滤操作符
+     * @default []
+     */
+    filterOperators?: string[];
+}
+/**
+ * GridColumn 组件实例接口
+ */
+export interface GridColumnInstance extends ComponentPublicInstance {
+    /**
+     * 网格实例
+     */
+    grid: any;
+    /**
+     * 宽度状态
+     */
+    widthState: string | null;
+    /**
+     * 冻结状态
+     */
+    frozenState: boolean;
+    /**
+     * 当前排序顺序
+     */
+    currOrder: 'asc' | 'desc' | null;
+    /**
+     * 过滤操作符
+     */
+    filterOperator: string;
+    /**
+     * 过滤值
+     */
+    filterValue: any;
+    /**
+     * 是否过滤中
+     */
+    isFiltering: boolean;
+    /**
+     * 执行过滤
+     */
+    doFilter(): void;
+}
+/**
+ * GridColumnGroup Props 接口
+ */
+export interface GridColumnGroupProps {
+    /**
+     * 是否冻结
+     * @default false
+     */
+    frozen?: boolean;
+    /**
+     * 对齐方式
+     * @default 'left'
+     */
+    align?: 'left' | 'right' | 'center';
+    /**
+     * 宽度
+     */
+    width?: number | string;
+}
+/**
+ * GridColumnGroup 组件实例接口
+ */
+export interface GridColumnGroupInstance extends ComponentPublicInstance {
+    /**
+     * 宽度状态
+     */
+    widthState: string | null;
+    /**
+     * 行数组
+     */
+    rows: any[];
+    /**
+     * 添加行
+     */
+    addRow(row: any): void;
+    /**
+     * 移除行
+     */
+    removeRow(row: any): void;
+}
+/**
+ * GridHeaderRow 组件实例接口
+ */
+export interface GridHeaderRowInstance extends ComponentPublicInstance {
+    /**
+     * 列数组
+     */
+    columns: any[];
+    /**
+     * 定时器
+     */
+    timer: ReturnType<typeof setTimeout> | null;
+    /**
+     * 添加列
+     */
+    addColumn(column: any): void;
+    /**
+     * 移除列
+     */
+    removeColumn(column: any): void;
+}
+/**
+ * GridEmpty Props 接口
+ */
+export interface GridEmptyProps {
+    /**
+     * 网格实例
+     */
+    grid?: any;
+}
+/**
+ * GridFilterButton Props 接口
+ */
+export interface GridFilterButtonProps {
+    /**
+     * 箭头图标类名
+     * @default 'icon-filter'
+     */
+    arrowIconCls?: string;
+    /**
+     * 面板样式
+     */
+    panelStyle?: CSSProperties;
+    /**
+     * 输入框样式
+     */
+    inputStyle?: CSSProperties;
+    /**
+     * 是否可编辑
+     * @default false
+     */
+    editable?: boolean;
+    /**
+     * 列实例
+     */
+    column?: any;
+    /**
+     * 值
+     */
+    value?: string | null;
+}
+/**
+ * GridFilterCell Props 接口
+ */
+export interface GridFilterCellProps {
+    /**
+     * 列实例
+     */
+    column?: any;
+    /**
+     * 网格实例
+     */
+    grid?: any;
+}
+/**
+ * GridHeaderCell Props 接口
+ */
+export interface GridHeaderCellProps {
+    /**
+     * 列实例
+     */
+    column?: any;
+}
+/**
+ * GridFooterCell Props 接口
+ */
+export interface GridFooterCellProps {
+    /**
+     * 行数据
+     */
+    row?: any;
+    /**
+     * 列实例
+     */
+    column?: any;
+    /**
+     * 行索引
+     */
+    rowIndex?: number;
+}
+/**
+ * GridFilterRow Props 接口
+ */
+export interface GridFilterRowProps {
+    /**
+     * 列数组
+     */
+    columns?: any[];
+    /**
+     * 网格实例
+     */
+    grid?: any;
+}
+/**
+ * GridBodyCell Props 接口
+ */
+export interface GridBodyCellProps {
+    /**
+     * 行数据
+     */
+    row?: any;
+    /**
+     * 列实例
+     */
+    column?: any;
+    /**
+     * 行索引
+     */
+    rowIndex?: number;
+}
+/**
+ * GridFooter Props 接口
+ */
+export interface GridFooterProps {
+    /**
+     * 列数组
+     * @default []
+     */
+    columns?: any[];
+    /**
+     * 行数组
+     * @default []
+     */
+    rows?: any[];
+    /**
+     * 填充宽度
+     * @default 0
+     */
+    paddingWidth?: number;
+}
+/**
+ * GridFooter 组件实例接口
+ */
+export interface GridFooterInstance extends ComponentPublicInstance {
+    /**
+     * 滚动左边距状态
+     */
+    scrollLeftState: number;
+    /**
+     * 滚动左边距
+     */
+    scrollLeft(value?: number): number | void;
+}
+/**
+ * GridHeader Props 接口
+ */
+export interface GridHeaderProps {
+    /**
+     * 列数组
+     * @default []
+     */
+    columns?: any[];
+    /**
+     * 列组
+     */
+    columnGroup?: any;
+    /**
+     * 填充宽度
+     * @default 0
+     */
+    paddingWidth?: number;
+    /**
+     * 是否可过滤
+     * @default false
+     */
+    filterable?: boolean;
+    /**
+     * 网格实例
+     */
+    grid?: any;
+}
+/**
+ * GridHeader 组件实例接口
+ */
+export interface GridHeaderInstance extends ComponentPublicInstance {
+    /**
+     * 高度状态
+     */
+    heightState: number;
+    /**
+     * 滚动左边距状态
+     */
+    scrollLeftState: number;
+    /**
+     * 悬停列
+     */
+    hoverColumn: any | null;
+    /**
+     * 拖拽作用域
+     */
+    dragScope: Record<string, any>;
+    /**
+     * 过滤在顶部
+     */
+    filterOnTop: boolean;
+    /**
+     * 过滤在底部
+     */
+    filterOnBottom: boolean;
+    /**
+     * 高度
+     */
+    height(value?: number): number | void;
+    /**
+     * 滚动左边距
+     */
+    scrollLeft(value?: number): number | void;
+    /**
+     * 单元格点击事件
+     */
+    onCellClick(event: Event, col: any): void;
+    /**
+     * 获取可调整大小选项
+     */
+    getResizableOpts(col: any): any;
+    /**
+     * 获取可拖拽选项
+     */
+    getDraggableOpts(col: any): any;
+    /**
+     * 获取可放置选项
+     */
+    getDroppableOpts(col: any): any;
+    /**
+     * 列调整大小中
+     */
+    onColumnResizing(col: any, event: any): void;
+    /**
+     * 列调整大小停止
+     */
+    onColumnResizeStop(col: any, event: any): void;
+    /**
+     * 列拖拽开始
+     */
+    onColumnDragStart(col: any, event: any): void;
+    /**
+     * 列拖拽悬停
+     */
+    onColumnDragOver(col: any, scope: any): void;
+    /**
+     * 列拖拽离开
+     */
+    onColumnDragLeave(): void;
+    /**
+     * 列拖拽放置
+     */
+    onColumnDrop(col: any, scope: any): void;
+    /**
+     * 渲染组单元格
+     */
+    renderGroupCells(): any;
+    /**
+     * 渲染行单元格
+     */
+    renderRowCells(): any;
+}
+/**
+ * GridBody Props 接口
+ */
+export interface GridBodyProps {
+    /**
+     * 列数组
+     * @default []
+     */
+    columns?: any[];
+    /**
+     * 行数组
+     * @default []
+     */
+    rows?: any[];
+    /**
+     * 对齐方式
+     */
+    align?: 'left' | 'right' | 'center';
+}
+/**
+ * GridBody 组件实例接口
+ */
+export interface GridBodyInstance extends ComponentPublicInstance {
+    /**
+     * 滚动顶部状态
+     */
+    scrollTopState: number;
+    /**
+     * 滚动事件
+     */
+    onScroll(): void;
+    /**
+     * 滚动顶部
+     */
+    scrollTop(value?: number): number | void;
+    /**
+     * 滚动条宽度
+     */
+    scrollbarWidth(): number;
+}
+/**
+ * GridView Props 接口
+ */
+export interface GridViewProps {
+    /**
+     * 列数组
+     * @default []
+     */
+    columns?: any[];
+    /**
+     * 列组
+     */
+    columnGroup?: any;
+    /**
+     * 视图索引
+     * @default 2
+     */
+    viewIndex?: number;
+    /**
+     * 行数组
+     * @default []
+     */
+    rows?: any[];
+    /**
+     * 页脚行数组
+     * @default []
+     */
+    footerRows?: any[];
+    /**
+     * 是否可过滤
+     * @default false
+     */
+    filterable?: boolean;
+}
+/**
+ * GridView 组件实例接口
+ */
+export interface GridViewInstance extends ComponentPublicInstance {
+    /**
+     * 标题填充宽度
+     */
+    headerPaddingWidth: number;
+    /**
+     * 视图类名
+     */
+    viewCls: string;
+    /**
+     * 滚动顶部
+     */
+    scrollTop(value?: number): number | void;
+    /**
+     * 标题高度
+     */
+    headerHeight(value?: number): number | void;
+    /**
+     * 获取标题填充宽度
+     */
+    getHeaderPaddingWidth(): number | null;
+    /**
+     * 主体滚动事件
+     */
+    onBodyScroll(event: any): void;
+    /**
+     * 调整大小事件
+     */
+    onResize(): void;
+}
+/**
+ * 排序接口
+ */
+export interface SortItem {
+    /**
+     * 字段名
+     */
+    field: string;
+    /**
+     * 排序顺序
+     */
+    order: 'asc' | 'desc';
+}
+/**
+ * 单元格跨度接口
+ */
+export interface CellSpan {
+    /**
+     * 行跨度
+     */
+    rowspan: number;
+    /**
+     * 列跨度
+     */
+    colspan: number;
+}
+/**
+ * GridBase Props 接口
+ */
+export interface GridBaseProps extends ListBaseProps {
+    /**
+     * 行高
+     * @default 32
+     */
+    rowHeight?: number;
+    /**
+     * 是否条纹
+     * @default false
+     */
+    striped?: boolean;
+    /**
+     * 行 CSS
+     */
+    rowCss?: Record<string, any> | ((row: any, index: number) => Record<string, any>);
+    /**
+     * 冻结宽度
+     * @default '200px'
+     */
+    frozenWidth?: number | string;
+    /**
+     * 冻结对齐方式
+     * @default 'left'
+     */
+    frozenAlign?: 'left' | 'right';
+    /**
+     * 排序
+     * @default []
+     */
+    sorts?: SortItem | SortItem[];
+    /**
+     * 是否多排序
+     * @default false
+     */
+    multiSort?: boolean;
+    /**
+     * 是否显示标题
+     * @default true
+     */
+    showHeader?: boolean;
+    /**
+     * 是否显示页脚
+     * @default false
+     */
+    showFooter?: boolean;
+    /**
+     * 编辑模式
+     */
+    editMode?: 'row' | 'cell';
+    /**
+     * 提示选项
+     */
+    tipOptions?: Record<string, any>;
+    /**
+     * 点击编辑
+     * @default false
+     */
+    clickToEdit?: boolean;
+    /**
+     * 双击编辑
+     * @default false
+     */
+    dblclickToEdit?: boolean;
+    /**
+     * 页脚数据
+     * @default []
+     */
+    footerData?: any[];
+    /**
+     * 过滤规则
+     * @default []
+     */
+    filterRules?: any[];
+    /**
+     * 列调整大小
+     * @default false
+     */
+    columnResizing?: boolean;
+    /**
+     * 列移动
+     * @default false
+     */
+    columnMoving?: boolean;
+    /**
+     * 单元格跨度函数
+     */
+    cellSpan?: (row: any, column: any) => CellSpan;
+}
+/**
+ * GridBase 组件实例接口
+ */
+export interface GridBaseInstance extends ComponentPublicInstance {
+    /**
+     * 左侧组
+     */
+    leftGroup: any | null;
+    /**
+     * 右侧组
+     */
+    rightGroup: any | null;
+    /**
+     * 中间组
+     */
+    centerGroup: any | null;
+    /**
+     * 左侧列
+     */
+    leftColumns: any[];
+    /**
+     * 右侧列
+     */
+    rightColumns: any[];
+    /**
+     * 中间列
+     */
+    centerColumns: any[];
+    /**
+     * 列引用
+     */
+    columnRefs: any[];
+    /**
+     * 组引用
+     */
+    groupRefs: any[];
+    /**
+     * 排序状态
+     */
+    sortsState: SortItem[];
+    /**
+     * 编辑项
+     */
+    editingItem: any | null;
+    /**
+     * 标题高度
+     */
+    headerHeight: number;
+    /**
+     * 分割样式
+     */
+    splitStyle: CSSProperties | null;
+    /**
+     * 所有列
+     */
+    allColumns: any[];
+    /**
+     * 页脚行
+     */
+    footerRows: any[];
+    /**
+     * 左侧冻结宽度
+     */
+    leftFrozenWidth: number | string;
+    /**
+     * 右侧冻结宽度
+     */
+    rightFrozenWidth: number | string;
+    /**
+     * 添加列
+     */
+    addColumn(column: any): void;
+    /**
+     * 移除列
+     */
+    removeColumn(column: any): void;
+    /**
+     * 添加列组
+     */
+    addColumnGroup(group: any): void;
+    /**
+     * 移除列组
+     */
+    removeColumnGroup(group: any): void;
+    /**
+     * 查找列
+     */
+    findColumn(field: string): any | null;
+    /**
+     * 调整列大小
+     */
+    resizeColumn(field: string, width: number): void;
+    /**
+     * 移动列
+     */
+    moveColumn(fromField: string, toField: string, point: 'before' | 'after'): void;
+    /**
+     * 添加排序
+     */
+    addSort(col: any): void;
+    /**
+     * 添加过滤规则
+     */
+    addFilterRule(rule: any): void;
+    /**
+     * 主体滚动
+     */
+    onBodyScroll(event: any): void;
+    /**
+     * 开始编辑
+     */
+    beginEdit(row: any, column?: any, rowEl?: HTMLElement | null): void;
+    /**
+     * 结束编辑
+     */
+    endEdit(): void;
+    /**
+     * 取消编辑
+     */
+    cancelEdit(): void;
+    /**
+     * 是否编辑中
+     */
+    isEditing(row: any, column?: any): boolean;
+    /**
+     * 导航行
+     */
+    navRow(step: number): void;
+    /**
+     * 初始化列
+     */
+    initColumns(): void;
+    /**
+     * 初始化标题高度
+     */
+    initHeaderHeight(): void;
+    /**
+     * 初始化过滤规则
+     */
+    initFilterRules(): void;
+}
+//# sourceMappingURL=types.d.ts.map