@excalidraw/excalidraw 0.15.2-45a57d7 → 0.15.2-6213-0f92339

package/types/components/Sidebar/Sidebar.d.ts

@@ -1,11 +1,14 @@
-/// <reference types="react" />
+import React from "react";
 import "./Sidebar.scss";
-/** using a counter instead of boolean to handle race conditions where
- * the host app may render (mount/unmount) multiple different sidebar */
-export declare const hostSidebarCountersAtom: import("jotai").Atom<{
-    rendered: number;
-    docked: number;
-}> & {
+/**
+ * Flags whether the currently rendered Sidebar is docked or not, for use
+ * in upstream components that need to act on this (e.g. LayerUI to shift the
+ * UI). We use an atom because of potential host app sidebars (for the default
+ * sidebar we could just read from appState.defaultSidebarDockedPreference).
+ *
+ * Since we can only render one Sidebar at a time, we can use a simple flag.
+ */
+export declare const isSidebarDockedAtom: import("jotai").Atom<boolean> & {
     write: (get: {
         <Value>(atom: import("jotai").Atom<Value | Promise<Value>>): Value;
         <Value_1>(atom: import("jotai").Atom<Promise<Value_1>>): Value_1;
@@ -23,51 +26,71 @@ export declare const hostSidebarCountersAtom: import("jotai").Atom<{
     }, set: {
         <Value_6, Result extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_6, undefined, Result>): Result;
         <Value_7, Update, Result_1 extends void | Promise<void>>(atom: import("jotai").WritableAtom<Value_7, Update, Result_1>, update: Update): Result_1;
-    }, update: {
-        rendered: number;
-        docked: number;
-    } | ((prev: {
-        rendered: number;
-        docked: number;
-    }) => {
-        rendered: number;
-        docked: number;
-    })) => void;
-    onMount?: (<S extends (update: {
-        rendered: number;
-        docked: number;
-    } | ((prev: {
-        rendered: number;
-        docked: number;
-    }) => {
-        rendered: number;
-        docked: number;
-    })) => void>(setAtom: S) => void | (() => void)) | undefined;
+    }, update: boolean | ((prev: boolean) => boolean)) => void;
+    onMount?: (<S extends (update: boolean | ((prev: boolean) => boolean)) => void>(setAtom: S) => void | (() => void)) | undefined;
 } & {
-    init: {
-        rendered: number;
-        docked: number;
-    };
+    init: boolean;
 };
-export declare const Sidebar: import("react").ForwardRefExoticComponent<{
-    children: import("react").ReactNode;
-    onClose?: (() => boolean | void) | undefined;
+export declare const SidebarInner: React.ForwardRefExoticComponent<Pick<{
+    name: string;
+    children: React.ReactNode;
+    onStateChange?: ((state: {
+        name: string;
+        tab?: string | undefined;
+    } | null) => void) | undefined;
     onDock?: ((docked: boolean) => void) | undefined;
     docked?: boolean | undefined;
-    initialDockedState?: boolean | undefined;
-    dockable?: boolean | undefined;
     className?: string | undefined;
-} & {
-    /** @private internal */
-    __isInternal?: boolean | undefined;
-} & import("react").RefAttributes<HTMLDivElement>> & {
+    __fallback?: boolean | undefined;
+} & Omit<React.RefAttributes<HTMLDivElement>, "onSelect">, "className" | "name" | "children" | "key" | "onDock" | "docked" | "onStateChange" | "__fallback"> & React.RefAttributes<HTMLDivElement>>;
+export declare const Sidebar: React.ForwardRefExoticComponent<{
+    name: string;
+    children: React.ReactNode;
+    onStateChange?: ((state: {
+        name: string;
+        tab?: string | undefined;
+    } | null) => void) | undefined;
+    onDock?: ((docked: boolean) => void) | undefined;
+    docked?: boolean | undefined;
+    className?: string | undefined;
+    __fallback?: boolean | undefined;
+} & React.RefAttributes<HTMLDivElement>> & {
     Header: {
-        (props: {
-            children?: import("react").ReactNode;
+        ({ children, className, }: {
+            children?: React.ReactNode;
             className?: string | undefined;
-        } & {
-            __isFallback?: boolean | undefined;
-        }): JSX.Element | null;
+        }): JSX.Element;
+        displayName: string;
+    };
+    TabTriggers: {
+        ({ children, ...rest }: {
+            children: React.ReactNode;
+        } & Omit<React.RefAttributes<HTMLDivElement>, "onSelect">): JSX.Element;
+        displayName: string;
+    };
+    TabTrigger: {
+        ({ children, tab, onSelect, ...rest }: {
+            children: React.ReactNode;
+            tab: string;
+            onSelect?: React.ReactEventHandler<HTMLButtonElement> | undefined;
+        } & Omit<React.HTMLAttributes<HTMLButtonElement>, "onSelect">): JSX.Element;
+        displayName: string;
+    };
+    Tabs: {
+        ({ children, ...rest }: {
+            children: React.ReactNode;
+        } & Omit<React.RefAttributes<HTMLDivElement>, "onSelect">): JSX.Element | null;
+        displayName: string;
+    };
+    Tab: {
+        ({ tab, children, ...rest }: {
+            tab: string;
+            children: React.ReactNode;
+        } & React.HTMLAttributes<HTMLDivElement>): JSX.Element;
+        displayName: string;
+    };
+    Trigger: {
+        ({ name, tab, icon, title, children, onToggle, className, style, }: import("./common").SidebarTriggerProps): JSX.Element;
         displayName: string;
     };
 };

package/types/components/Sidebar/SidebarHeader.d.ts

@@ -1,20 +1,7 @@
-/// <reference types="react" />
-export declare const SidebarDockButton: (props: {
-    checked: boolean;
-    onChange?(): void;
-}) => JSX.Element;
-/** @private */
-export declare const SidebarHeaderComponents: {
-    Context: import("react").FC<{
-        children: import("react").ReactNode;
-    }>;
-    Component: {
-        (props: {
-            children?: React.ReactNode;
-            className?: string | undefined;
-        } & {
-            __isFallback?: boolean | undefined;
-        }): JSX.Element | null;
-        displayName: string;
-    };
+export declare const SidebarHeader: {
+    ({ children, className, }: {
+        children?: React.ReactNode;
+        className?: string | undefined;
+    }): JSX.Element;
+    displayName: string;
 };

package/types/components/Sidebar/SidebarTab.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { SidebarTabName } from "../../types";
+export declare const SidebarTab: {
+    ({ tab, children, ...rest }: {
+        tab: SidebarTabName;
+        children: React.ReactNode;
+    } & import("react").HTMLAttributes<HTMLDivElement>): JSX.Element;
+    displayName: string;
+};

package/types/components/Sidebar/SidebarTabTrigger.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { SidebarTabName } from "../../types";
+export declare const SidebarTabTrigger: {
+    ({ children, tab, onSelect, ...rest }: {
+        children: React.ReactNode;
+        tab: SidebarTabName;
+        onSelect?: React.ReactEventHandler<HTMLButtonElement> | undefined;
+    } & Omit<import("react").HTMLAttributes<HTMLButtonElement>, "onSelect">): JSX.Element;
+    displayName: string;
+};

package/types/components/Sidebar/SidebarTabTriggers.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export declare const SidebarTabTriggers: {
+    ({ children, ...rest }: {
+        children: React.ReactNode;
+    } & Omit<import("react").RefAttributes<HTMLDivElement>, "onSelect">): JSX.Element;
+    displayName: string;
+};

package/types/components/Sidebar/SidebarTabs.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+export declare const SidebarTabs: {
+    ({ children, ...rest }: {
+        children: React.ReactNode;
+    } & Omit<import("react").RefAttributes<HTMLDivElement>, "onSelect">): JSX.Element | null;
+    displayName: string;
+};

package/types/components/Sidebar/SidebarTrigger.d.ts

@@ -0,0 +1,6 @@
+import { SidebarTriggerProps } from "./common";
+import "./SidebarTrigger.scss";
+export declare const SidebarTrigger: {
+    ({ name, tab, icon, title, children, onToggle, className, style, }: SidebarTriggerProps): JSX.Element;
+    displayName: string;
+};

package/types/components/Sidebar/common.d.ts

@@ -1,16 +1,33 @@
 import React from "react";
+import { AppState, SidebarName, SidebarTabName } from "../../types";
+export declare type SidebarTriggerProps = {
+    name: SidebarName;
+    tab?: SidebarTabName;
+    icon?: JSX.Element;
+    children?: React.ReactNode;
+    title?: string;
+    className?: string;
+    onToggle?: (open: boolean) => void;
+    style?: React.CSSProperties;
+};
 export declare type SidebarProps<P = {}> = {
+    name: SidebarName;
     children: React.ReactNode;
     /**
-     * Called on sidebar close (either by user action or by the editor).
+     * Called on sidebar open/close or tab change.
+     */
+    onStateChange?: (state: AppState["openSidebar"]) => void;
+    /**
+     * supply alongside `docked` prop in order to make the Sidebar user-dockable
      */
-    onClose?: () => void | boolean;
-    /** if not supplied, sidebar won't be dockable */
     onDock?: (docked: boolean) => void;
     docked?: boolean;
-    initialDockedState?: boolean;
-    dockable?: boolean;
     className?: string;
+    /** @private internal */
+    __fallback?: boolean;
 } & P;
-export declare type SidebarPropsContextValue = Pick<SidebarProps, "onClose" | "onDock" | "docked" | "dockable">;
+export declare type SidebarPropsContextValue = Pick<SidebarProps, "onDock" | "docked"> & {
+    onCloseRequest: () => void;
+    shouldRenderDockButton: boolean;
+};
 export declare const SidebarPropsContext: React.Context<SidebarPropsContextValue>;

package/types/components/main-menu/MainMenu.d.ts

@@ -7,7 +7,9 @@ declare const MainMenu: React.FC<{
      */
     onSelect?: ((event: Event) => void) | undefined;
 } & {
-    __fallback?: boolean | undefined;
+    __fallback?: boolean | undefined; /**
+     * Called when any menu item is selected (clicked on).
+     */
 }> & {
     Trigger: {
         ({ className, children, onToggle, }: {

package/types/constants.d.ts

@@ -184,3 +184,8 @@ export declare const DEFAULT_ELEMENT_PROPS: {
     opacity: ExcalidrawElement["opacity"];
     locked: ExcalidrawElement["locked"];
 };
+export declare const LIBRARY_SIDEBAR_TAB = "library";
+export declare const DEFAULT_SIDEBAR: {
+    readonly name: "default";
+    readonly defaultTab: "library";
+};

package/types/context/tunnels.d.ts

@@ -0,0 +1,18 @@
+import React from "react";
+import tunnel from "tunnel-rat";
+export declare type Tunnel = ReturnType<typeof tunnel>;
+declare type TunnelsContextValue = {
+    MainMenuTunnel: Tunnel;
+    WelcomeScreenMenuHintTunnel: Tunnel;
+    WelcomeScreenToolbarHintTunnel: Tunnel;
+    WelcomeScreenHelpHintTunnel: Tunnel;
+    WelcomeScreenCenterTunnel: Tunnel;
+    FooterCenterTunnel: Tunnel;
+    DefaultSidebarTriggerTunnel: Tunnel;
+    DefaultSidebarTabTriggersTunnel: Tunnel;
+    jotaiScope: symbol;
+};
+export declare const TunnelsContext: React.Context<TunnelsContextValue>;
+export declare const useTunnels: () => TunnelsContextValue;
+export declare const useInitializeTunnels: () => TunnelsContextValue;
+export {};

package/types/context/ui-appState.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+import { AppState } from "../types";
+export declare const UIAppStateContext: React.Context<AppState>;
+export declare const useUIAppState: () => AppState;

package/types/data/types.d.ts

@@ -18,10 +18,8 @@ export interface ExportedDataState {
  * Don't consume on its own.
  */
 export declare type LegacyAppState = {
-    /** @deprecated #5663 TODO remove 22-12-15 */
-    isLibraryOpen: [boolean, "openSidebar"];
-    /** @deprecated #5663 TODO remove 22-12-15 */
-    isLibraryMenuDocked: [boolean, "isSidebarDocked"];
+    /** @deprecated #6213 TODO remove 23-06-01 */
+    isSidebarDocked: [boolean, "defaultSidebarDockedPreference"];
 };
 export interface ImportedDataState {
     type?: string;

package/types/element/Hyperlink.d.ts

@@ -76,9 +76,12 @@ export declare const actionLink: {
                 value: import("../types").NormalizedZoomValue;
             }>;
             openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-            openSidebar: "library" | "customSidebar" | null;
+            openSidebar: {
+                name: string;
+                tab?: string | undefined;
+            } | null;
             openDialog: "imageExport" | "help" | "jsonExport" | null;
-            isSidebarDocked: boolean;
+            defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("./types").PointerType;
             selectedElementIds: {
                 [id: string]: boolean;

package/types/element/linearElementEditor.d.ts

@@ -181,9 +181,12 @@ export declare class LinearElementEditor {
             }>;
             openMenu: "canvas" | "shape" | null;
             openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-            openSidebar: "library" | "customSidebar" | null;
+            openSidebar: {
+                name: string;
+                tab?: string | undefined;
+            } | null;
             openDialog: "imageExport" | "help" | "jsonExport" | null;
-            isSidebarDocked: boolean;
+            defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("./types").PointerType;
             selectedElementIds: {
                 [id: string]: boolean;

package/types/hooks/useOutsideClick.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="react" />
-export declare const useOutsideClickHook: (handler: (event: Event) => void) => import("react").MutableRefObject<null>;
+export declare const useOutsideClick: (handler: (event: Event) => void) => import("react").MutableRefObject<null>;

package/types/packages/excalidraw/index.d.ts

@@ -24,3 +24,4 @@ export { MainMenu };
 export { useDevice } from "../../components/App";
 export { WelcomeScreen };
 export { LiveCollaborationTrigger };
+export { DefaultSidebar } from "../../components/DefaultSidebar";

package/types/types.d.ts

@@ -63,6 +63,8 @@ export declare type LastActiveTool = {
     type: "custom";
     customType: string;
 } | null;
+export declare type SidebarName = string;
+export declare type SidebarTabName = string;
 export declare type AppState = {
     contextMenu: {
         items: ContextMenuItems;
@@ -125,9 +127,19 @@ export declare type AppState = {
     zoom: Zoom;
     openMenu: "canvas" | "shape" | null;
     openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-    openSidebar: "library" | "customSidebar" | null;
+    openSidebar: {
+        name: SidebarName;
+        tab?: SidebarTabName;
+    } | null;
     openDialog: "imageExport" | "help" | "jsonExport" | null;
-    isSidebarDocked: boolean;
+    /**
+     * Reflects user preference for whether the default sidebar should be docked.
+     *
+     * NOTE this is only a user preference and does not reflect the actual docked
+     * state of the sidebar, because the host apps can override this through
+     * a DefaultSidebar prop, which is not reflected back to the appState.
+     */
+    defaultSidebarDockedPreference: boolean;
     lastPointerDownWith: PointerType;
     selectedElementIds: {
         [id: string]: boolean;
@@ -253,10 +265,6 @@ export interface ExcalidrawProps {
     }>) => void;
     onPointerDown?: (activeTool: AppState["activeTool"], pointerDownState: PointerDownState) => void;
     onScrollChange?: (scrollX: number, scrollY: number) => void;
-    /**
-     * Render function that renders custom <Sidebar /> component.
-     */
-    renderSidebar?: () => JSX.Element | null;
     children?: React.ReactNode;
 }
 export declare type SceneData = {
@@ -316,6 +324,8 @@ export declare type AppClassProperties = {
     device: App["device"];
     scene: App["scene"];
     pasteFromClipboard: App["pasteFromClipboard"];
+    id: App["id"];
+    onInsertElements: App["onInsertElements"];
 };
 export declare type PointerDownState = Readonly<{
     origin: Readonly<{
@@ -397,7 +407,7 @@ export declare type ExcalidrawImperativeAPI = {
     setActiveTool: InstanceType<typeof App>["setActiveTool"];
     setCursor: InstanceType<typeof App>["setCursor"];
     resetCursor: InstanceType<typeof App>["resetCursor"];
-    toggleMenu: InstanceType<typeof App>["toggleMenu"];
+    toggleSidebar: InstanceType<typeof App>["toggleSidebar"];
 };
 export declare type Device = Readonly<{
     isSmScreen: boolean;

package/types/utils.d.ts

@@ -156,7 +156,7 @@ export declare const isPrimitive: (val: any) => boolean;
 export declare const getFrame: () => "top" | "iframe";
 export declare const isPromiseLike: (value: any) => value is Promise<any>;
 export declare const queryFocusableElements: (container: HTMLElement | null) => HTMLElement[];
-export declare const isShallowEqual: <T extends Record<string, any>>(objA: T, objB: T) => boolean;
+export declare const isShallowEqual: <T extends Record<string, any>, I extends keyof T>(objA: T, objB: T, comparators?: Record<I, (a: T[I], b: T[I]) => boolean> | undefined, debug?: boolean) => boolean;
 export declare const composeEventHandlers: <E>(originalEventHandler?: ((event: E) => void) | undefined, ourEventHandler?: ((event: E) => void) | undefined, { checkForDefaultPrevented }?: {
     checkForDefaultPrevented?: boolean | undefined;
 }) => (event: E) => void;

package/types/components/LibraryButton.d.ts

@@ -1,8 +0,0 @@
-import React from "react";
-import { AppState } from "../types";
-import "./LibraryButton.scss";
-export declare const LibraryButton: React.FC<{
-    appState: AppState;
-    setAppState: React.Component<any, AppState>["setState"];
-    isMobile?: boolean;
-}>;

package/types/components/context/tunnels.d.ts

@@ -1,16 +0,0 @@
-import React from "react";
-import tunnel from "@dwelle/tunnel-rat";
-declare type Tunnel = ReturnType<typeof tunnel>;
-declare type TunnelsContextValue = {
-    mainMenuTunnel: Tunnel;
-    welcomeScreenMenuHintTunnel: Tunnel;
-    welcomeScreenToolbarHintTunnel: Tunnel;
-    welcomeScreenHelpHintTunnel: Tunnel;
-    welcomeScreenCenterTunnel: Tunnel;
-    footerCenterTunnel: Tunnel;
-    jotaiScope: symbol;
-};
-export declare const TunnelsContext: React.Context<TunnelsContextValue>;
-export declare const useTunnels: () => TunnelsContextValue;
-export declare const useInitializeTunnels: () => TunnelsContextValue;
-export {};

package/types/components/hoc/withUpstreamOverride.d.ts

@@ -1,10 +0,0 @@
-import React from "react";
-export declare const withUpstreamOverride: <P>(Component: React.ComponentType<P>) => readonly [React.FC<{
-    children: React.ReactNode;
-}>, {
-    (props: P & {
-        /** @private internal */
-        __isFallback?: boolean | undefined;
-    }): JSX.Element | null;
-    displayName: string;
-}];