SheetXL - v1.0.2
    Preparing search index...

    Interface MovableLayerProps

    interface MovableLayerProps {
        disabled?: boolean;
        disableDrag?: boolean;
        disableResize?: boolean;
        movables: IMovableCollection;
        movableSelection: IMovableSelection;
        onFirstRender?: () => void;
        onFocus?: () => void;
        onUnFocus?: () => void;
        ref?: Ref<IMovableLayerElement>;
        renderMovable: RenderSlotFn<MovableElementProps>;
        renderTip?: (gesture: MovableGesture) => ReactNode;
        resizeDirections?: ResizeDirectionName[];
    }

    Hierarchy

    • HTMLAttributes<HTMLDivElement>
      • MovableLayerProps
    Index
    disabled? disableDrag? disableResize? movables movableSelection onFirstRender? onFocus? onUnFocus? ref? renderMovable renderTip? resizeDirections?
    disabled?: boolean

    If disabled then movable selection will not be allowed and frames will be passed disabled.

    false
    disableDrag?: boolean

    If disabled then unable to move.

    false
    disableResize?: boolean

    If disabled then unable to resize.

    false
    movables: IMovableCollection

    The container to retrieve movable objects

    movableSelection: IMovableSelection

    The selection of the movables.

    onFirstRender?: () => void

    Called after the first render of a movable.

    onFocus?: () => void

    Called when the final movable is unselected.

    onUnFocus?: () => void

    Called when the final movable is unselected.

    ref?: Ref<IMovableLayerElement>

    Forwards the ref to the underlying element.

    renderMovable: RenderSlotFn<MovableElementProps>

    Callback to render the movable.

    MovableElementProps

    A React Element representing the IMovable.

    renderTip?: (gesture: MovableGesture) => ReactNode

    Render a readout while a frame is moved, resized or rotated — a GestureTip under the frame. Return an empty node for none.

    resizeDirections?: ResizeDirectionName[]

    The resize handles to show, by compass name.

    all eight

    Settings
    Member Visibility

    On This Page
    Properties