react-arborist 1.1.0 → 2.0.0-rc

package/dist/components/default-container.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function DefaultContainer(): JSX.Element;

package/dist/components/default-cursor.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { DropCursorProps } from "../types/renderers";
+export declare const DefaultCursor: React.NamedExoticComponent<DropCursorProps>;

package/dist/components/default-drag-preview.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { DragPreviewProps } from "../types/renderers";
+export declare function DefaultDragPreview({ offset, mouse, id, dragIds, isDragging, }: DragPreviewProps): JSX.Element;

package/dist/components/default-node.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { NodeRendererProps } from "../types/renderers";
+import { IdObj } from "../types/utils";
+export declare function DefaultNode<T extends IdObj>({ style, node, dragHandle, }: NodeRendererProps<T>): JSX.Element;

package/dist/components/default-row.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { RowRendererProps } from "../types/renderers";
+import { IdObj } from "../types/utils";
+export declare function DefaultRow<T extends IdObj>({ node, attrs, innerRef, children, }: RowRendererProps<T>): JSX.Element;

package/dist/components/drag-preview-container.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function DragPreviewContainer(): JSX.Element;

package/dist/components/list-inner-element.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export declare const ListInnerElement: (props: any) => React.ReactElement<any, string | React.JSXElementConstructor<any>> | null;

package/dist/components/list-outer-element.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const ListOuterElement: (props: import("react").HTMLProps<HTMLDivElement> & import("react").RefAttributes<unknown>) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | null;

package/dist/components/outer-drop.d.ts

@@ -0,0 +1,4 @@
+import { ReactElement } from "react";
+export declare function OuterDrop(props: {
+    children: ReactElement;
+}): ReactElement<any, string | import("react").JSXElementConstructor<any>>;

package/dist/components/provider.d.ts

@@ -0,0 +1,11 @@
+import { ReactNode } from "react";
+import { TreeApi } from "../interfaces/tree-api";
+import { IdObj } from "../types/utils";
+import { TreeProps } from "../types/tree-props";
+declare type Props<T extends IdObj> = {
+    treeProps: TreeProps<T>;
+    imperativeHandle: React.Ref<TreeApi<T> | undefined>;
+    children: ReactNode;
+};
+export declare function TreeProvider<T extends IdObj>({ treeProps, imperativeHandle, children, }: Props<T>): JSX.Element;
+export {};

package/dist/components/row-container.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { IdObj } from "../types/utils";
+declare type Props = {
+    style: React.CSSProperties;
+    index: number;
+};
+export declare const RowContainer: React.MemoExoticComponent<(<T extends IdObj>({ index, style, }: Props) => JSX.Element)>;
+export {};

package/dist/components/tree-container.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function TreeContainer(): JSX.Element;

package/dist/components/tree.d.ts

@@ -1,4 +1,5 @@
-import { ReactElement } from "react";
-import { TreeApi } from "../tree-api";
-import { IdObj, TreeProps } from "../types";
-export declare const Tree: <T extends IdObj>(props: TreeProps<T> & import("react").RefAttributes<TreeApi<T>>) => ReactElement<any, string | import("react").JSXElementConstructor<any>> | null;
+/// <reference types="react" />
+import { TreeApi } from "../interfaces/tree-api";
+import { TreeProps } from "../types/tree-props";
+import { IdObj } from "../types/utils";
+export declare const Tree: <T extends IdObj>(props: TreeProps<T> & import("react").RefAttributes<TreeApi<T> | undefined>) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | null;

package/dist/context.d.ts

@@ -1,18 +1,23 @@
-/// <reference types="react" />
-import { Cursor } from "./dnd/compute-drop";
-import { IdObj, SelectionState, StaticContext } from "./types";
-export declare const CursorParentId: import("react").Context<string | null>;
-export declare function useCursorParentId(): string | null;
-export declare const IsCursorOverFolder: import("react").Context<boolean>;
-export declare function useIsCursorOverFolder(): boolean;
-export declare const CursorLocationContext: import("react").Context<Cursor | null>;
-export declare function useCursorLocation(): Cursor | null;
-export declare const Static: import("react").Context<StaticContext<IdObj> | null>;
-export declare function useStaticContext(): StaticContext<IdObj>;
-export declare const DispatchContext: import("react").Context<null>;
-export declare function useDispatch(): never;
-export declare const SelectionContext: import("react").Context<SelectionState | null>;
-export declare function useSelectedIds(): string[];
-export declare function useIsSelected(): (index: number | null) => boolean;
-export declare const EditingIdContext: import("react").Context<string | null>;
-export declare function useEditingId(): string | null;
+import React from "react";
+import { TreeApi } from "./interfaces/tree-api";
+import { IdObj } from "./types/utils";
+export declare const TreeApiContext: React.Context<TreeApi<any> | null>;
+export declare function useTreeApi<T extends IdObj>(): TreeApi<T>;
+export declare const NodesContext: React.Context<import("redux").CombinedState<{
+    focus: import("./state/focus-slice").FocusState;
+    edit: import("./state/edit-slice").EditState;
+    open: import("./state/open-slice").OpenSlice;
+    selection: import("./state/selection-slice").SelectionState;
+    drag: import("./state/drag-slice").DragSlice;
+}> | null>;
+export declare function useNodesContext(): import("redux").CombinedState<{
+    focus: import("./state/focus-slice").FocusState;
+    edit: import("./state/edit-slice").EditState;
+    open: import("./state/open-slice").OpenSlice;
+    selection: import("./state/selection-slice").SelectionState;
+    drag: import("./state/drag-slice").DragSlice;
+}>;
+export declare const DndContext: React.Context<import("./state/dnd-slice").DndState | null>;
+export declare function useDndContext(): import("./state/dnd-slice").DndState;
+export declare const DataUpdatesContext: React.Context<number>;
+export declare function useDataUpdates(): void;

package/dist/data/create-index.d.ts

@@ -0,0 +1,5 @@
+import { NodeApi } from "../interfaces/node-api";
+import { IdObj } from "../types/utils";
+export declare const createIndex: <T extends IdObj>(nodes: NodeApi<T>[]) => {
+    [id: string]: number;
+};

package/dist/data/create-list.d.ts

@@ -0,0 +1,4 @@
+import { NodeApi } from "../interfaces/node-api";
+import { TreeApi } from "../interfaces/tree-api";
+import { IdObj } from "../types/utils";
+export declare function createList<T extends IdObj>(tree: TreeApi<T>): NodeApi<T>[];

package/dist/data/create-root.d.ts

@@ -0,0 +1,5 @@
+import { IdObj } from "../types/utils";
+import { NodeApi } from "../interfaces/node-api";
+import { TreeApi } from "../interfaces/tree-api";
+export declare const ROOT_ID = "__REACT_ARBORIST_INTERNAL_ROOT__";
+export declare function createRoot<T extends IdObj>(tree: TreeApi<T>): NodeApi<T>;

package/dist/data/flatten-tree.d.ts

@@ -1,2 +1,4 @@
-import { Node } from "../types";
-export declare function flattenTree<T>(root: Node<T>): Node<T>[];
+import { NodeApi } from "../interfaces/node-api";
+import { IdObj } from "../types/utils";
+export declare function flattenTree<T extends IdObj>(root: NodeApi<T>): NodeApi<T>[];
+export declare function filterTree<T extends IdObj>(root: NodeApi<T>, isMatch: (n: NodeApi<T>) => boolean): NodeApi<T>[];

package/dist/data/simple-tree.d.ts

@@ -0,0 +1,43 @@
+declare type IdObj = {
+    id: string;
+    children?: IdObj[];
+};
+export declare class SimpleTree<T extends IdObj> {
+    root: SimpleNode<T>;
+    constructor(data: T[]);
+    get data(): T[];
+    create(args: {
+        parentId: string | null;
+        index: number;
+        data: T;
+    }): null | undefined;
+    move(args: {
+        id: string;
+        parentId: string | null;
+        index: number;
+    }): void;
+    update(args: {
+        id: string;
+        changes: Partial<T>;
+    }): void;
+    drop(args: {
+        id: string;
+    }): void;
+    find(id: string, node?: SimpleNode<T>): SimpleNode<T> | null;
+}
+declare class SimpleNode<T extends IdObj> {
+    data: T;
+    parent: SimpleNode<T> | null;
+    id: string;
+    children?: SimpleNode<T>[];
+    constructor(data: T, parent: SimpleNode<T> | null);
+    hasParent(): this is this & {
+        parent: SimpleNode<T>;
+    };
+    get childIndex(): number;
+    addChild(data: T, index: number): void;
+    removeChild(index: number): void;
+    update(changes: Partial<T>): void;
+    drop(): void;
+}
+export {};

package/dist/dnd/compute-drop.d.ts

@@ -1,13 +1,13 @@
 import { XYCoord } from "react-dnd";
-import { Node } from "../types";
+import { NodeApi } from "../interfaces/node-api";
 import { DropResult } from "./drop-hook";
 declare type Args = {
     element: HTMLElement;
     offset: XYCoord;
     indent: number;
-    node: Node | null;
-    prevNode: Node | null;
-    nextNode: Node | null;
+    node: NodeApi | null;
+    prevNode: NodeApi | null;
+    nextNode: NodeApi | null;
 };
 export declare type ComputedDrop = {
     drop: DropResult | null;

package/dist/dnd/drag-hook.d.ts

@@ -1,5 +1,4 @@
 import { ConnectDragSource } from "react-dnd";
-import { Node } from "../types";
-export declare function useDragHook(node: Node): [{
-    isDragging: boolean;
-}, ConnectDragSource];
+import { NodeApi } from "../interfaces/node-api";
+import { IdObj } from "../types/utils";
+export declare function useDragHook<T extends IdObj>(node: NodeApi<T>): ConnectDragSource;

package/dist/dnd/drop-hook.d.ts

@@ -1,9 +1,8 @@
 import { RefObject } from "react";
 import { ConnectDropTarget } from "react-dnd";
-import { Node } from "../types";
+import { NodeApi } from "../interfaces/node-api";
 export declare type DropResult = {
     parentId: string | null;
     index: number;
 };
-export declare type CollectedProps = undefined;
-export declare function useDropHook(el: RefObject<HTMLElement | null>, node: Node, prev: Node | null, next: Node | null): [CollectedProps, ConnectDropTarget];
+export declare function useDropHook(el: RefObject<HTMLElement | null>, node: NodeApi<any>): ConnectDropTarget;

package/dist/hooks/use-fresh-node.d.ts

@@ -0,0 +1,2 @@
+import { IdObj } from "../types/utils";
+export declare function useFreshNode<T extends IdObj>(index: number): import("..").NodeApi<T>;

package/dist/hooks/use-simple-tree.d.ts

@@ -0,0 +1,13 @@
+import { CreateHandler, DeleteHandler, MoveHandler, RenameHandler } from "../types/handlers";
+import { IdObj } from "../types/utils";
+export declare type SimpleTreeData = {
+    id: string;
+    name: string;
+    children?: SimpleTreeData[];
+};
+export declare function useSimpleTree<T extends IdObj>(initialData: T[]): readonly [T[], {
+    onMove: MoveHandler;
+    onRename: RenameHandler;
+    onCreate: CreateHandler;
+    onDelete: DeleteHandler;
+}];

package/dist/hooks/use-uncontrolled-tree.d.ts

@@ -0,0 +1,24 @@
+declare type Data = {
+    id: string;
+    name: string;
+    children?: Data[];
+};
+export declare function useUncontrolledTree(initialData: Data[]): readonly [Data[], {
+    move: (args: {
+        dragIds: string[];
+        parentId: string;
+        index: number;
+    }) => void;
+    rename: (args: {
+        id: string;
+        name: string;
+    }) => void;
+    create: ({ parentId, index }: {
+        parentId: string;
+        index: number;
+    }) => Data;
+    drop: (args: {
+        id: string;
+    }) => void;
+}];
+export {};

package/dist/hooks/use-validated-props.d.ts

@@ -0,0 +1,3 @@
+import { TreeProps } from "../types/tree-props";
+import { IdObj } from "../types/utils";
+export declare function useValidatedProps<T extends IdObj>(props: TreeProps<T>): TreeProps<T>;

package/dist/index.d.ts

@@ -1,4 +1,8 @@
-import { Tree } from "./components/tree";
-import { TreeApi } from "./tree-api";
-import type { NodeRenderer, NodeState, NodeHandlers } from "./types";
-export { Tree, TreeApi, NodeRenderer, NodeState, NodeHandlers };
+export { Tree } from "./components/tree";
+export * from "./types/handlers";
+export * from "./types/renderers";
+export * from "./types/state";
+export * from "./interfaces/node-api";
+export * from "./interfaces/tree-api";
+export * from "./data/simple-tree";
+export * from "./hooks/use-simple-tree";