@gingkoo/pandora-explorer 0.0.1-alpha.0

package/lib/es/components/tree/components/interface.d.ts

@@ -0,0 +1,123 @@
+import * as React from 'react';
+export type { ScrollTo } from 'rc-virtual-list/lib/List';
+export interface TreeNodeProps<TreeDataType extends BasicDataNode = DataNode> {
+    eventKey?: Key;
+    prefixCls?: string;
+    className?: string;
+    style?: React.CSSProperties;
+    id?: string;
+    expanded?: boolean;
+    selected?: boolean;
+    checked?: boolean;
+    loaded?: boolean;
+    loading?: boolean;
+    halfChecked?: boolean;
+    title?: React.ReactNode | ((data: TreeDataType) => React.ReactNode);
+    dragOver?: boolean;
+    dragOverGapTop?: boolean;
+    dragOverGapBottom?: boolean;
+    pos?: string;
+    domRef?: React.Ref<HTMLDivElement>;
+    /** New added in Tree for easy data access */
+    data?: TreeDataType;
+    isStart?: boolean[];
+    isEnd?: boolean[];
+    active?: boolean;
+    onMouseMove?: React.MouseEventHandler<HTMLDivElement>;
+    indentWidth?: number;
+    isLeaf?: boolean;
+    checkable?: boolean;
+    selectable?: boolean;
+    disabled?: boolean;
+    disableCheckbox?: boolean;
+    icon?: IconType;
+    switcherIcon?: IconType;
+    children?: React.ReactNode;
+}
+/** For fieldNames, we provides a abstract interface */
+export interface BasicDataNode {
+    checkable?: boolean;
+    disabled?: boolean;
+    disableCheckbox?: boolean;
+    icon?: IconType;
+    isLeaf?: boolean;
+    selectable?: boolean;
+    switcherIcon?: IconType;
+    /** Set style of TreeNode. This is not recommend if you don't have any force requirement */
+    className?: string;
+    style?: React.CSSProperties;
+}
+/** Provide a wrap type define for developer to wrap with customize fieldNames data type */
+export type FieldDataNode<T, ChildFieldName extends string = 'children'> = BasicDataNode & T & Partial<Record<ChildFieldName, FieldDataNode<T, ChildFieldName>[]>>;
+export type Key = React.Key;
+/**
+ * Typescript not support `bigint` as index type yet.
+ * We use this to mark the `bigint` type is for `Key` usage.
+ * It's safe to remove this when typescript fix:
+ * https://github.com/microsoft/TypeScript/issues/50217
+ */
+export type SafeKey = Exclude<Key, bigint>;
+export type KeyEntities<DateType extends BasicDataNode = any> = Record<SafeKey, DataEntity<DateType>>;
+export type DataNode = FieldDataNode<{
+    key: Key;
+    title?: React.ReactNode | ((data: DataNode) => React.ReactNode);
+}>;
+export type EventDataNode<TreeDataType> = {
+    key: Key;
+    expanded: boolean;
+    selected: boolean;
+    checked: boolean;
+    loaded: boolean;
+    loading: boolean;
+    halfChecked: boolean;
+    dragOver: boolean;
+    dragOverGapTop: boolean;
+    dragOverGapBottom: boolean;
+    pos: string;
+    active: boolean;
+} & TreeDataType & BasicDataNode;
+export type IconType = React.ReactNode | ((props: TreeNodeProps) => React.ReactNode);
+export type NodeElement = React.ReactElement<TreeNodeProps> & {
+    selectHandle?: HTMLSpanElement;
+    type: {
+        isTreeNode: boolean;
+    };
+};
+export type NodeInstance<TreeDataType extends BasicDataNode = DataNode> = React.Component<TreeNodeProps<TreeDataType>> & {
+    selectHandle?: HTMLSpanElement;
+};
+export interface Entity {
+    node: NodeElement;
+    index: number;
+    key: Key;
+    pos: string;
+    parent?: Entity;
+    children?: Entity[];
+}
+export interface DataEntity<TreeDataType extends BasicDataNode = DataNode> extends Omit<Entity, 'node' | 'parent' | 'children'> {
+    node: TreeDataType;
+    nodes: TreeDataType[];
+    parent?: DataEntity<TreeDataType>;
+    children?: DataEntity<TreeDataType>[];
+    level: number;
+}
+export interface FlattenNode<TreeDataType extends BasicDataNode = DataNode> {
+    parent: FlattenNode<TreeDataType> | null;
+    children: FlattenNode<TreeDataType>[];
+    pos: string;
+    data: TreeDataType;
+    title: React.ReactNode;
+    key: Key;
+    isStart: boolean[];
+    isEnd: boolean[];
+}
+export type GetKey<RecordType> = (record: RecordType, index?: number) => Key;
+export type GetCheckDisabled<RecordType> = (record: RecordType) => boolean;
+export type Direction = 'ltr' | 'rtl' | undefined;
+export interface FieldNames {
+    title?: string;
+    /** @private Internal usage for `rc-tree-select`, safe to remove if no need */
+    _title?: string[];
+    key?: string;
+    children?: string;
+}

package/lib/es/components/tree/components/useUnmount.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Trigger only when component unmount
+ */
+export default function useUnmount(triggerStart: VoidFunction, triggerEnd: VoidFunction): void;

package/lib/es/components/tree/components/util.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Legacy code. Should avoid to use if you are new to import these code.
+ */
+import React from 'react';
+import { BasicDataNode, DataEntity, DataNode, Direction, FlattenNode, Key, KeyEntities, NodeElement, NodeInstance } from './interface';
+import { AllowDrop, TreeProps } from './Tree';
+export { getPosition, isTreeNode } from './utils/treeUtil';
+export declare function arrDel(list: Key[], value: Key): React.Key[];
+export declare function arrAdd(list: Key[], value: Key): React.Key[];
+export declare function posToArr(pos: string): string[];
+export declare function getDragChildrenKeys<TreeDataType extends BasicDataNode = DataNode>(dragNodeKey: Key, keyEntities: KeyEntities<TreeDataType>): Key[];
+export declare function isLastChild<TreeDataType extends BasicDataNode = DataNode>(treeNodeEntity: DataEntity<TreeDataType>): boolean;
+export declare function isFirstChild<TreeDataType extends BasicDataNode = DataNode>(treeNodeEntity: DataEntity<TreeDataType>): boolean;
+export declare function calcDropPosition<TreeDataType extends BasicDataNode = DataNode>(event: React.MouseEvent, dragNode: NodeInstance<TreeDataType>, targetNode: NodeInstance<TreeDataType>, indent: number, startMousePosition: {
+    x: number;
+    y: number;
+}, allowDrop: AllowDrop<TreeDataType>, flattenedNodes: FlattenNode<TreeDataType>[], keyEntities: KeyEntities<TreeDataType>, expandKeys: Key[], direction: Direction): {
+    dropPosition: -1 | 0 | 1;
+    dropLevelOffset: number;
+    dropTargetKey: Key;
+    dropTargetPos: string;
+    dropContainerKey: Key;
+    dragOverNodeKey: Key;
+    dropAllowed: boolean;
+};
+/**
+ * Return selectedKeys according with multiple prop
+ * @param selectedKeys
+ * @param props
+ * @returns [string]
+ */
+export declare function calcSelectedKeys(selectedKeys: Key[], props: TreeProps): React.Key[] | undefined;
+export declare function convertDataToTree(treeData: DataNode[], processor?: {
+    processProps: (prop: DataNode) => any;
+}): NodeElement[];
+/**
+ * Parse `checkedKeys` to { checkedKeys, halfCheckedKeys } style
+ */
+export declare function parseCheckedKeys(keys: Key[] | {
+    checked: Key[];
+    halfChecked: Key[];
+}): {
+    checkedKeys: React.Key[];
+    halfCheckedKeys: undefined;
+} | {
+    checkedKeys: React.Key[];
+    halfCheckedKeys: React.Key[];
+} | null;
+/**
+ * If user use `autoExpandParent` we should get the list of parent node
+ * @param keyList
+ * @param keyEntities
+ */
+export declare function conductExpandParent(keyList: Key[], keyEntities: KeyEntities): Key[];

package/lib/es/components/tree/components/utils/conductUtil.d.ts

@@ -0,0 +1,17 @@
+import { BasicDataNode, DataNode, GetCheckDisabled, Key, KeyEntities } from '../interface';
+interface ConductReturnType {
+    checkedKeys: Key[];
+    halfCheckedKeys: Key[];
+}
+export declare function isCheckDisabled<TreeDataType>(node: TreeDataType): boolean;
+/**
+ * Conduct with keys.
+ * @param keyList current key list
+ * @param keyEntities key - dataEntity map
+ * @param mode `fill` to fill missing key, `clean` to remove useless key
+ */
+export declare function conductCheck<TreeDataType extends BasicDataNode = DataNode>(keyList: Key[], checked: true | {
+    checked: false;
+    halfCheckedKeys: Key[];
+}, keyEntities: KeyEntities<TreeDataType>, getCheckDisabled?: GetCheckDisabled<TreeDataType>): ConductReturnType;
+export {};

package/lib/es/components/tree/components/utils/diffUtil.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { Key, FlattenNode } from '../interface';
+export declare function findExpandedKeys(prev?: Key[], next?: Key[]): {
+    add: boolean;
+    key: import("react").Key | null;
+};
+export declare function getExpandRange(shorter: FlattenNode[], longer: FlattenNode[], key: Key): FlattenNode<import("../interface").DataNode>[];

package/lib/es/components/tree/components/utils/keyUtil.d.ts

@@ -0,0 +1,2 @@
+import type { Key, KeyEntities } from '../interface';
+export default function getEntity<T = any>(keyEntities: KeyEntities<T>, key: Key): import("../interface").DataEntity<T>;

package/lib/es/components/tree/components/utils/treeUtil.d.ts

@@ -0,0 +1,86 @@
+import * as React from 'react';
+import { BasicDataNode, DataEntity, DataNode, EventDataNode, FieldNames, FlattenNode, GetKey, Key, KeyEntities, NodeElement, TreeNodeProps } from '../interface';
+export declare function getPosition(level: string | number, index: number): string;
+export declare function isTreeNode(node: NodeElement): boolean;
+export declare function getKey(key: Key, pos: string): React.Key;
+export declare function fillFieldNames(fieldNames?: FieldNames): Required<FieldNames>;
+/**
+ * Warning if TreeNode do not provides key
+ */
+export declare function warningWithoutKey(treeData: DataNode[], fieldNames: FieldNames): void;
+/**
+ * Convert `children` of Tree into `treeData` structure.
+ */
+export declare function convertTreeToData(rootNodes: React.ReactNode): DataNode[];
+/**
+ * Flat nest tree data into flatten list. This is used for virtual list render.
+ * @param treeNodeList Origin data node list
+ * @param expandedKeys
+ * need expanded keys, provides `true` means all expanded (used in `rc-tree-select`).
+ */
+export declare function flattenTreeData<TreeDataType extends BasicDataNode = DataNode>(treeNodeList: TreeDataType[], expandedKeys: Key[] | true, fieldNames: FieldNames): FlattenNode<TreeDataType>[];
+type ExternalGetKey = GetKey<DataNode> | string;
+interface TraverseDataNodesConfig {
+    childrenPropName?: string;
+    externalGetKey?: ExternalGetKey;
+    fieldNames?: FieldNames;
+}
+/**
+ * Traverse all the data by `treeData`.
+ * Please not use it out of the `rc-tree` since we may refactor this code.
+ */
+export declare function traverseDataNodes(dataNodes: DataNode[], callback: (data: {
+    node: DataNode;
+    index: number;
+    pos: string;
+    key: Key;
+    parentPos: string | number;
+    level: number;
+    nodes: DataNode[];
+}) => void, config?: TraverseDataNodesConfig | string): void;
+interface Wrapper {
+    posEntities: Record<string, DataEntity>;
+    keyEntities: KeyEntities;
+}
+/**
+ * Convert `treeData` into entity records.
+ */
+export declare function convertDataToEntities(dataNodes: DataNode[], { initWrapper, processEntity, onProcessFinished, externalGetKey, childrenPropName, fieldNames, }?: {
+    initWrapper?: (wrapper: Wrapper) => Wrapper;
+    processEntity?: (entity: DataEntity, wrapper: Wrapper) => void;
+    onProcessFinished?: (wrapper: Wrapper) => void;
+    externalGetKey?: ExternalGetKey;
+    childrenPropName?: string;
+    fieldNames?: FieldNames;
+}, 
+/** @deprecated Use `config.externalGetKey` instead */
+legacyExternalGetKey?: ExternalGetKey): Wrapper;
+export interface TreeNodeRequiredProps<TreeDataType extends BasicDataNode = DataNode> {
+    expandedKeys: Key[];
+    selectedKeys: Key[];
+    loadedKeys: Key[];
+    loadingKeys: Key[];
+    checkedKeys: Key[];
+    halfCheckedKeys: Key[];
+    dragOverNodeKey: Key;
+    dropPosition: number;
+    keyEntities: KeyEntities<TreeDataType>;
+}
+/**
+ * Get TreeNode props with Tree props.
+ */
+export declare function getTreeNodeProps<TreeDataType extends BasicDataNode = DataNode>(key: Key, { expandedKeys, selectedKeys, loadedKeys, loadingKeys, checkedKeys, halfCheckedKeys, dragOverNodeKey, dropPosition, keyEntities, }: TreeNodeRequiredProps<TreeDataType>): {
+    eventKey: React.Key;
+    expanded: boolean;
+    selected: boolean;
+    loaded: boolean;
+    loading: boolean;
+    checked: boolean;
+    halfChecked: boolean;
+    pos: string;
+    dragOver: boolean;
+    dragOverGapTop: boolean;
+    dragOverGapBottom: boolean;
+};
+export declare function convertNodePropsToEventData<TreeDataType extends BasicDataNode = DataNode>(props: TreeNodeProps<TreeDataType>): EventDataNode<TreeDataType>;
+export {};

package/lib/es/components/tree/index.d.ts

@@ -0,0 +1,39 @@
+import './index.less';
+import { ReactNode } from 'react';
+import { MenuItem } from '../menu';
+export interface TreeItem {
+    key: string;
+    title: string;
+    icon?: boolean;
+    suffix?: string;
+    api?: boolean;
+    level?: string;
+    menu?: string | (string | MenuItem)[];
+    children?: TreeItem[];
+    isLeaf?: boolean;
+    [key: string]: any;
+}
+export interface TreeProps {
+    type?: 'tree' | 'table';
+    treeData: TreeItem[];
+    showLine?: boolean;
+    height?: number | null;
+    isload?: boolean;
+    animation?: boolean;
+    defaultmenu?: 'basis' | 'file';
+    defaultExpandedKeys?: string[];
+    autoExpandParent?: boolean;
+    columns?: any[];
+    checks?: string[];
+    icon?: (v: any, className: string) => ReactNode;
+    onChecks?: (checks: string[], param?: TreeItem[]) => void;
+    onSelect?: (key: string) => any;
+    onChange?: (data: TreeItem[]) => void;
+    titleRender?: (props: any) => any;
+    onMenuClick?: (key: string, props: any) => void;
+    loadData?: (key: string) => Promise<TreeItem[]> | TreeItem[];
+    onRename?: (key: string, value: string, props?: TreeItem) => boolean | void;
+    [key: string]: any;
+}
+declare const _default: (props: TreeProps) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/lib/es/components/tree/tree-item-table.d.ts

@@ -0,0 +1 @@
+export default function TableItem(props: any): import("react/jsx-runtime").JSX.Element;

package/lib/es/components/tree/tree-item.d.ts

@@ -0,0 +1,3 @@
+import { TreeItem } from '.';
+declare const _default: (props: TreeItem) => import("react/jsx-runtime").JSX.Element;
+export default _default;

package/lib/es/components/virtualScroll/index.d.ts

@@ -0,0 +1,7 @@
+declare const VirtualScroll: ({ className, item, itemHeight, renderItem, }: {
+    className: string;
+    item: any[];
+    itemHeight: number;
+    renderItem: (v: any, i: number, end: boolean) => any;
+}) => import("react/jsx-runtime").JSX.Element;
+export default VirtualScroll;

package/lib/es/css.d.ts

@@ -0,0 +1,10 @@
+export declare const flush: () => void, hydrate: (ids: string[]) => void, cx: (...classNames: import("@emotion/css/create-instance").ClassNamesArg[]) => string, merge: (className: string) => string, getRegisteredStyles: (registeredStyles: string[], className: string) => string, injectGlobal: {
+    (template: TemplateStringsArray, ...args: import("@emotion/serialize").CSSInterpolation[]): void;
+    (...args: import("@emotion/serialize").CSSInterpolation[]): void;
+}, keyframes: {
+    (template: TemplateStringsArray, ...args: import("@emotion/serialize").CSSInterpolation[]): string;
+    (...args: import("@emotion/serialize").CSSInterpolation[]): string;
+}, css: {
+    (template: TemplateStringsArray, ...args: import("@emotion/serialize").CSSInterpolation[]): string;
+    (...args: import("@emotion/serialize").CSSInterpolation[]): string;
+}, sheet: import("@emotion/css/create-instance").CSSStyleSheet, cache: import("@emotion/utils").EmotionCache;

package/lib/es/enum.d.ts

@@ -0,0 +1,11 @@
+export declare const enum fileType {
+    'folder' = "folder",
+    'file' = "file"
+}
+export declare enum ApiStatusEnum {
+    READY = 1,
+    LOADING = 2,
+    ERROR = 3,
+    EMPTY = 4,
+    SUCCESS = 5
+}

package/lib/es/explorer.d.ts

@@ -0,0 +1,7 @@
+import './index.less';
+import './components/tree/css/index.less';
+import './static/css/index.css';
+import { FC } from 'react';
+import { ExplorerProps } from './types';
+declare const Explorer: FC<ExplorerProps>;
+export default Explorer;

package/lib/es/index.d.ts

@@ -0,0 +1,5 @@
+import Explorer from './explorer';
+export { registerMenu } from './components/menu/menulist';
+export * from './types';
+export * from './enum';
+export default Explorer;