Circle V2 API Docs
    Preparing search index...

    Type Alias FieldOverlayProps

    type FieldOverlayProps = {
        ariaChecked?: boolean;
        ariaLabel?: string;
        box: FormFieldBox;
        children?: ReactNode;
        elementRef?: (element: HTMLElement | null) => void;
        moveHandlers?: TransformHandleProps;
        onSelect?: () => void;
        page: PageRenderInfo;
        state?: FieldOverlayState;
    }
    Index

    Properties

    ariaChecked? ariaLabel? box children? elementRef? moveHandlers? onSelect? page state?

    Properties

    ariaChecked?: boolean

    Set on a box a click ticks: it is then read as a checkbox in that state, not as a pressed button.

    ariaLabel?: string
    box: FormFieldBox

    Stored position in PDF points, top-left origin, 1-based page (see ../types.ts).

    children?: ReactNode
    elementRef?: (element: HTMLElement | null) => void

    Wire to useFieldSelection's registerBoxRef.

    moveHandlers?: TransformHandleProps

    One-gesture select-and-move: useBoxTransform's moveStartProps for this box, with the consumer's select composed into onPointerDown. Interactive boxes only.

    onSelect?: () => void

    Wire to useFieldSelection's select(id, "pdf").

    page

    page: PageRenderInfo

    Renders only when box.page === page.pageNumber, so consumers can map every field on every page.

    state?: FieldOverlayState

    Settings

    Member Visibility

    On This Page

    Properties