balala-revogrid 1.0.0

package/dist/types/global/global.d.ts

@@ -0,0 +1 @@
+export default function (): void;

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './types';
+export * from './store';
+export * from './plugins';
+export * from './components';
+export * from './utils';
+export * from './components/data/cell-renderer';
+export { TextEditor } from './components/editors/text-editor';
+export * from './components/editors/edit.utils';
+export { h, type FunctionalComponent } from './stencil-public-runtime';

package/dist/types/plugins/add-rows-on-paste.plugin.d.ts

@@ -0,0 +1,14 @@
+import type { PluginProviders } from '../types/plugin.types';
+import { BasePlugin } from './base.plugin';
+/**
+ * Automatically adds new rows when pasted data is larger than current rows
+ * @event newRows - is triggered when new rows are added. Data of new rows can be filled with default values. If the event is prevented, no rows will be added
+ */
+export declare class AutoAddRowsPlugin extends BasePlugin {
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders);
+    handleBeforePasteApply(event: CustomEvent<{
+        raw: string;
+        parsed: string[][];
+        event: ClipboardEvent;
+    }>): void;
+}

package/dist/types/plugins/base.plugin.d.ts

@@ -0,0 +1,51 @@
+import { h } from '../stencil-public-runtime';
+import type { PluginProviders, PluginBaseComponent } from '../types';
+export type WatchConfig = {
+    immediate: boolean;
+};
+/**
+ * Base layer for plugins
+ * Provide minimal starting core for plugins to work
+ * Extend this class to create plugin
+ */
+export declare class BasePlugin implements PluginBaseComponent {
+    revogrid: HTMLRevoGridElement;
+    providers: PluginProviders;
+    readonly h: typeof h;
+    readonly subscriptions: Record<string, (...args: any[]) => void>;
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders);
+    /**
+     *
+     * @param eventName - event name to subscribe to in revo-grid component (e.g. 'beforeheaderclick')
+     * @param callback - callback function for event
+     */
+    addEventListener<K extends keyof HTMLRevoGridElementEventMap>(eventName: K, callback: (this: BasePlugin, e: CustomEvent<HTMLRevoGridElementEventMap[K]>) => void): void;
+    /**
+     * Subscribe to property change in revo-grid component
+     * You can return false in callback to prevent default value set
+     *
+     * @param prop - property name
+     * @param callback - callback function
+     * @param immediate - trigger callback immediately with current value
+     */
+    watch<T extends any>(prop: string, callback: (arg: T) => boolean | void, { immediate }?: Partial<WatchConfig>): void;
+    /**
+     * Remove event listener
+     * @param eventName
+     */
+    removeEventListener(eventName: string): void;
+    /**
+     * Emit event from revo-grid component
+     * Event can be cancelled by calling event.preventDefault() in callback
+     */
+    emit<T = any>(eventName: string, detail?: T): CustomEvent<T>;
+    /**
+     * Clear all subscriptions
+     */
+    clearSubscriptions(): void;
+    /**
+     * Destroy plugin and clear all subscriptions
+     */
+    destroy(): void;
+}
+export type GridPlugin = (typeof BasePlugin);

package/dist/types/plugins/column-hide.plugin.d.ts

@@ -0,0 +1,110 @@
+/**
+ * 列隐藏插件
+ * 实现表格列的隐藏、显示、插入、删除功能
+ */
+import { BasePlugin } from './base.plugin';
+import type { PluginProviders, ColumnRegular } from "../types/index";
+export interface ColumnHideConfig {
+    /** 初始隐藏的列 */
+    hiddenColumns?: string | number | (string | number)[];
+    /** 拉伸列的 prop（该列宽度不保留，让 ColumnStretchPlugin 重新计算） */
+    stretchColumn?: string;
+    /** 列隐藏变化回调 */
+    onHiddenChange?: (hiddenProps: string[]) => void;
+    /** 列插入回调 */
+    onColumnInsert?: (column: ColumnRegular, index: number) => void;
+    /** 列删除回调 */
+    onColumnRemove?: (column: ColumnRegular, index: number) => void;
+}
+export declare class ColumnHidePlugin extends BasePlugin {
+    private config;
+    private hiddenProps;
+    private originalColumns;
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders, config?: ColumnHideConfig);
+    /**
+     * 隐藏列
+     */
+    hideColumns(columns: string | number | (string | number)[]): void;
+    /**
+     * 显示列
+     */
+    showColumns(columns: string | number | (string | number)[]): void;
+    /**
+     * 切换列显示/隐藏状态
+     */
+    toggleColumns(columns: string | number | (string | number)[]): void;
+    /**
+     * 显示所有列
+     */
+    showAllColumns(): void;
+    /**
+     * 获取当前隐藏的列
+     */
+    getHiddenColumns(): string[];
+    /**
+     * 检查列是否隐藏
+     */
+    isColumnHidden(prop: string): boolean;
+    /**
+     * 将隐藏的列显示在指定列的左侧或右侧
+     * @param column 要显示的列的 prop
+     * @param target 目标列的 prop
+     * @param position 位置：'before' 左侧，'after' 右侧
+     */
+    showColumnAt(column: string, target: string, position?: 'before' | 'after'): boolean;
+    /**
+     * 批量将隐藏的列显示在指定列的左侧或右侧
+     */
+    showColumnsAt(columns: string[], target: string, position?: 'before' | 'after'): boolean;
+    /**
+     * 替换列：将当前列隐藏，同时将隐藏的列显示在当前列的位置
+     * @param hiddenColumn 要显示的隐藏列的 prop
+     * @param visibleColumn 要隐藏的当前显示列的 prop
+     */
+    replaceColumn(hiddenColumn: string, visibleColumn: string): boolean;
+    /**
+     * 获取所有列信息（包括隐藏的）
+     */
+    getAllColumns(): Array<{
+        prop: string;
+        name: string;
+        hidden: boolean;
+    }>;
+    /**
+     * 插入列
+     */
+    insertColumn(column: ColumnRegular, target: string | number, position?: 'before' | 'after'): boolean;
+    /**
+     * 批量插入列
+     */
+    insertColumns(columns: ColumnRegular[], target: string | number, position?: 'before' | 'after'): boolean;
+    /**
+     * 删除列
+     */
+    removeColumn(target: string | number): ColumnRegular | null;
+    /**
+     * 批量删除列
+     */
+    removeColumns(targets: (string | number)[]): ColumnRegular[];
+    private applyHiddenColumns;
+    /**
+     * 从 DOM 获取列的实际宽度
+     */
+    private buildSizeMap;
+    private normalizeColumnConfig;
+    private flattenColumns;
+    private findColumnIndex;
+    /**
+     * 在 originalColumns 中查找列
+     */
+    private findColumnInOriginal;
+    /**
+     * 从 originalColumns 中移除列
+     */
+    private removeColumnFromOriginal;
+    /**
+     * 将列插入到 originalColumns 的指定位置
+     */
+    private insertColumnToOriginal;
+    destroy(): void;
+}

package/dist/types/plugins/column-manage.plugin.d.ts

@@ -0,0 +1,225 @@
+/**
+ * 列管理插件
+ * 实现表格列的隐藏、显示、冻结、插入、删除等功能
+ */
+import { BasePlugin } from './base.plugin';
+import type { PluginProviders, ColumnRegular, ColumnGrouping } from "../types/index";
+type PinType = 'colPinStart' | 'colPinEnd' | undefined;
+export interface ColumnManageConfig {
+    /** 初始隐藏的列 */
+    hiddenColumns?: string | number | (string | number)[];
+    /** 拉伸列的 prop（该列宽度不保留，让 ColumnStretchPlugin 重新计算） */
+    stretchColumn?: string;
+    /** 列隐藏变化回调 */
+    onHiddenChange?: (hiddenProps: string[], changedProps?: string[]) => void;
+    /** 列冻结变化回调 */
+    onPinChange?: (prop: string, pin: PinType) => void;
+    /** 导入列配置完成回调（渲染完成后触发） */
+    onImportComplete?: (config: ColumnConfigExport) => void;
+}
+/** 单列配置导出项（精简版） */
+export interface ColumnConfigItem {
+    /** 列的 prop */
+    prop: string;
+    /** 列宽度 */
+    size?: number;
+    /** 冻结位置 */
+    pin?: 'colPinStart' | 'colPinEnd';
+}
+/** 分组列配置 */
+export interface ColumnGroupConfigItem {
+    /** 分组名称 */
+    name: string;
+    /** 冻结位置 */
+    pin?: 'colPinStart' | 'colPinEnd';
+    /** 子列 */
+    children: ColumnConfigItem[];
+}
+/** 列配置导出数据 */
+export type ColumnConfigExport = (ColumnConfigItem | ColumnGroupConfigItem)[];
+export declare class ColumnManagePlugin extends BasePlugin {
+    private config;
+    private hiddenProps;
+    private originalColumns;
+    private uniqueId;
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders, config?: ColumnManageConfig);
+    /**
+     * 获取当前保存的 uniqueId
+     */
+    getUniqueId(): any;
+    /**
+     * 自动检测隐藏的列（通过对比 allColumns 和当前 columns）
+     */
+    private autoDetectHiddenColumns;
+    /**
+     * 隐藏列
+     * 逻辑：
+     * 准备: 当前列配置
+     * 1. 遍历要隐藏的列
+     * 2. 查找列的位置
+     *   - 是分组下的列: 从分组中移除该列，如果分组为空则删除分组
+     *   - 是普通列: 从列数组中移除该列
+     * 3. 标记列为隐藏
+     */
+    hideColumns(columns: string | number | (string | number)[]): void;
+    /**
+     * 获取当前隐藏的列
+     */
+    getHiddenColumns(): string[];
+    /**
+     * 检查列是否隐藏
+     */
+    isColumnHidden(prop: string): boolean;
+    /**
+     * 设置列冻结
+     * @param prop 列的 prop
+     * @param pin 冻结类型：'colPinStart' 左冻结，'colPinEnd' 右冻结，undefined 取消冻结
+     * 冻结逻辑：
+     * pin值为：
+     * - 'colPinStart': 列冻结到左侧，放到左侧冻结的最后一个
+     * - 'colPinEnd': 列冻结到右侧，放到右侧冻结的第一个
+     * - undefined: 取消冻结。如果之前是左侧冻结，那就放在未冻结的第一个；如果之前是右侧冻结，那就放在未冻结的最后一个
+     */
+    setColumnPin(prop: string, pin: PinType): boolean;
+    /**
+     * 左冻结列
+     */
+    pinColumnLeft(prop: string): boolean;
+    /**
+     * 右冻结列
+     */
+    pinColumnRight(prop: string): boolean;
+    /**
+     * 取消列冻结
+     */
+    unpinColumn(prop: string): boolean;
+    /**
+     * 获取列的冻结状态
+     */
+    getColumnPin(prop: string): PinType;
+    /**
+     * 检查列是否冻结
+     */
+    isColumnPinned(prop: string): boolean;
+    /**
+     * 将隐藏的列显示在指定列的左侧或右侧
+     * 逻辑：
+     * 准备: additionalData.allColumns、当前是否分组、当前列所属分组数据、目标列数据
+     * 1. 是否分组下的列
+     *   - 是: 获取列在分组下的索引，根据 position 和索引插入目标列数据
+     *   - 否: 根据 column 获取索引，再根据 position 和索引插入目标列数据
+     * 2. 目标列数据的pin继承当前列的pin
+     */
+    showColumnAt(column: string, target: string, position?: 'before' | 'after'): boolean;
+    /**
+     * 批量将隐藏的列显示在指定列的左侧或右侧
+     */
+    showColumnsAt(columns: string[], target: string, position?: 'before' | 'after'): boolean;
+    /**
+     * 替换列：将可见列隐藏，同时将隐藏列显示在可见列的位置
+     * @param hiddenColumn 当前隐藏的列（要显示）
+     * @param visibleColumn 当前可见的列（要隐藏）
+     * 逻辑：
+     * 准备: additionalData.allColumns、当前列配置、可见列位置和分组信息、隐藏列数据
+     * 1. 查找可见列的位置
+     *   - 是分组下的列: 获取分组和子列索引，替换该位置的列
+     *   - 是普通列: 获取列索引，替换该位置的列
+     * 2. 替换列数据的pin和size继承可见列的pin和size
+     * 3. 将可见列标记为隐藏
+     */
+    replaceColumn(hiddenColumn: string, visibleColumn: string): boolean;
+    /**
+     * 导出当前列配置（用于保存到接口）
+     * 只导出可见列（从 grid.columns 获取，包含拖拽后的新顺序和实际宽度）
+     * 返回列配置数组，包含列顺序、冻结状态、宽度等
+     */
+    exportColumnConfig(): ColumnConfigExport;
+    /**
+     * 导入列配置（从接口恢复）
+     * @param config 列配置数据（与 exportColumnConfig 格式一致）
+     * @param uniqueId 可选的唯一标识符，用于防抖
+     * @returns Promise<boolean> 返回 Promise，在渲染完成后 resolve
+     */
+    importColumnConfig(config: ColumnConfigExport, uniqueId?: any): Promise<boolean>;
+    /**
+     * 设置列的编组（统一入口方法）
+     * @param columnProp 列的 prop
+     * @param groupName 编组名称，如果为空则移除编组
+     * @returns 是否成功
+     *
+     * 使用示例：
+     * - setColumnGroup('priority', '基础信息') // 将 priority 列设置到 "基础信息" 编组
+     * - setColumnGroup('priority', '') // 移除 priority 列的编组
+     */
+    setColumnGroup(columnProp: string, groupName: string): boolean;
+    /**
+     * 查找列相邻的同名编组
+     * @private
+     */
+    private findAdjacentGroup;
+    /**
+     * 创建列编组
+     * @param columns 列数据源
+     * @param groupName 编组名称
+     * @param columnProps 要编组的列 prop 数组
+     * @param pin 可选的冻结位置
+     * @private
+     */
+    private createColumnGroup;
+    /**
+     * 向编组添加列
+     * @param columns 列数据源
+     * @param adjacentGroup 相邻编组信息（包含 groupIndex、columnIndex、position）
+     * @private
+     */
+    private addColumnToGroup;
+    /**
+     * 从编组移除列
+     * @param columns 列数据源
+     * @param groupName 编组名称
+     * @param columnProp 要移除的列 prop
+     * @private
+     */
+    private removeColumnFromGroup;
+    /**
+     * 创建编组对象
+     * @private
+     */
+    private createGroupObject;
+    /**
+     * 获取所有编组信息
+     */
+    getGroups(): Array<{
+        name: string;
+        columns: string[];
+        pin?: PinType;
+    }>;
+    /**
+     * 检查列是否在编组中
+     */
+    isColumnInGroup(columnProp: string): boolean;
+    /**
+     * 获取列所在的编组名称
+     */
+    getColumnGroup(columns: (ColumnRegular | ColumnGrouping<any>)[], columnProp: string): string | null;
+    /**
+     * 从 columns 数组中查找列的位置和分组信息
+     * @param columns 列数组
+     * @param prop 列的 prop
+     * @returns 列信息对象，包含索引、分组信息和列数据
+     */
+    private findColumnInColumns;
+    private buildSizeMap;
+    private normalizeColumnConfig;
+    private flattenColumns;
+    /**
+     * 找到列应该插入的位置（基于传入的 columns 数组）
+     * @param columns 列数组
+     * @param newPin 新的冻结状态
+     * @param previousPin 之前的冻结状态（用于取消冻结时判断插入位置）
+     */
+    private findInsertPositionForPinInColumns;
+    private findColumnByProp;
+    destroy(): void;
+}
+export {};

package/dist/types/plugins/column-stretch.plugin.d.ts

@@ -0,0 +1,159 @@
+/**
+ * ColumnStretchPlugin - 列自动撑满插件
+ * 让指定列自动撑满表格剩余空间
+ *
+ * 参考自 src/components/readable/ColumnStretchPlugin.js
+ */
+import { BasePlugin } from './base.plugin';
+import type { PluginProviders } from "../types/index";
+export interface ColumnStretchConfig {
+    /**
+     * 撑满模式：
+     * - 'last': 拉伸最后一列
+     * - 'all': 拉伸所有列
+     * - number: 拉伸指定索引的列
+     * - string: 拉伸指定 prop 的列
+     */
+    stretchColumn?: 'last' | 'all' | number | string;
+    /** 最小宽度，默认 50 */
+    minWidth?: number;
+    /** 是否显示右侧空白区域的表头边框，默认 true */
+    showHeaderBorder?: boolean;
+    /** 是否显示右侧空白区域的行边框，默认 true */
+    showRowBorder?: boolean;
+    /** 右侧空白区域表头边框颜色，默认使用 --revo-grid-header-border */
+    headerBorderColor?: string;
+    /** 右侧空白区域行边框颜色，默认使用 --revo-grid-cell-border */
+    rowBorderColor?: string;
+    /** 分组行边框颜色，默认使用 --rg-cell-border-color */
+    groupRowBorderColor?: string;
+}
+export declare class ColumnStretchPlugin extends BasePlugin {
+    private config;
+    private containerWidth;
+    private columnsData;
+    private manuallyResizedColumns;
+    private resizeEndTimeout;
+    private resizeObserver;
+    private virtualGridContainer;
+    private virtualGridOverlay;
+    private virtualHeaderOverlay;
+    private wheelHandler;
+    private isInitialRecorded;
+    private userResizedColumns;
+    private isApplyingStretch;
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders | null, config?: ColumnStretchConfig);
+    private init;
+    /**
+     * 记录初始化时已设置 size 的列
+     * 如果自动宽度列配置了 size，将其标记为手动调整过的列（固定宽度）
+     */
+    private recordInitialSizedColumns;
+    /**
+     * 同步自动宽度列的 size 到 dimension store
+     * 解决拖拽后 col.size 有值但 sizes[index] 为 undefined 的问题
+     */
+    private syncStretchColumnSize;
+    /**
+     * 在列应用前为自动宽度列设置初始宽度
+     */
+    private setInitialStretchColumnWidth;
+    /**
+     * 查找自动宽度列
+     */
+    private findStretchColumn;
+    /**
+     * 计算自动宽度列的初始宽度
+     */
+    private calculateInitialStretchWidth;
+    /**
+     * 获取列的最小宽度
+     */
+    private getColumnMinWidth;
+    /**
+     * 获取被拉伸列的 prop
+     */
+    private getStretchColumnProp;
+    /**
+     * 应用列拉伸（实际实现）
+     */
+    private applyStretchImpl;
+    /**
+     * 创建模拟网格覆盖层
+     */
+    private createvirtualGridOverlay;
+    /**
+     * 更新模拟网格覆盖层
+     */
+    private updatevirtualGridOverlay;
+    /**
+     * 获取行高
+     */
+    private getRowHeight;
+    /**
+     * 移除模拟网格覆盖层
+     */
+    private removevirtualGridOverlay;
+    /**
+     * 拉伸最后一列
+     * @returns 剩余未分配的宽度
+     */
+    private stretchLastColumn;
+    /**
+     * 按索引拉伸列
+     * @returns 剩余未分配的宽度
+     */
+    private stretchColumnByIndex;
+    /**
+     * 按 prop 拉伸列
+     * @returns 剩余未分配的宽度
+     */
+    private stretchColumnByProp;
+    /**
+     * 应用列拉伸
+     * @returns 剩余未分配的宽度（当列达到最小宽度限制时）
+     */
+    private applyColumnStretch;
+    /**
+     * 拉伸所有列
+     */
+    private stretchAllColumns;
+    /**
+     * 检查列是否有效
+     */
+    private isValidColumn;
+    /**
+     * 公开的 applyStretch 方法
+     */
+    applyStretch(): void;
+    /**
+     * 立即同步执行拉伸计算（不使用防抖）
+     * 用于需要立即响应的场景，如拖拽结束
+     */
+    applyStretchImmediate(): void;
+    /**
+     * 重置手动调整记录
+     */
+    resetManualResize(): void;
+    /**
+     * 检查列是否被手动调整过宽度
+     */
+    isManuallyResized(prop: string): boolean;
+    /**
+     * 标记列为手动调整过
+     */
+    markAsManuallyResized(prop: string): void;
+    /**
+     * 取消列的手动调整标记
+     */
+    unmarkAsManuallyResized(prop: string): void;
+    /**
+     * 获取拉伸列配置
+     */
+    getStretchColumnConfig(): 'last' | 'all' | number | string | undefined;
+    /**
+     * 更新配置
+     */
+    updateConfig(config: Partial<ColumnStretchConfig>): void;
+    destroy(): void;
+}

package/dist/types/plugins/column.auto-size.plugin.d.ts

@@ -0,0 +1,69 @@
+import { BasePlugin } from './base.plugin';
+import type { DimensionCols, ColumnRegular, DataType, InitialHeaderClick, BeforeSaveDataDetails, BeforeRangeSaveDataDetails, PluginProviders } from "../types/index";
+interface Column extends ColumnRegular {
+    index: number;
+}
+type AutoSizeColumns = Record<DimensionCols, ColumnRecords>;
+type ColumnRecords = Record<any, Column>;
+type EditEvent = BeforeSaveDataDetails | BeforeRangeSaveDataDetails;
+type Resolve = (cols: Partial<AutoSizeColumns>) => void;
+type Reject = () => void;
+export type AutoSizeColumnConfig = {
+    mode?: ColumnAutoSizeMode;
+    /**
+     * autoSize for all columns
+     * if allColumnes true all columns treated as autoSize, worse for performance
+     * false by default
+     */
+    allColumns?: boolean;
+    /**
+     * assumption per characted size
+     * by default defined as 8, can be changed in this config
+     */
+    letterBlockSize?: number;
+    /** make size calculation exact
+     * by default it based on assumption each character takes some space defined in letterBlockSize */
+    preciseSize?: boolean;
+    /**
+     * reset column width to initial size on header double click
+     * requires mode to be 'resetToInitialSize'
+     */
+    resetToInitialSize?: boolean;
+};
+export declare const enum ColumnAutoSizeMode {
+    headerClickAutosize = "headerClickAutoSize",
+    autoSizeOnTextOverlap = "autoSizeOnTextOverlap",
+    autoSizeAll = "autoSizeAll",
+    resetToInitialSize = "resetToInitialSize"
+}
+export declare class AutoSizeColumnPlugin extends BasePlugin {
+    providers: PluginProviders;
+    config?: AutoSizeColumnConfig | undefined;
+    autoSizeColumns: Partial<AutoSizeColumns> | null;
+    readonly letterBlockSize: number;
+    /** for config option when preciseSize enabled */
+    readonly precsizeCalculationArea: HTMLElement;
+    /** for edge case when no columns defined before data */
+    dataResolve: Resolve | null;
+    dataReject: Reject | null;
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders, config?: AutoSizeColumnConfig | undefined);
+    setSource(source: DataType[]): Promise<void>;
+    getLength(len?: any): number;
+    afteredit(e: EditEvent): void;
+    afterEditAll(e: EditEvent): void;
+    getColumnSize(index: number, type: DimensionCols): number;
+    columnSet(columns: Record<DimensionCols, ColumnRegular[]>): void;
+    /**
+     * Reset column width to initial size
+     */
+    resetColumnToInitialSize(detail: InitialHeaderClick): void;
+    /**
+     * 触发自动列宽并应用防跳动机制
+     */
+    private triggerAutoSizeWithAntiJitter;
+    clearPromise(): void;
+    isRangeEdit(e: EditEvent): e is BeforeRangeSaveDataDetails;
+    initiatePresizeElement(): HTMLElement;
+    destroy(): void;
+}
+export {};

package/dist/types/plugins/column.stretch.plugin.d.ts

@@ -0,0 +1,20 @@
+import { BasePlugin } from './base.plugin';
+import { DimensionCols, PluginBaseComponent, PluginProviders, ColumnRegular } from "../types/index";
+export declare class StretchColumn extends BasePlugin {
+    providers: PluginProviders;
+    private stretchedColumn;
+    private readonly scrollSize;
+    constructor(revogrid: HTMLRevoGridElement, providers: PluginProviders);
+    private setScroll;
+    private activateChanges;
+    private dropChanges;
+    private apply;
+    /**
+     * Apply stretch changes
+     */
+    applyStretch(columns: Record<DimensionCols, ColumnRegular[]>): void;
+}
+/**
+ * Check plugin type is Stretch
+ */
+export declare function isStretchPlugin(plugin: PluginBaseComponent | StretchColumn): plugin is StretchColumn;