Circle V2 API Docs
    Preparing search index...

    Type Alias UseBoxTransformOptions

    type UseBoxTransformOptions = {
        disabled?: boolean;
        onBoxChange: (fieldKey: string, box: FormFieldBox) => void;
        onBoxCommit?: (fieldKey: string, box: FormFieldBox) => void;
        sizeOfPage: (pageNumber: number) => PageSizePts | undefined;
        target: BoxTransformTarget | null;
    }
    Index

    Properties

    disabled? onBoxChange onBoxCommit? sizeOfPage target

    Properties

    disabled?: boolean

    Suspends move and resize without unmounting (e.g. a read-only template).

    onBoxChange: (fieldKey: string, box: FormFieldBox) => void

    Every pointer move and arrow press, in the stored space. Render from it; persist from onBoxCommit.

    onBoxCommit?: (fieldKey: string, box: FormFieldBox) => void

    Once per gesture. This is the one to save.

    sizeOfPage: (pageNumber: number) => PageSizePts | undefined

    Keyboard nudging only; pointer drags clamp against the PageRenderInfo they are dragged on. Looked up per page, not passed once: one document can mix Letter and Legal.

    target: BoxTransformTarget | null

    The field the handles attach to — normally the selected one. null disables the whole layer.

    Settings

    Member Visibility

    On This Page

    Properties