GridEditCellProps containing api.

interface GridEditBooleanCellProps {
    about?: string;
    accessKey?: string;
    api: GridApiCommunity;
    aria-activedescendant?: string;
    aria-atomic?: Booleanish;
    aria-autocomplete?:
        | "none"
        | "list"
        | "both"
        | "inline";
    aria-braillelabel?: string;
    aria-brailleroledescription?: string;
    aria-busy?: Booleanish;
    aria-checked?:
        | boolean
        | "true"
        | "mixed"
        | "false";
    aria-colcount?: number;
    aria-colindex?: number;
    aria-colindextext?: string;
    aria-colspan?: number;
    aria-controls?: string;
    aria-current?:
        | boolean
        | "true"
        | "page"
        | "time"
        | "step"
        | "false"
        | "location"
        | "date";
    aria-describedby?: string;
    aria-description?: string;
    aria-details?: string;
    aria-disabled?: Booleanish;
    aria-dropeffect?:
        | "link"
        | "none"
        | "copy"
        | "move"
        | "execute"
        | "popup";
    aria-errormessage?: string;
    aria-expanded?: Booleanish;
    aria-flowto?: string;
    aria-grabbed?: Booleanish;
    aria-haspopup?:
        | boolean
        | "menu"
        | "true"
        | "grid"
        | "dialog"
        | "listbox"
        | "false"
        | "tree";
    aria-hidden?: Booleanish;
    aria-invalid?:
        | boolean
        | "true"
        | "false"
        | "grammar"
        | "spelling";
    aria-keyshortcuts?: string;
    aria-label?: string;
    aria-labelledby?: string;
    aria-level?: number;
    aria-live?: "assertive" | "polite" | "off";
    aria-modal?: Booleanish;
    aria-multiline?: Booleanish;
    aria-multiselectable?: Booleanish;
    aria-orientation?: "horizontal" | "vertical";
    aria-owns?: string;
    aria-placeholder?: string;
    aria-posinset?: number;
    aria-pressed?:
        | boolean
        | "true"
        | "mixed"
        | "false";
    aria-readonly?: Booleanish;
    aria-relevant?:
        | "all"
        | "text"
        | "additions"
        | "additions removals"
        | "additions text"
        | "removals"
        | "removals additions"
        | "removals text"
        | "text additions"
        | "text removals";
    aria-required?: Booleanish;
    aria-roledescription?: string;
    aria-rowcount?: number;
    aria-rowindex?: number;
    aria-rowindextext?: string;
    aria-rowspan?: number;
    aria-selected?: Booleanish;
    aria-setsize?: number;
    aria-sort?:
        | "none"
        | "other"
        | "ascending"
        | "descending";
    aria-valuemax?: number;
    aria-valuemin?: number;
    aria-valuenow?: number;
    aria-valuetext?: string;
    autoCapitalize?:
        | string & {}
        | "none"
        | "on"
        | "off"
        | "sentences"
        | "words"
        | "characters";
    autoCorrect?: string;
    autoFocus?: boolean;
    autoSave?: string;
    cellMode: GridCellMode;
    changeReason?: "debouncedSetEditCellValue" | "setEditCellValue";
    children?: ReactNode;
    className?: string;
    colDef: GridStateColDef;
    color?: string;
    content?: string;
    contentEditable?: "inherit" | Booleanish | "plaintext-only";
    contextMenu?: string;
    dangerouslySetInnerHTML?: {
        __html: string | TrustedHTML;
    };
    datatype?: string;
    defaultChecked?: boolean;
    defaultValue?: string | number | readonly string[];
    dir?: string;
    draggable?: Booleanish;
    enterKeyHint?:
        | "search"
        | "next"
        | "done"
        | "enter"
        | "go"
        | "previous"
        | "send";
    exportparts?: string;
    field: string;
    form?: string;
    formattedValue?: any;
    hasFocus: boolean;
    hidden?: boolean;
    htmlFor?: string;
    id: GridRowId;
    inert?: boolean;
    inlist?: any;
    inputMode?:
        | "search"
        | "none"
        | "url"
        | "text"
        | "tel"
        | "email"
        | "numeric"
        | "decimal";
    is?: string;
    isEditable?: boolean;
    isProcessingProps?: boolean;
    isValidating?: boolean;
    itemID?: string;
    itemProp?: string;
    itemRef?: string;
    itemScope?: boolean;
    itemType?: string;
    key?: null | Key;
    lang?: string;
    nonce?: string;
    onAbort?: ReactEventHandler<HTMLLabelElement>;
    onAbortCapture?: ReactEventHandler<HTMLLabelElement>;
    onAnimationEnd?: AnimationEventHandler<HTMLLabelElement>;
    onAnimationEndCapture?: AnimationEventHandler<HTMLLabelElement>;
    onAnimationIteration?: AnimationEventHandler<HTMLLabelElement>;
    onAnimationIterationCapture?: AnimationEventHandler<HTMLLabelElement>;
    onAnimationStart?: AnimationEventHandler<HTMLLabelElement>;
    onAnimationStartCapture?: AnimationEventHandler<HTMLLabelElement>;
    onAuxClick?: MouseEventHandler<HTMLLabelElement>;
    onAuxClickCapture?: MouseEventHandler<HTMLLabelElement>;
    onBeforeInput?: FormEventHandler<HTMLLabelElement>;
    onBeforeInputCapture?: FormEventHandler<HTMLLabelElement>;
    onBeforeToggle?: ToggleEventHandler<HTMLLabelElement>;
    onBlur?: FocusEventHandler<HTMLLabelElement>;
    onBlurCapture?: FocusEventHandler<HTMLLabelElement>;
    onCanPlay?: ReactEventHandler<HTMLLabelElement>;
    onCanPlayCapture?: ReactEventHandler<HTMLLabelElement>;
    onCanPlayThrough?: ReactEventHandler<HTMLLabelElement>;
    onCanPlayThroughCapture?: ReactEventHandler<HTMLLabelElement>;
    onChange?: FormEventHandler<HTMLLabelElement>;
    onChangeCapture?: FormEventHandler<HTMLLabelElement>;
    onClick?: MouseEventHandler<HTMLLabelElement>;
    onClickCapture?: MouseEventHandler<HTMLLabelElement>;
    onCompositionEnd?: CompositionEventHandler<HTMLLabelElement>;
    onCompositionEndCapture?: CompositionEventHandler<HTMLLabelElement>;
    onCompositionStart?: CompositionEventHandler<HTMLLabelElement>;
    onCompositionStartCapture?: CompositionEventHandler<HTMLLabelElement>;
    onCompositionUpdate?: CompositionEventHandler<HTMLLabelElement>;
    onCompositionUpdateCapture?: CompositionEventHandler<HTMLLabelElement>;
    onContextMenu?: MouseEventHandler<HTMLLabelElement>;
    onContextMenuCapture?: MouseEventHandler<HTMLLabelElement>;
    onCopy?: ClipboardEventHandler<HTMLLabelElement>;
    onCopyCapture?: ClipboardEventHandler<HTMLLabelElement>;
    onCut?: ClipboardEventHandler<HTMLLabelElement>;
    onCutCapture?: ClipboardEventHandler<HTMLLabelElement>;
    onDoubleClick?: MouseEventHandler<HTMLLabelElement>;
    onDoubleClickCapture?: MouseEventHandler<HTMLLabelElement>;
    onDrag?: DragEventHandler<HTMLLabelElement>;
    onDragCapture?: DragEventHandler<HTMLLabelElement>;
    onDragEnd?: DragEventHandler<HTMLLabelElement>;
    onDragEndCapture?: DragEventHandler<HTMLLabelElement>;
    onDragEnter?: DragEventHandler<HTMLLabelElement>;
    onDragEnterCapture?: DragEventHandler<HTMLLabelElement>;
    onDragExit?: DragEventHandler<HTMLLabelElement>;
    onDragExitCapture?: DragEventHandler<HTMLLabelElement>;
    onDragLeave?: DragEventHandler<HTMLLabelElement>;
    onDragLeaveCapture?: DragEventHandler<HTMLLabelElement>;
    onDragOver?: DragEventHandler<HTMLLabelElement>;
    onDragOverCapture?: DragEventHandler<HTMLLabelElement>;
    onDragStart?: DragEventHandler<HTMLLabelElement>;
    onDragStartCapture?: DragEventHandler<HTMLLabelElement>;
    onDrop?: DragEventHandler<HTMLLabelElement>;
    onDropCapture?: DragEventHandler<HTMLLabelElement>;
    onDurationChange?: ReactEventHandler<HTMLLabelElement>;
    onDurationChangeCapture?: ReactEventHandler<HTMLLabelElement>;
    onEmptied?: ReactEventHandler<HTMLLabelElement>;
    onEmptiedCapture?: ReactEventHandler<HTMLLabelElement>;
    onEncrypted?: ReactEventHandler<HTMLLabelElement>;
    onEncryptedCapture?: ReactEventHandler<HTMLLabelElement>;
    onEnded?: ReactEventHandler<HTMLLabelElement>;
    onEndedCapture?: ReactEventHandler<HTMLLabelElement>;
    onError?: ReactEventHandler<HTMLLabelElement>;
    onErrorCapture?: ReactEventHandler<HTMLLabelElement>;
    onFocus?: FocusEventHandler<HTMLLabelElement>;
    onFocusCapture?: FocusEventHandler<HTMLLabelElement>;
    onGotPointerCapture?: PointerEventHandler<HTMLLabelElement>;
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>;
    onInput?: FormEventHandler<HTMLLabelElement>;
    onInputCapture?: FormEventHandler<HTMLLabelElement>;
    onInvalid?: FormEventHandler<HTMLLabelElement>;
    onInvalidCapture?: FormEventHandler<HTMLLabelElement>;
    onKeyDown?: KeyboardEventHandler<HTMLLabelElement>;
    onKeyDownCapture?: KeyboardEventHandler<HTMLLabelElement>;
    onKeyPress?: KeyboardEventHandler<HTMLLabelElement>;
    onKeyPressCapture?: KeyboardEventHandler<HTMLLabelElement>;
    onKeyUp?: KeyboardEventHandler<HTMLLabelElement>;
    onKeyUpCapture?: KeyboardEventHandler<HTMLLabelElement>;
    onLoad?: ReactEventHandler<HTMLLabelElement>;
    onLoadCapture?: ReactEventHandler<HTMLLabelElement>;
    onLoadedData?: ReactEventHandler<HTMLLabelElement>;
    onLoadedDataCapture?: ReactEventHandler<HTMLLabelElement>;
    onLoadedMetadata?: ReactEventHandler<HTMLLabelElement>;
    onLoadedMetadataCapture?: ReactEventHandler<HTMLLabelElement>;
    onLoadStart?: ReactEventHandler<HTMLLabelElement>;
    onLoadStartCapture?: ReactEventHandler<HTMLLabelElement>;
    onLostPointerCapture?: PointerEventHandler<HTMLLabelElement>;
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>;
    onMouseDown?: MouseEventHandler<HTMLLabelElement>;
    onMouseDownCapture?: MouseEventHandler<HTMLLabelElement>;
    onMouseEnter?: MouseEventHandler<HTMLLabelElement>;
    onMouseLeave?: MouseEventHandler<HTMLLabelElement>;
    onMouseMove?: MouseEventHandler<HTMLLabelElement>;
    onMouseMoveCapture?: MouseEventHandler<HTMLLabelElement>;
    onMouseOut?: MouseEventHandler<HTMLLabelElement>;
    onMouseOutCapture?: MouseEventHandler<HTMLLabelElement>;
    onMouseOver?: MouseEventHandler<HTMLLabelElement>;
    onMouseOverCapture?: MouseEventHandler<HTMLLabelElement>;
    onMouseUp?: MouseEventHandler<HTMLLabelElement>;
    onMouseUpCapture?: MouseEventHandler<HTMLLabelElement>;
    onPaste?: ClipboardEventHandler<HTMLLabelElement>;
    onPasteCapture?: ClipboardEventHandler<HTMLLabelElement>;
    onPause?: ReactEventHandler<HTMLLabelElement>;
    onPauseCapture?: ReactEventHandler<HTMLLabelElement>;
    onPlay?: ReactEventHandler<HTMLLabelElement>;
    onPlayCapture?: ReactEventHandler<HTMLLabelElement>;
    onPlaying?: ReactEventHandler<HTMLLabelElement>;
    onPlayingCapture?: ReactEventHandler<HTMLLabelElement>;
    onPointerCancel?: PointerEventHandler<HTMLLabelElement>;
    onPointerCancelCapture?: PointerEventHandler<HTMLLabelElement>;
    onPointerDown?: PointerEventHandler<HTMLLabelElement>;
    onPointerDownCapture?: PointerEventHandler<HTMLLabelElement>;
    onPointerEnter?: PointerEventHandler<HTMLLabelElement>;
    onPointerLeave?: PointerEventHandler<HTMLLabelElement>;
    onPointerMove?: PointerEventHandler<HTMLLabelElement>;
    onPointerMoveCapture?: PointerEventHandler<HTMLLabelElement>;
    onPointerOut?: PointerEventHandler<HTMLLabelElement>;
    onPointerOutCapture?: PointerEventHandler<HTMLLabelElement>;
    onPointerOver?: PointerEventHandler<HTMLLabelElement>;
    onPointerOverCapture?: PointerEventHandler<HTMLLabelElement>;
    onPointerUp?: PointerEventHandler<HTMLLabelElement>;
    onPointerUpCapture?: PointerEventHandler<HTMLLabelElement>;
    onProgress?: ReactEventHandler<HTMLLabelElement>;
    onProgressCapture?: ReactEventHandler<HTMLLabelElement>;
    onRateChange?: ReactEventHandler<HTMLLabelElement>;
    onRateChangeCapture?: ReactEventHandler<HTMLLabelElement>;
    onReset?: FormEventHandler<HTMLLabelElement>;
    onResetCapture?: FormEventHandler<HTMLLabelElement>;
    onResize?: ReactEventHandler<HTMLLabelElement>;
    onResizeCapture?: ReactEventHandler<HTMLLabelElement>;
    onScroll?: UIEventHandler<HTMLLabelElement>;
    onScrollCapture?: UIEventHandler<HTMLLabelElement>;
    onSeeked?: ReactEventHandler<HTMLLabelElement>;
    onSeekedCapture?: ReactEventHandler<HTMLLabelElement>;
    onSeeking?: ReactEventHandler<HTMLLabelElement>;
    onSeekingCapture?: ReactEventHandler<HTMLLabelElement>;
    onSelect?: ReactEventHandler<HTMLLabelElement>;
    onSelectCapture?: ReactEventHandler<HTMLLabelElement>;
    onStalled?: ReactEventHandler<HTMLLabelElement>;
    onStalledCapture?: ReactEventHandler<HTMLLabelElement>;
    onSubmit?: FormEventHandler<HTMLLabelElement>;
    onSubmitCapture?: FormEventHandler<HTMLLabelElement>;
    onSuspend?: ReactEventHandler<HTMLLabelElement>;
    onSuspendCapture?: ReactEventHandler<HTMLLabelElement>;
    onTimeUpdate?: ReactEventHandler<HTMLLabelElement>;
    onTimeUpdateCapture?: ReactEventHandler<HTMLLabelElement>;
    onToggle?: ToggleEventHandler<HTMLLabelElement>;
    onTouchCancel?: TouchEventHandler<HTMLLabelElement>;
    onTouchCancelCapture?: TouchEventHandler<HTMLLabelElement>;
    onTouchEnd?: TouchEventHandler<HTMLLabelElement>;
    onTouchEndCapture?: TouchEventHandler<HTMLLabelElement>;
    onTouchMove?: TouchEventHandler<HTMLLabelElement>;
    onTouchMoveCapture?: TouchEventHandler<HTMLLabelElement>;
    onTouchStart?: TouchEventHandler<HTMLLabelElement>;
    onTouchStartCapture?: TouchEventHandler<HTMLLabelElement>;
    onTransitionCancel?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionCancelCapture?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionEnd?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionEndCapture?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionRun?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionRunCapture?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionStart?: TransitionEventHandler<HTMLLabelElement>;
    onTransitionStartCapture?: TransitionEventHandler<HTMLLabelElement>;
    onValueChange?: ((event: ChangeEvent<HTMLInputElement>, newValue: boolean) => void | Promise<void>);
    onVolumeChange?: ReactEventHandler<HTMLLabelElement>;
    onVolumeChangeCapture?: ReactEventHandler<HTMLLabelElement>;
    onWaiting?: ReactEventHandler<HTMLLabelElement>;
    onWaitingCapture?: ReactEventHandler<HTMLLabelElement>;
    onWheel?: WheelEventHandler<HTMLLabelElement>;
    onWheelCapture?: WheelEventHandler<HTMLLabelElement>;
    part?: string;
    popover?: "" | "auto" | "manual";
    popoverTarget?: string;
    popoverTargetAction?: "toggle" | "hide" | "show";
    prefix?: string;
    property?: string;
    radioGroup?: string;
    ref?: LegacyRef<HTMLLabelElement>;
    rel?: string;
    resource?: string;
    results?: number;
    rev?: string;
    role?: AriaRole;
    row: any;
    rowNode: GridTreeNodeWithRender;
    security?: string;
    slot?: string;
    spellCheck?: Booleanish;
    style?: CSSProperties;
    suppressContentEditableWarning?: boolean;
    suppressHydrationWarning?: boolean;
    tabIndex: -1 | 0;
    title?: string;
    translate?: "yes" | "no";
    tw?: string;
    typeof?: string;
    unselectable?: "on" | "off";
    value?: any;
    vocab?: string;
}

Hierarchy (view full)

  • GridRenderEditCellParams
  • Omit<React.DetailedHTMLProps<React.LabelHTMLAttributes<HTMLLabelElement>, HTMLLabelElement>, "id" | "tabIndex">
    • GridEditBooleanCellProps

Properties

about? accessKey? api aria-activedescendant? aria-atomic? aria-autocomplete? aria-braillelabel? aria-brailleroledescription? aria-busy? aria-checked? aria-colcount? aria-colindex? aria-colindextext? aria-colspan? aria-controls? aria-current? aria-describedby? aria-description? aria-details? aria-disabled? aria-dropeffect? aria-errormessage? aria-expanded? aria-flowto? aria-grabbed? aria-haspopup? aria-hidden? aria-invalid? aria-keyshortcuts? aria-label? aria-labelledby? aria-level? aria-live? aria-modal? aria-multiline? aria-multiselectable? aria-orientation? aria-owns? aria-placeholder? aria-posinset? aria-pressed? aria-readonly? aria-relevant? aria-required? aria-roledescription? aria-rowcount? aria-rowindex? aria-rowindextext? aria-rowspan? aria-selected? aria-setsize? aria-sort? aria-valuemax? aria-valuemin? aria-valuenow? aria-valuetext? autoCapitalize? autoCorrect? autoFocus? autoSave? cellMode changeReason? children? className? colDef color? content? contentEditable? contextMenu? dangerouslySetInnerHTML? datatype? defaultChecked? defaultValue? dir? draggable? enterKeyHint? exportparts? field form? formattedValue? hasFocus hidden? htmlFor? id inert? inlist? inputMode? is? isEditable? isProcessingProps? isValidating? itemID? itemProp? itemRef? itemScope? itemType? key? lang? nonce? onAbort? onAbortCapture? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onBeforeInput? onBeforeInputCapture? onBeforeToggle? onBlur? onBlurCapture? onCanPlay? onCanPlayCapture? onCanPlayThrough? onCanPlayThroughCapture? onChange? onChangeCapture? onClick? onClickCapture? onCompositionEnd? onCompositionEndCapture? onCompositionStart? onCompositionStartCapture? onCompositionUpdate? onCompositionUpdateCapture? onContextMenu? onContextMenuCapture? onCopy? onCopyCapture? onCut? onCutCapture? onDoubleClick? onDoubleClickCapture? onDrag? onDragCapture? onDragEnd? onDragEndCapture? onDragEnter? onDragEnterCapture? onDragExit? onDragExitCapture? onDragLeave? onDragLeaveCapture? onDragOver? onDragOverCapture? onDragStart? onDragStartCapture? onDrop? onDropCapture? onDurationChange? onDurationChangeCapture? onEmptied? onEmptiedCapture? onEncrypted? onEncryptedCapture? onEnded? onEndedCapture? onError? onErrorCapture? onFocus? onFocusCapture? onGotPointerCapture? onGotPointerCaptureCapture? onInput? onInputCapture? onInvalid? onInvalidCapture? onKeyDown? onKeyDownCapture? onKeyPress? onKeyPressCapture? onKeyUp? onKeyUpCapture? onLoad? onLoadCapture? onLoadedData? onLoadedDataCapture? onLoadedMetadata? onLoadedMetadataCapture? onLoadStart? onLoadStartCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPaste? onPasteCapture? onPause? onPauseCapture? onPlay? onPlayCapture? onPlaying? onPlayingCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onProgress? onProgressCapture? onRateChange? onRateChangeCapture? onReset? onResetCapture? onResize? onResizeCapture? onScroll? onScrollCapture? onSeeked? onSeekedCapture? onSeeking? onSeekingCapture? onSelect? onSelectCapture? onStalled? onStalledCapture? onSubmit? onSubmitCapture? onSuspend? onSuspendCapture? onTimeUpdate? onTimeUpdateCapture? onToggle? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onValueChange? onVolumeChange? onVolumeChangeCapture? onWaiting? onWaitingCapture? onWheel? onWheelCapture? part? popover? popoverTarget? popoverTargetAction? prefix? property? radioGroup? ref? rel? resource? results? rev? role? row rowNode security? slot? spellCheck? style? suppressContentEditableWarning? suppressHydrationWarning? tabIndex title? translate? tw? typeof? unselectable? value? vocab?

Properties

about?: string
accessKey?: string
api: GridApiCommunity

GridApi that let you manipulate the grid.

aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete?:
    | "none"
    | "list"
    | "both"
    | "inline"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-braillelabel?: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

aria-label.

aria-brailleroledescription?: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

aria-roledescription.

aria-busy?: Booleanish
aria-checked?:
    | boolean
    | "true"
    | "mixed"
    | "false"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

  • aria-pressed
  • aria-selected.
aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.

aria-colindex.

aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

  • aria-colcount
  • aria-colspan.
aria-colindextext?: string

Defines a human readable text alternative of aria-colindex.

aria-rowindextext.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

  • aria-colindex
  • aria-rowspan.
aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

aria-owns.

aria-current?:
    | boolean
    | "true"
    | "page"
    | "time"
    | "step"
    | "false"
    | "location"
    | "date"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

Identifies the element (or elements) that describes the object.

aria-labelledby

aria-description?: string

Defines a string value that describes or annotates the current element.

related aria-describedby.

aria-details?: string

Identifies the element that provides a detailed, extended description for the object.

aria-describedby.

aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

  • aria-hidden
  • aria-readonly.
aria-dropeffect?:
    | "link"
    | "none"
    | "copy"
    | "move"
    | "execute"
    | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.

  • aria-invalid
  • aria-describedby.
aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

in ARIA 1.1

aria-haspopup?:
    | boolean
    | "menu"
    | "true"
    | "grid"
    | "dialog"
    | "listbox"
    | "false"
    | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.

aria-disabled.

aria-invalid?:
    | boolean
    | "true"
    | "false"
    | "grammar"
    | "spelling"

Indicates the entered value does not conform to the format expected by the application.

aria-errormessage.

aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

aria-label?: string

Defines a string value that labels the current element.

aria-labelledby.

aria-labelledby?: string

Identifies the element (or elements) that labels the current element.

aria-describedby.

aria-level?: number

Defines the hierarchical level of an element within a structure.

aria-live?: "assertive" | "polite" | "off"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

aria-controls.

aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

aria-setsize.

aria-pressed?:
    | boolean
    | "true"
    | "mixed"
    | "false"

Indicates the current "pressed" state of toggle buttons.

  • aria-checked
  • aria-selected.
aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.

aria-disabled.

aria-relevant?:
    | "all"
    | "text"
    | "additions"
    | "additions removals"
    | "additions text"
    | "removals"
    | "removals additions"
    | "removals text"
    | "text additions"
    | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

aria-atomic.

aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.

aria-rowindex.

aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

  • aria-rowcount
  • aria-rowspan.
aria-rowindextext?: string

Defines a human readable text alternative of aria-rowindex.

aria-colindextext.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

  • aria-rowindex
  • aria-colspan.
aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.

  • aria-checked
  • aria-pressed.
aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

aria-posinset.

aria-sort?:
    | "none"
    | "other"
    | "ascending"
    | "descending"

Indicates if items in a table or grid are sorted in ascending or descending order.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.

aria-valuetext.

aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?:
    | string & {}
    | "none"
    | "on"
    | "off"
    | "sentences"
    | "words"
    | "characters"
autoCorrect?: string
autoFocus?: boolean
autoSave?: string
cellMode: GridCellMode

The mode of the cell.

changeReason?: "debouncedSetEditCellValue" | "setEditCellValue"
children?: ReactNode
className?: string
colDef: GridStateColDef

The column of the row that the current cell belongs to.

color?: string
content?: string
contentEditable?: "inherit" | Booleanish | "plaintext-only"
contextMenu?: string
dangerouslySetInnerHTML?: {
    __html: string | TrustedHTML;
}
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
draggable?: Booleanish
enterKeyHint?:
    | "search"
    | "next"
    | "done"
    | "enter"
    | "go"
    | "previous"
    | "send"
exportparts?: string
field: string

The column field of the cell that triggered the event.

form?: string
formattedValue?: any

The cell value formatted with the column valueFormatter.

hasFocus: boolean

If true, the cell is the active element.

hidden?: boolean
htmlFor?: string

The grid row id.

inert?: boolean
inlist?: any
inputMode?:
    | "search"
    | "none"
    | "url"
    | "text"
    | "tel"
    | "email"
    | "numeric"
    | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents

is?: string

Specify that a standard HTML element should behave like a defined custom built-in element

isEditable?: boolean

If true, the cell is editable.

isProcessingProps?: boolean
isValidating?: boolean
itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
key?: null | Key
lang?: string
nonce?: string
onAbort?: ReactEventHandler<HTMLLabelElement>
onAbortCapture?: ReactEventHandler<HTMLLabelElement>
onAnimationEnd?: AnimationEventHandler<HTMLLabelElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLLabelElement>
onAnimationIteration?: AnimationEventHandler<HTMLLabelElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLLabelElement>
onAnimationStart?: AnimationEventHandler<HTMLLabelElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLLabelElement>
onAuxClick?: MouseEventHandler<HTMLLabelElement>
onAuxClickCapture?: MouseEventHandler<HTMLLabelElement>
onBeforeInput?: FormEventHandler<HTMLLabelElement>
onBeforeInputCapture?: FormEventHandler<HTMLLabelElement>
onBeforeToggle?: ToggleEventHandler<HTMLLabelElement>
onBlur?: FocusEventHandler<HTMLLabelElement>
onBlurCapture?: FocusEventHandler<HTMLLabelElement>
onCanPlay?: ReactEventHandler<HTMLLabelElement>
onCanPlayCapture?: ReactEventHandler<HTMLLabelElement>
onCanPlayThrough?: ReactEventHandler<HTMLLabelElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLLabelElement>
onChange?: FormEventHandler<HTMLLabelElement>
onChangeCapture?: FormEventHandler<HTMLLabelElement>
onClick?: MouseEventHandler<HTMLLabelElement>
onClickCapture?: MouseEventHandler<HTMLLabelElement>
onCompositionEnd?: CompositionEventHandler<HTMLLabelElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLLabelElement>
onCompositionStart?: CompositionEventHandler<HTMLLabelElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLLabelElement>
onCompositionUpdate?: CompositionEventHandler<HTMLLabelElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLLabelElement>
onContextMenu?: MouseEventHandler<HTMLLabelElement>
onContextMenuCapture?: MouseEventHandler<HTMLLabelElement>
onCopy?: ClipboardEventHandler<HTMLLabelElement>
onCopyCapture?: ClipboardEventHandler<HTMLLabelElement>
onCut?: ClipboardEventHandler<HTMLLabelElement>
onCutCapture?: ClipboardEventHandler<HTMLLabelElement>
onDoubleClick?: MouseEventHandler<HTMLLabelElement>
onDoubleClickCapture?: MouseEventHandler<HTMLLabelElement>
onDrag?: DragEventHandler<HTMLLabelElement>
onDragCapture?: DragEventHandler<HTMLLabelElement>
onDragEnd?: DragEventHandler<HTMLLabelElement>
onDragEndCapture?: DragEventHandler<HTMLLabelElement>
onDragEnter?: DragEventHandler<HTMLLabelElement>
onDragEnterCapture?: DragEventHandler<HTMLLabelElement>
onDragExit?: DragEventHandler<HTMLLabelElement>
onDragExitCapture?: DragEventHandler<HTMLLabelElement>
onDragLeave?: DragEventHandler<HTMLLabelElement>
onDragLeaveCapture?: DragEventHandler<HTMLLabelElement>
onDragOver?: DragEventHandler<HTMLLabelElement>
onDragOverCapture?: DragEventHandler<HTMLLabelElement>
onDragStart?: DragEventHandler<HTMLLabelElement>
onDragStartCapture?: DragEventHandler<HTMLLabelElement>
onDrop?: DragEventHandler<HTMLLabelElement>
onDropCapture?: DragEventHandler<HTMLLabelElement>
onDurationChange?: ReactEventHandler<HTMLLabelElement>
onDurationChangeCapture?: ReactEventHandler<HTMLLabelElement>
onEmptied?: ReactEventHandler<HTMLLabelElement>
onEmptiedCapture?: ReactEventHandler<HTMLLabelElement>
onEncrypted?: ReactEventHandler<HTMLLabelElement>
onEncryptedCapture?: ReactEventHandler<HTMLLabelElement>
onEnded?: ReactEventHandler<HTMLLabelElement>
onEndedCapture?: ReactEventHandler<HTMLLabelElement>
onError?: ReactEventHandler<HTMLLabelElement>
onErrorCapture?: ReactEventHandler<HTMLLabelElement>
onFocus?: FocusEventHandler<HTMLLabelElement>
onFocusCapture?: FocusEventHandler<HTMLLabelElement>
onGotPointerCapture?: PointerEventHandler<HTMLLabelElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>
onInput?: FormEventHandler<HTMLLabelElement>
onInputCapture?: FormEventHandler<HTMLLabelElement>
onInvalid?: FormEventHandler<HTMLLabelElement>
onInvalidCapture?: FormEventHandler<HTMLLabelElement>
onKeyDown?: KeyboardEventHandler<HTMLLabelElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLLabelElement>
onKeyPress?: KeyboardEventHandler<HTMLLabelElement>

Use onKeyUp or onKeyDown instead

onKeyPressCapture?: KeyboardEventHandler<HTMLLabelElement>

Use onKeyUpCapture or onKeyDownCapture instead

onKeyUp?: KeyboardEventHandler<HTMLLabelElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLLabelElement>
onLoad?: ReactEventHandler<HTMLLabelElement>
onLoadCapture?: ReactEventHandler<HTMLLabelElement>
onLoadedData?: ReactEventHandler<HTMLLabelElement>
onLoadedDataCapture?: ReactEventHandler<HTMLLabelElement>
onLoadedMetadata?: ReactEventHandler<HTMLLabelElement>
onLoadedMetadataCapture?: ReactEventHandler<HTMLLabelElement>
onLoadStart?: ReactEventHandler<HTMLLabelElement>
onLoadStartCapture?: ReactEventHandler<HTMLLabelElement>
onLostPointerCapture?: PointerEventHandler<HTMLLabelElement>
onLostPointerCaptureCapture?: PointerEventHandler<HTMLLabelElement>
onMouseDown?: MouseEventHandler<HTMLLabelElement>
onMouseDownCapture?: MouseEventHandler<HTMLLabelElement>
onMouseEnter?: MouseEventHandler<HTMLLabelElement>
onMouseLeave?: MouseEventHandler<HTMLLabelElement>
onMouseMove?: MouseEventHandler<HTMLLabelElement>
onMouseMoveCapture?: MouseEventHandler<HTMLLabelElement>
onMouseOut?: MouseEventHandler<HTMLLabelElement>
onMouseOutCapture?: MouseEventHandler<HTMLLabelElement>
onMouseOver?: MouseEventHandler<HTMLLabelElement>
onMouseOverCapture?: MouseEventHandler<HTMLLabelElement>
onMouseUp?: MouseEventHandler<HTMLLabelElement>
onMouseUpCapture?: MouseEventHandler<HTMLLabelElement>
onPaste?: ClipboardEventHandler<HTMLLabelElement>
onPasteCapture?: ClipboardEventHandler<HTMLLabelElement>
onPause?: ReactEventHandler<HTMLLabelElement>
onPauseCapture?: ReactEventHandler<HTMLLabelElement>
onPlay?: ReactEventHandler<HTMLLabelElement>
onPlayCapture?: ReactEventHandler<HTMLLabelElement>
onPlaying?: ReactEventHandler<HTMLLabelElement>
onPlayingCapture?: ReactEventHandler<HTMLLabelElement>
onPointerCancel?: PointerEventHandler<HTMLLabelElement>
onPointerCancelCapture?: PointerEventHandler<HTMLLabelElement>
onPointerDown?: PointerEventHandler<HTMLLabelElement>
onPointerDownCapture?: PointerEventHandler<HTMLLabelElement>
onPointerEnter?: PointerEventHandler<HTMLLabelElement>
onPointerLeave?: PointerEventHandler<HTMLLabelElement>
onPointerMove?: PointerEventHandler<HTMLLabelElement>
onPointerMoveCapture?: PointerEventHandler<HTMLLabelElement>
onPointerOut?: PointerEventHandler<HTMLLabelElement>
onPointerOutCapture?: PointerEventHandler<HTMLLabelElement>
onPointerOver?: PointerEventHandler<HTMLLabelElement>
onPointerOverCapture?: PointerEventHandler<HTMLLabelElement>
onPointerUp?: PointerEventHandler<HTMLLabelElement>
onPointerUpCapture?: PointerEventHandler<HTMLLabelElement>
onProgress?: ReactEventHandler<HTMLLabelElement>
onProgressCapture?: ReactEventHandler<HTMLLabelElement>
onRateChange?: ReactEventHandler<HTMLLabelElement>
onRateChangeCapture?: ReactEventHandler<HTMLLabelElement>
onReset?: FormEventHandler<HTMLLabelElement>
onResetCapture?: FormEventHandler<HTMLLabelElement>
onResize?: ReactEventHandler<HTMLLabelElement>
onResizeCapture?: ReactEventHandler<HTMLLabelElement>
onScroll?: UIEventHandler<HTMLLabelElement>
onScrollCapture?: UIEventHandler<HTMLLabelElement>
onSeeked?: ReactEventHandler<HTMLLabelElement>
onSeekedCapture?: ReactEventHandler<HTMLLabelElement>
onSeeking?: ReactEventHandler<HTMLLabelElement>
onSeekingCapture?: ReactEventHandler<HTMLLabelElement>
onSelect?: ReactEventHandler<HTMLLabelElement>
onSelectCapture?: ReactEventHandler<HTMLLabelElement>
onStalled?: ReactEventHandler<HTMLLabelElement>
onStalledCapture?: ReactEventHandler<HTMLLabelElement>
onSubmit?: FormEventHandler<HTMLLabelElement>
onSubmitCapture?: FormEventHandler<HTMLLabelElement>
onSuspend?: ReactEventHandler<HTMLLabelElement>
onSuspendCapture?: ReactEventHandler<HTMLLabelElement>
onTimeUpdate?: ReactEventHandler<HTMLLabelElement>
onTimeUpdateCapture?: ReactEventHandler<HTMLLabelElement>
onToggle?: ToggleEventHandler<HTMLLabelElement>
onTouchCancel?: TouchEventHandler<HTMLLabelElement>
onTouchCancelCapture?: TouchEventHandler<HTMLLabelElement>
onTouchEnd?: TouchEventHandler<HTMLLabelElement>
onTouchEndCapture?: TouchEventHandler<HTMLLabelElement>
onTouchMove?: TouchEventHandler<HTMLLabelElement>
onTouchMoveCapture?: TouchEventHandler<HTMLLabelElement>
onTouchStart?: TouchEventHandler<HTMLLabelElement>
onTouchStartCapture?: TouchEventHandler<HTMLLabelElement>
onTransitionCancel?: TransitionEventHandler<HTMLLabelElement>
onTransitionCancelCapture?: TransitionEventHandler<HTMLLabelElement>
onTransitionEnd?: TransitionEventHandler<HTMLLabelElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLLabelElement>
onTransitionRun?: TransitionEventHandler<HTMLLabelElement>
onTransitionRunCapture?: TransitionEventHandler<HTMLLabelElement>
onTransitionStart?: TransitionEventHandler<HTMLLabelElement>
onTransitionStartCapture?: TransitionEventHandler<HTMLLabelElement>
onValueChange?: ((event: ChangeEvent<HTMLInputElement>, newValue: boolean) => void | Promise<void>)

Callback called when the value is changed by the user.

Type declaration

    • (event, newValue): void | Promise<void>
    • Parameters

      • event: ChangeEvent<HTMLInputElement>

        The event source of the callback.

      • newValue: boolean

        The value that is going to be passed to apiRef.current.setEditCellValue.

      Returns void | Promise<void>

      A promise to be awaited before calling apiRef.current.setEditCellValue

onVolumeChange?: ReactEventHandler<HTMLLabelElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLLabelElement>
onWaiting?: ReactEventHandler<HTMLLabelElement>
onWaitingCapture?: ReactEventHandler<HTMLLabelElement>
onWheel?: WheelEventHandler<HTMLLabelElement>
onWheelCapture?: WheelEventHandler<HTMLLabelElement>
part?: string
popover?: "" | "auto" | "manual"
popoverTarget?: string
popoverTargetAction?: "toggle" | "hide" | "show"
prefix?: string
property?: string
radioGroup?: string
ref?: LegacyRef<HTMLLabelElement>

Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).

rel?: string
resource?: string
results?: number
rev?: string
role?: AriaRole
row: any

The row model of the row that the current cell belongs to.

The node of the row that the current cell belongs to.

security?: string
slot?: string
spellCheck?: Booleanish
style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex: -1 | 0

the tabIndex value.

title?: string
translate?: "yes" | "no"
tw?: string

Specify styles using Tailwind CSS classes. This feature is currently experimental. If style prop is also specified, styles generated with tw prop will be overridden.

Example:

  • tw='w-full h-full bg-blue-200'
  • tw='text-9xl'
  • tw='text-[80px]'
typeof?: string
unselectable?: "on" | "off"
value?: any

The cell value. If the column has valueGetter, use params.row to directly access the fields.

vocab?: string