Type Alias UseBoxTransformResult

type UseBoxTransformResult = {
    activeHandle: TransformHandle | null;
    box: FormFieldBox | null;
    fieldKey: string | null;
    handleProps: (
        handle: TransformHandle,
        page: PageRenderInfo,
    ) => TransformHandleProps;
    moveStartProps: (
        candidate: BoxTransformTarget,
        page: PageRenderInfo,
    ) => TransformHandleProps;
    onKeyDown: (event: TransformKeyEvent) => void;
}

Index

Properties

activeHandle box fieldKey handleProps moveStartProps onKeyDown

Properties

activeHandle

activeHandle: TransformHandle | null

box

box: FormFieldBox | null

The live drag's box while a gesture is in flight, otherwise the target's.

fieldKey

fieldKey: string | null

handleProps

handleProps: (
handle: TransformHandle,
page: PageRenderInfo,
) => TransformHandleProps

page supplies the zoom and the page's point size.

moveStartProps

moveStartProps: (
candidate: BoxTransformTarget,
page: PageRenderInfo,
) => TransformHandleProps

Move props for a field's OWN box, targeted or not, so select-and-drag is one gesture: the drag runs off candidate, never target.

onKeyDown

onKeyDown: (event: TransformKeyEvent) => void

Arrows are consumed so the pane does not scroll.