docs: fix container docs

daybrush · Mar 26, 2023 · 295d905 · 295d905
1 parent f3a9ee4
commit 295d905
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/packages/react-moveable/src/MoveableManager.tsx b/packages/react-moveable/src/MoveableManager.tsx
@@ -490,7 +490,9 @@ export default class MoveableManager<T = {}>
     }
     /**
      * If the width, height, left, and top of the only target change, update the shape of the moveable.
+     * Use `.updateRect()` method
      * @method Moveable#updateTarget
+     * @deprecated
      * @example
      * import Moveable from "moveable";
      *

diff --git a/packages/react-moveable/src/types.ts b/packages/react-moveable/src/types.ts
@@ -66,8 +66,8 @@ export interface DefaultOptions {
      */
     dragTarget?: SVGElement | HTMLElement | null;
     /**
-     * Moveable Container. Don't set it.
-     * @private
+     * A container into which Moveables are inserted.
+     * Set it only when used within the slot of Web Components or when the container is different.
      * @default parentElement
      */
     container?: SVGElement | HTMLElement | null;
@@ -3228,7 +3228,15 @@ export interface MoveableInterface {
     getRect(): RectInfo;
     getAble<T extends Able>(ableName: string): T | undefined;
     isMoveableElement(target: Element): boolean;
+    /**
+     * If the location or size of the target is changed, call the `.updateRect()` method.
+     * Use the `useResizeObserver` and `useMutationObserver` props to update automatically.
+     */
     updateRect(type?: "Start" | "" | "End", isTarget?: boolean, isSetState?: boolean): void;
+    /**
+     * @deprecated
+     * Use `.updateRect()` method
+     */
     updateTarget(): void;
     /**
      * Request able through a method rather than an event.