@opensumi/ide-components 2.12.1-next-079c1930

package/lib/recycle-tree/RecycleTree.d.ts

@@ -0,0 +1,254 @@
+import React from 'react';
+import { TreeModel } from './tree/model/TreeModel';
+import { TreeNode, CompositeTreeNode } from './tree';
+import { RenamePromptHandle } from './prompt';
+import { NewPromptHandle } from './prompt/NewPromptHandle';
+import { Event } from '../utils';
+import { INodeRendererProps } from './TreeNodeRendererWrap';
+import fuzzy from 'fuzzy';
+export declare type IRecycleTreeAlign = 'smart' | 'start' | 'center' | 'end' | 'auto';
+export interface IModelChange {
+    preModel: TreeModel;
+    nextModel: TreeModel;
+}
+export declare type IRecycleTreeOverflow = 'ellipsis' | 'auto';
+export interface IRecycleTreeSize {
+    width?: number;
+    height: number;
+}
+export interface IRecycleTreeProps<T = TreeModel> {
+    model: T;
+    /**
+     * 容器高度
+     * height 计算出可视区域渲染数量
+     * @type {number}
+     * @memberof RecycleTreeProps
+     */
+    height: number;
+    /**
+     * 容器宽度
+     * height 计算出可视区域渲染数量
+     * @type {number}
+     * @memberof RecycleTreeProps
+     */
+    width?: number;
+    /**
+     * 节点高度
+     * @type {number}
+     * @memberof RecycleTreeProps
+     */
+    itemHeight: number;
+    /**
+     * Tree外部样式
+     * @type {React.CSSProperties}
+     * @memberof RecycleTreeProps
+     */
+    style?: React.CSSProperties;
+    /**
+     * Tree外部样式名
+     * @type {string}
+     * @memberof RecycleTreeProps
+     */
+    className?: string;
+    /**
+     * Tree初始化完成后会返回控制句柄
+     * @memberof IRecycleTreeProps
+     */
+    onReady?: (handle: IRecycleTreeHandle) => void;
+    /**
+     * 筛选节点字段
+     * 1. 路径匹配，如app/test
+     * 2. 模糊匹配
+     * @type {string}
+     * @memberof IRecycleTreeProps
+     */
+    filter?: string;
+    /**
+     * 筛选器
+     */
+    filterProvider?: {
+        fuzzyOptions: () => fuzzy.FilterOptions<any>;
+        filterAlways?: boolean;
+    };
+    /**
+     * 空白时的占位元素
+     * @type {React.ReactNode}
+     * @memberof IRecycleTreeProps
+     */
+    placeholder?: React.JSXElementConstructor<any>;
+    /**
+     * 声明文件树单行超出时的处理行为：
+     * - ellipsis 展示省略号
+     * - auto 撑开容器，可能会有横向滚动条
+     * 默认为 ellipsis
+     * @type {IRecycleTreeOverflow}
+     * @memberof IRecycleTreeProps
+     */
+    overflow?: IRecycleTreeOverflow;
+    /**
+     * 声明Tree加载时预加载的节点内容
+     * 主要用于避免快速滚动时出现空白区域的情况
+     * 默认值为：Recycle.DEFAULT_OVER_SCAN_COUNT = 50
+     * @type {number}
+     * @memberof IRecycleTreeProps
+     */
+    overScanCount?: number;
+    /**
+     * 是否保留 Tree 底部空白，大小为 22 px
+     * 默认值为：false
+     */
+    leaveBottomBlank?: boolean;
+    /**
+     * 指定如何获取 item key
+     */
+    getItemKey?: (node: INodeRendererProps) => string | number;
+    /**
+     * 支持根据内容动态调整高度
+     * 最低不能少于 22 px
+     * 默认值为: false
+     *
+     */
+    supportDynamicHeights?: boolean;
+}
+export interface IRecycleTreeError {
+    type: RenderErrorType;
+    message: string;
+}
+export declare enum RenderErrorType {
+    RENDER_ITEM = 0,
+    GET_RENDED_KEY = 1,
+    RENDER_ERROR = 2
+}
+export interface IRecycleTreeHandle {
+    /**
+     * 新建节点
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    promptNewTreeNode(pathOrTreeNode: string | CompositeTreeNode): Promise<NewPromptHandle>;
+    /**
+     * 新建可折叠节点
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    promptNewCompositeTreeNode(pathOrTreeNode: string | CompositeTreeNode): Promise<NewPromptHandle>;
+    /**
+     * 重命名节点
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    promptRename(pathOrTreeNode: string | TreeNode | CompositeTreeNode, defaultName?: string): Promise<RenamePromptHandle>;
+    /**
+     * 展开节点
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    expandNode(pathOrTreeNode: string | CompositeTreeNode): Promise<void>;
+    /**
+     * 折叠节点
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    collapseNode(pathOrTreeNode: string | CompositeTreeNode): Promise<void>;
+    /**
+     * 定位节点位置，滚动条将会滚动到对应可视区域，需要手动控制是否稳定后再进行节点定位
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     * @param align IRecycleTreeAlign
+     * @param untilStable 是否在节点稳定时再进行定位操作，部分Tree可能在定位过程中会有不断传入的变化，如文件树
+     */
+    ensureVisible(pathOrTreeNode: string | TreeNode | CompositeTreeNode, align?: IRecycleTreeAlign, untilStable?: boolean): Promise<TreeNode | undefined>;
+    /**
+     * 获取当前Tree的宽高信息
+     *
+     * @returns {IRecycleTreeSize}
+     * @memberof IRecycleTreeHandle
+     */
+    getCurrentSize(): IRecycleTreeSize;
+    /**
+     * 获取当前TreeModel
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    getModel(): TreeModel;
+    /**
+     * TreeModel变更事件
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    onDidChangeModel: Event<IModelChange>;
+    /**
+     * Tree更新事件
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    onDidUpdate: Event<void>;
+    /**
+     * Tree更新事件, 仅触发一次
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    onOnceDidUpdate: Event<void>;
+    /**
+     * 监听渲染报错
+     *
+     * @param pathOrTreeNode 节点或者节点路径
+     */
+    onError: Event<IRecycleTreeError>;
+    /**
+     * 自适应每条 item 的布局（暂时只计算高度）
+     */
+    layoutItem: () => void;
+}
+export declare class RecycleTree extends React.Component<IRecycleTreeProps> {
+    static PADDING_BOTTOM_SIZE: number;
+    private static DEFAULT_ITEM_HEIGHT;
+    private static BATCHED_UPDATE_MAX_DEBOUNCE_MS;
+    private static TRY_ENSURE_VISIBLE_MAX_TIMES;
+    private static FILTER_FUZZY_OPTIONS;
+    private static DEFAULT_OVER_SCAN_COUNT;
+    private _promptHandle;
+    private idxToRendererPropsCache;
+    private dynamicSizeMap;
+    private listRef;
+    private disposables;
+    private onErrorEmitter;
+    private onDidUpdateEmitter;
+    private onDidModelChangeEmitter;
+    private newPromptInsertionIndex;
+    private promptTargetID;
+    private tryEnsureVisibleTimes;
+    private idToFilterRendererPropsCache;
+    private filterFlattenBranch;
+    private filterFlattenBranchChildrenCache;
+    private filterWatcherDisposeCollection;
+    private batchUpdatePromise;
+    private batchUpdateResolver;
+    private batchUpdate;
+    private getNewPromptInsertIndex;
+    UNSAFE_componentWillUpdate(prevProps: IRecycleTreeProps): void;
+    componentDidUpdate(prevProps: IRecycleTreeProps): void;
+    private promptNew;
+    private promptNewTreeNode;
+    private promptNewCompositeTreeNode;
+    private promptRename;
+    private expandNode;
+    private collapseNode;
+    private _isEnsuring;
+    private ensureVisible;
+    private tryScrollIntoView;
+    private tryScrollIntoViewWhileStable;
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    private set promptHandle(value);
+    private get promptHandle();
+    private getItemAtIndex;
+    private handleListScroll;
+    private get adjustedRowCount();
+    private getItemKey;
+    private filterItems;
+    private renderItem;
+    private layoutItem;
+    render(): JSX.Element;
+}
+//# sourceMappingURL=RecycleTree.d.ts.map

package/lib/recycle-tree/RecycleTree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecycleTree.d.ts","sourceRoot":"","sources":["../../src/recycle-tree/RecycleTree.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAe,MAAM,QAAQ,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAgB,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAiC,KAAK,EAAc,MAAM,UAAU,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAmC,MAAM,wBAAwB,CAAC;AAG7F,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,oBAAY,iBAAiB,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;AAE9E,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,SAAS,CAAC;IACpB,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,oBAAY,oBAAoB,GAAG,UAAU,GAAG,MAAM,CAAC;AAEvD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC,GAAG,SAAS;IAC9C,KAAK,EAAE,CAAC,CAAC;IACT;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC;IAC5B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAC/C;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE;QACf,YAAY,EAAE,MAAM,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QAC7C,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IACF;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;IAC/C;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,MAAM,GAAG,MAAM,CAAC;IAE3D;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,eAAe,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,oBAAY,eAAe;IACzB,WAAW,IAAA;IACX,cAAc,IAAA;IACd,YAAY,IAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxF;;;;OAIG;IACH,0BAA0B,CAAC,cAAc,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACjG;;;;OAIG;IACH,YAAY,CAAC,cAAc,EAAE,MAAM,GAAG,QAAQ,GAAG,iBAAiB,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACvH;;;;OAIG;IACH,UAAU,CAAC,cAAc,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE;;;;OAIG;IACH,YAAY,CAAC,cAAc,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE;;;;;;OAMG;IACH,aAAa,CAAC,cAAc,EAAE,MAAM,GAAG,QAAQ,GAAG,iBAAiB,EAAE,KAAK,CAAC,EAAE,iBAAiB,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;IACtJ;;;;;OAKG;IACH,cAAc,IAAI,gBAAgB,CAAC;IACnC;;;;OAIG;IACH,QAAQ,IAAI,SAAS,CAAC;IACtB;;;;OAIG;IACH,gBAAgB,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IACtC;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB;;;;OAIG;IACH,eAAe,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAE7B;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAElC;;OAEG;IACH,UAAU,EAAE,MAAM,IAAI,CAAC;CACxB;AAoBD,qBAAa,WAAY,SAAQ,KAAK,CAAC,SAAS,CAAC,iBAAiB,CAAC;IACjE,OAAc,mBAAmB,EAAE,MAAM,CAAM;IAC/C,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAc;IAChD,OAAO,CAAC,MAAM,CAAC,8BAA8B,CAAe;IAC5D,OAAO,CAAC,MAAM,CAAC,4BAA4B,CAAa;IACxD,OAAO,CAAC,MAAM,CAAC,oBAAoB,CAMjC;IACF,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAM;IAE5C,OAAO,CAAC,aAAa,CAAuC;IAE5D,OAAO,CAAC,uBAAuB,CAA8C;IAC7E,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,OAAO,CAAuD;IACtE,OAAO,CAAC,WAAW,CAAoD;IAEvE,OAAO,CAAC,cAAc,CAAoC;IAC1D,OAAO,CAAC,kBAAkB,CAAgC;IAC1D,OAAO,CAAC,uBAAuB,CAAwC;IAEvE,OAAO,CAAC,uBAAuB,CAAc;IAE7C,OAAO,CAAC,cAAc,CAAS;IAE/B,OAAO,CAAC,qBAAqB,CAAS;IAEtC,OAAO,CAAC,4BAA4B,CAAoD;IACxF,OAAO,CAAC,mBAAmB,CAAW;IACtC,OAAO,CAAC,gCAAgC,CAAoC;IAC5E,OAAO,CAAC,8BAA8B,CAA8B;IAEpE,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,mBAAmB,CAAM;IAGjC,OAAO,CAAC,WAAW,CA0Dd;IAEL,OAAO,CAAC,uBAAuB;IAoBxB,0BAA0B,CAAC,SAAS,EAAE,iBAAiB;IAYvD,kBAAkB,CAAC,SAAS,EAAE,iBAAiB;YAgBxC,SAAS;IAwCvB,OAAO,CAAC,iBAAiB,CAExB;IAED,OAAO,CAAC,0BAA0B,CAEjC;IAED,OAAO,CAAC,YAAY,CAmBnB;IAED,OAAO,CAAC,UAAU,CASjB;IAED,OAAO,CAAC,YAAY,CASnB;IAED,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,aAAa,CA4BpB;IAED,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,4BAA4B;IAoB7B,iBAAiB;IA8BjB,oBAAoB;IAI3B,OAAO,KAAK,YAAY,QAOvB;IAED,OAAO,KAAK,YAAY,GAEvB;IAED,OAAO,CAAC,cAAc,CAgDrB;IAED,OAAO,CAAC,gBAAgB,CAGvB;IAGD,OAAO,KAAK,gBAAgB,GAY3B;IAED,OAAO,CAAC,UAAU,CAKjB;IAGD,OAAO,CAAC,WAAW,CAsGlB;IAED,OAAO,CAAC,UAAU,CA8DjB;IAED,OAAO,CAAC,UAAU,CAiBjB;IAEM,MAAM;CA+Cd"}