Circle V2 API Docs
    Preparing search index...

    Type Alias UseBoxNudgeOptions

    type UseBoxNudgeOptions = {
        box: FormFieldBox | null;
        onNudge: (box: FormFieldBox) => void;
        sizeOfPage: (pageNumber: number) => PageSizePts | undefined;
    }
    Index

    Properties

    box: FormFieldBox | null

    The selected box, or null when nothing is selected (every key then passes through).

    onNudge: (box: FormFieldBox) => void
    sizeOfPage: (pageNumber: number) => PageSizePts | undefined

    Looked up per page, not passed once: a document can mix Letter and Legal. undefined nudges nothing.