@difizen/libro-common 0.3.3 → 1.0.0

package/es/app/tree/view/tree-view.d.ts

@@ -0,0 +1,262 @@
+import type PerfectScrollbar from 'perfect-scrollbar';
+import * as React from 'react';
+import type { ScrollParams } from 'react-virtualized';
+import { CellMeasurerCache } from 'react-virtualized';
+import type { MeasuredCellParent } from 'react-virtualized/dist/es/CellMeasurer';
+import { DisposableCollection } from '../../../common/index.js';
+import type { MenuPath } from '../../../core/index.js';
+import type { StatefulView, ViewSize } from '../../../core/index.js';
+import { BaseView, SelectionService } from '../../../core/index.js';
+import { LabelProvider } from '../../label/index.js';
+import type { ModifierAwareEvent, NodeRow } from '../tree.js';
+import { TreeNode } from '../tree.js';
+import { TreeDecoratorService } from '../tree-decorator.js';
+import { ExpandableTreeNode } from '../tree-expansion.js';
+import { TreeModel } from '../tree-model.js';
+import type { NodeProps } from '../tree-protocol.js';
+import { TreeProps } from '../tree-protocol.js';
+import { SelectableTreeNode } from '../tree-selection.js';
+import type { TreeViewDecoration } from '../tree-view-decoration.js';
+import { TreeViewDecorator } from './tree-view-decorator.js';
+import './index.less';
+/**
+ * Representation of the tree view properties.
+ */
+export type ViewProps = {
+    /**
+     * The width property.
+     */
+    width: number;
+    /**
+     * The height property.
+     */
+    height: number;
+    /**
+     * The scroll to row value.
+     */
+    scrollToRow?: number;
+    /**
+     * The list of node rows.
+     */
+    rows: NodeRow[];
+    handleScroll: (info: ScrollParams) => void;
+    renderNodeRow: (row: NodeRow) => React.ReactNode;
+};
+export interface TreeViewRowProps {
+    rowKey: string;
+    index?: number | undefined;
+    parent: MeasuredCellParent;
+    style?: React.CSSProperties | undefined;
+    row?: NodeRow;
+    cache: CellMeasurerCache;
+}
+export declare const TreeViewRow: (props: TreeViewRowProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare function TreeViewContent(): import("react/jsx-runtime").JSX.Element;
+export declare const TreeViewComponent: React.ForwardRefExoticComponent<React.RefAttributes<HTMLDivElement>>;
+export declare const TreeViewFactoryId = "tree-view-factory";
+export declare class TreeView extends BaseView implements StatefulView {
+    /**
+     * Row index to ensure visibility.
+     * - Used to forcefully scroll if necessary.
+     */
+    scrollToRow: number | undefined;
+    id: string;
+    view: React.ForwardRefExoticComponent<React.RefAttributes<HTMLDivElement>>;
+    rows: Map<string, NodeRow>;
+    contextMenuData: any;
+    scrollOptions: PerfectScrollbar.Options;
+    protected toDispose: DisposableCollection;
+    protected shouldScrollToRow: boolean;
+    readonly contextMenuPath: MenuPath;
+    readonly props: TreeProps;
+    readonly model: TreeModel;
+    readonly treeViewDecorator: TreeViewDecorator;
+    readonly selectionService: SelectionService;
+    readonly lableProvider: LabelProvider;
+    readonly treeRowComponent: (props: TreeViewRowProps) => import("react/jsx-runtime").JSX.Element | null;
+    protected readonly decoratorService: TreeDecoratorService;
+    constructor(props: TreeProps, model: TreeModel, treeViewDecorator: TreeViewDecorator, selectionService: SelectionService, lableProvider: LabelProvider, decoratorService: TreeDecoratorService);
+    offsetWidth?: number | undefined;
+    offsetHeight?: number | undefined;
+    onViewResize: (size: ViewSize) => void;
+    protected init(): void;
+    protected updateRows: () => void;
+    protected doUpdateRows(): void;
+    /**
+     * Create the node class names.
+     * @param node the tree node.
+     * @param _props the node properties.
+     *
+     * @returns the list of tree node class names.
+     */
+    protected createNodeClassNames(node: TreeNode, _props: NodeProps): string[];
+    /**
+     * Create node attributes for the tree node given the node properties.
+     * @param node the tree node.
+     * @param props the node properties.
+     */
+    createNodeAttributes(node: TreeNode, props: NodeProps): React.Attributes & React.HTMLAttributes<HTMLElement>;
+    /**
+     * Create the container attributes for the widget.
+     */
+    createContainerAttributes(): React.HTMLAttributes<HTMLElement>;
+    /**
+     * Get the container tree node.
+     *
+     * @returns the tree node for the container if available.
+     */
+    getContainerTreeNode(): TreeNode | undefined;
+    /**
+     * Handle the context menu click event.
+     * - The context menu click event is triggered by the right-click.
+     * @param node the tree node if available.
+     * @param event the right-click mouse event.
+     */
+    handleContextMenuEvent: (event: React.MouseEvent<HTMLElement>, tree: TreeView | undefined, n: TreeNode | TreeView | undefined) => void;
+    /**
+     * Convert the tree node to context menu arguments.
+     * @param _node the selectable tree node.
+     */
+    setContextMenuArgs: (node: TreeNode | undefined, tree?: TreeView | undefined) => any;
+    /**
+     * Actually focus the tree node.
+     */
+    protected doFocus(): void;
+    /**
+     * Get the tree node to focus.
+     *
+     * @returns the node to focus if available.
+     */
+    protected getNodeToFocus(): SelectableTreeNode | undefined;
+    updateGlobalSelection(): void;
+    /**
+     * Update the `scrollToRow`.
+     * @param updateOptions the tree widget force update options.
+     */
+    protected updateScrollToRow(): void;
+    /**
+     * Handle the scroll event.
+     */
+    readonly handleScroll: (info: ScrollParams) => void;
+    /**
+     * Get the `scrollToRow`.
+     *
+     * @returns the `scrollToRow` if available.
+     */
+    protected getScrollToRow(): number | undefined;
+    protected shouldDisplayNode(node: TreeNode): boolean;
+    /**
+     * Toggle the node.
+     */
+    readonly toggle: (event: React.MouseEvent<HTMLElement>) => void;
+    protected findNodeAttr(domNode: (EventTarget & HTMLElement) | null): string | undefined;
+    /**
+     * Actually toggle the tree node.
+     * @param event the mouse click event.
+     */
+    protected doToggle(event: React.MouseEvent<HTMLElement>): void;
+    /**
+     * Determine if the tree modifier aware event has a `ctrlcmd` mask.
+     * @param event the tree modifier aware event.
+     *
+     * @returns `true` if the tree modifier aware event contains the `ctrlcmd` mask.
+     */
+    protected hasCtrlCmdMask(event: ModifierAwareEvent): boolean;
+    /**
+     * Determine if the tree modifier aware event has a `shift` mask.
+     * @param event the tree modifier aware event.
+     *
+     * @returns `true` if the tree modifier aware event contains the `shift` mask.
+     */
+    protected hasShiftMask(event: ModifierAwareEvent): boolean;
+    /**
+     * Handle the single-click mouse event.
+     * @param node the tree node if available.
+     * @param event the mouse single-click event.
+     */
+    handleClickEvent(maybeProxyNode: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void;
+    /**
+     * Handle the double-click mouse event.
+     * @param node the tree node if available.
+     * @param event the double-click mouse event.
+     */
+    handleDblClickEvent(node: TreeNode | undefined, event: React.MouseEvent<HTMLElement>): void;
+    /**
+     * Determine the classes to use for an icon
+     * - Assumes a Font Awesome name when passed a single string, otherwise uses the passed string array
+     * @param iconName the icon name or list of icon names.
+     * @param additionalClasses additional CSS classes.
+     *
+     * @returns the icon class name.
+     */
+    getIconClass(iconName: string | string[], additionalClasses?: string[]): string;
+    /**
+     * Apply font styles to the tree.
+     * @param original the original css properties.
+     * @param fontData the optional `fontData`.
+     */
+    applyFontStyles(original: React.CSSProperties, fontData: TreeViewDecoration.FontData | undefined): React.CSSProperties;
+    isExpandable(node: TreeNode): node is ExpandableTreeNode;
+    needsActiveIndentGuideline(node: TreeNode): boolean;
+    toNodeIcon(node: TreeNode): string;
+    toNodeName(node: TreeNode): string;
+    toNodeDescription(node: TreeNode): string;
+    /**
+     * Create the tree node style.
+     * @param node the tree node.
+     * @param props the node properties.
+     */
+    createNodeStyle(node: TreeNode, props: NodeProps): React.CSSProperties | undefined;
+    /**
+     * Decorate the node style.
+     * @param node the tree node.
+     * @param style the optional CSS properties.
+     *
+     * @returns the CSS styles if available.
+     */
+    protected decorateNodeStyle(node: TreeNode, style: React.CSSProperties | undefined): React.CSSProperties | undefined;
+    /**
+     * Get the default node style.
+     * @param node the tree node.
+     * @param props the node properties.
+     *
+     * @returns the CSS properties if available.
+     */
+    protected getDefaultNodeStyle(node: TreeNode, props: NodeProps): React.CSSProperties | undefined;
+    protected getPaddingLeft(node: TreeNode, props: NodeProps): number;
+    /**
+     * If the node is a composite, a toggle will be rendered.
+     * Otherwise we need to add the width and the left, right padding => 18px
+     */
+    protected needsExpansionTogglePadding(node: TreeNode): boolean;
+    /**
+     * Deflate the tree node for storage.
+     * @param node the tree node.
+     */
+    protected deflateForStorage(node: TreeNode): object;
+    /**
+     * Inflate the tree node from storage.
+     * @param node the tree node.
+     * @param parent the optional tree node.
+     */
+    protected inflateFromStorage(node: any, parent?: TreeNode): TreeNode;
+    /**
+     * Store the tree state.
+     */
+    storeState(): object;
+    /**
+     * Restore the state.
+     * @param oldState the old state object.
+     */
+    restoreState(oldState: object): void;
+}
+export type TreeViewSelection = readonly Readonly<SelectableTreeNode>[] & {
+    source: TreeView;
+};
+export declare namespace TreeViewSelection {
+    function isSource(selection: Record<any, any> | undefined, source: TreeView): boolean;
+    function getSource(selection: Record<any, any> | undefined): TreeView | undefined;
+    function is(selection: Record<any, any> | undefined): selection is TreeViewSelection;
+    function create(source: TreeView): TreeViewSelection;
+}
+//# sourceMappingURL=tree-view.d.ts.map

package/es/app/tree/view/tree-view.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-view.d.ts","sourceRoot":"","sources":["../../../../src/app/tree/view/tree-view.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,gBAAgB,MAAM,mBAAmB,CAAC;AAEtD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAgB,iBAAiB,EAAQ,MAAM,mBAAmB,CAAC;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAIjF,OAAO,EAAc,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC5E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAsB,MAAM,wBAAwB,CAAC;AAIxF,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAOrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EAAqB,QAAQ,EAAsB,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAGL,SAAS,EAIV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,kBAAkB,EAAiB,MAAM,sBAAsB,CAAC;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAErE,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,OAAO,cAAc,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,YAAY,EAAE,CAAC,IAAI,EAAE,YAAY,KAAK,IAAI,CAAC;IAC3C,aAAa,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,KAAK,CAAC,SAAS,CAAC;CAClD,CAAC;AACF,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;IACxC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AACD,eAAO,MAAM,WAAW,UAAW,gBAAgB,mDAsClD,CAAC;AACF,wBAAgB,eAAe,4CAoE9B;AAED,eAAO,MAAM,iBAAiB,sEAgB7B,CAAC;AAEF,eAAO,MAAM,iBAAiB,sBAAsB,CAAC;AAErD,qBAEa,QAAS,SAAQ,QAAS,YAAW,YAAY;IAC5D;;;OAGG;IAEH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAEvB,EAAE,SAAkC;IACpC,IAAI,uEAAqB;IAGlC,IAAI,uBAA8B;IAGlC,eAAe,EAAE,GAAG,CAAa;IAEjC,aAAa,EAAE,gBAAgB,CAAC,OAAO,CAA0B;IACjE,UAAmB,SAAS,uBAA8B;IAC1D,SAAS,CAAC,iBAAiB,UAAQ;IACnC,QAAQ,CAAC,eAAe,EAAE,QAAQ,CAAyB;IAC3D,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;IAC9C,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;IAC5C,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IACtC,QAAQ,CAAC,gBAAgB,8EAAe;IACxC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,EAAE,oBAAoB,CAAC;gBAGrC,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,SAAS,EACR,iBAAiB,EAAE,iBAAiB,EACrC,gBAAgB,EAAE,gBAAgB,EACrC,aAAa,EAAE,aAAa,EAEnD,gBAAgB,EAAE,oBAAoB;IAcxC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAK;IAGrC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAK;IAE7B,YAAY,SAAU,QAAQ,UAGrC;IAGF,SAAS,CAAC,IAAI,IAAI,IAAI;IAkDtB,SAAS,CAAC,UAAU,EAAE,MAAM,IAAI,CAA2C;IAC3E,SAAS,CAAC,YAAY,IAAI,IAAI;IAqC9B;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,GAAG,MAAM,EAAE;IAgB3E;;;;OAIG;IACH,oBAAoB,CAClB,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,SAAS,GACf,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;IAUvD;;OAEG;IACH,yBAAyB,IAAI,KAAK,CAAC,cAAc,CAAC,WAAW,CAAC;IAS9D;;;;OAIG;IACH,oBAAoB,IAAI,QAAQ,GAAG,SAAS;IAI5C;;;;;OAKG;IACH,sBAAsB,UACb,gBAAgB,CAAC,WAAW,CAAC,QAC9B,QAAQ,GAAG,SAAS,KACvB,QAAQ,GAAG,QAAQ,GAAG,SAAS,KACjC,IAAI,CAsBL;IACF;;;OAGG;IACH,kBAAkB,SACV,QAAQ,GAAG,SAAS,SACnB,QAAQ,GAAG,SAAS,KAC1B,GAAG,CAKJ;IACF;;OAEG;IACH,SAAS,CAAC,OAAO,IAAI,IAAI;IAazB;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,kBAAkB,GAAG,SAAS;IAQ1D,qBAAqB;IAIrB;;;OAGG;IACH,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAInC;;OAEG;IACH,QAAQ,CAAC,YAAY,SAAU,YAAY,UAQzC;IAEF;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM,GAAG,SAAS;IAW9C,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAIpD;;OAEG;IACH,QAAQ,CAAC,MAAM,UAAW,gBAAgB,CAAC,WAAW,CAAC,UAA0B;IAEjF,SAAS,CAAC,YAAY,CACpB,OAAO,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,IAAI,GAC1C,MAAM,GAAG,SAAS;IAerB;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,IAAI;IAS9D;;;;;OAKG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;IAK5D;;;;;OAKG;IACH,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO;IAO1D;;;;OAIG;IACH,gBAAgB,CACd,cAAc,EAAE,QAAQ,GAAG,SAAS,EACpC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,GACnC,IAAI;IA+BP;;;;OAIG;IACH,mBAAmB,CACjB,IAAI,EAAE,QAAQ,GAAG,SAAS,EAC1B,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,GACnC,IAAI;IAKP;;;;;;;OAOG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,iBAAiB,GAAE,MAAM,EAAO,GAAG,MAAM;IAQnF;;;;OAIG;IACH,eAAe,CACb,QAAQ,EAAE,KAAK,CAAC,aAAa,EAC7B,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,GAAG,SAAS,GAChD,KAAK,CAAC,aAAa;IAgCtB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,IAAI,kBAAkB;IAIxD,0BAA0B,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAqBnD,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAIlC,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAIlC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAGzC;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,GAAG,KAAK,CAAC,aAAa,GAAG,SAAS;IAIlF;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,KAAK,CAAC,aAAa,GAAG,SAAS,GACrC,KAAK,CAAC,aAAa,GAAG,SAAS;IAalC;;;;;;OAMG;IACH,SAAS,CAAC,mBAAmB,CAC3B,IAAI,EAAE,QAAQ,EACd,KAAK,EAAE,SAAS,GACf,KAAK,CAAC,aAAa,GAAG,SAAS;IAKlC,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM;IAOlE;;;OAGG;IACH,SAAS,CAAC,2BAA2B,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAI9D;;;OAGG;IACH,SAAS,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM;IAwBnD;;;;OAIG;IAEH,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ;IAepE;;OAEG;IACH,UAAU,IAAI,MAAM;IAkBpB;;;OAGG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;CAcrC;AAED,MAAM,MAAM,iBAAiB,GAAG,SAAS,QAAQ,CAAC,kBAAkB,CAAC,EAAE,GAAG;IACxE,MAAM,EAAE,QAAQ,CAAC;CAClB,CAAC;AACF,yBAAiB,iBAAiB,CAAC;IACjC,SAAgB,QAAQ,CACtB,SAAS,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,EACvC,MAAM,EAAE,QAAQ,GACf,OAAO,CAET;IACD,SAAgB,SAAS,CACvB,SAAS,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,GACtC,QAAQ,GAAG,SAAS,CAEtB;IACD,SAAgB,EAAE,CAChB,SAAS,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,GACtC,SAAS,IAAI,iBAAiB,CAOhC;IACD,SAAgB,MAAM,CAAC,MAAM,EAAE,QAAQ,GAAG,iBAAiB,CAE1D;CACF"}