Interface UseDistributeOptions<TPose>

Options for useDistribute.

interface UseDistributeOptions<TPose> {
    defaultMode?: DistributeMode;
    enableKeyboard?: boolean;
    geometry?: PoseProjection<TPose>;
    label?: string;
}

Properties

Default mode when distribute(axis) is called without one. Default 'centers'.

enableKeyboard?: boolean

Auto-register the two default distribute actions into a surrounding <ActionsProvider>. Default true. Pass false to skip registration.

Projection between TPose and bounds. Defaults to RECT_POSE_DESCRIPTOR for {x,y,width,height} poses.

label?: string

Label passed to applyOps. Default 'Distribute'.