Interface EditorOverlayResults

interface EditorOverlayResults {
    isEditing: boolean;
    onKeyboardEvent: ((e) => void);
    onScroll?: ((scrollPoint) => void);
    overlay: ((view) => ReactNode);
    cancelEdit(): void;
    onPointerEvent(e): void;
    startEdit(event?): void;
    submitEdit(): void;
}

Properties

isEditing onKeyboardEvent onScroll? overlay

Methods

cancelEdit onPointerEvent startEdit submitEdit

Properties

isEditing

isEditing: boolean

indicates if the editor is active

onKeyboardEvent

onKeyboardEvent: ((e) => void)

Bind to keyboard event

Type declaration

    • (e): void

    • Parameters

      • e: KeyboardEvent<HTMLDivElement>

      Returns void

Optional onScroll

onScroll?: ((scrollPoint) => void)

OnScroll listener to align the editor

Type declaration

    • (scrollPoint): void

    • Parameters

      Returns void

overlay

overlay: ((view) => ReactNode)

Editor component to be injected.

Type declaration

Methods

cancelEdit

  • cancelEdit(): void

  • Cancels an edit

    Returns void

onPointerEvent

  • onPointerEvent(e): void

  • Bind to pointer event

    Parameters

    • e: PointerEvent<HTMLDivElement>

    Returns void

startEdit

  • startEdit(event?): void

  • Make a cell editable

    Parameters

    Returns void

    Params

    an option StartEditEvent

submitEdit

  • submitEdit(): void

  • Imperatively trigger submit

    Returns void

Settings

Member Visibility

Theme

On This Page

isEditingonKeyboardEventonScrolloverlaycancelEditonPointerEventstartEditsubmitEdit