Skip to main content

Interface: VirtuosoGridProps<D, C>

Type parameters

NameType
DD
Cunknown

Hierarchy

Properties

totalCount

Optional totalCount: number

The total amount of items to be rendered.


data

Optional data: readonly D[]

The data items to be rendered. If data is set, the total count will be inferred from the length of the array.


context

Optional context: C

Additional context available in the custom components and content callbacks


initialItemCount

Optional initialItemCount: number

Use for server-side rendering - if set, the list will render the specified amount of items regardless of the container / item size.


itemContent

Optional itemContent: GridItemContent<D, C>

Set the callback to specify the contents of the item.


components

Optional components: GridComponents<C>

Use the components property for advanced customization of the elements rendered by the list.


overscan

Optional overscan: number | { main: number ; reverse: number }

Set the overscan property to make the component "chunk" the rendering of new items on scroll. The property causes the component to render more items than the necessary, but reduces the re-renders on scroll. Setting { main: number, reverse: number } lets you extend the list in both the main and the reverse scrollable directions.


computeItemKey

Optional computeItemKey: GridComputeItemKey<D, C>

If specified, the component will use the function to generate the key property for each list item.


scrollSeekConfiguration

Optional scrollSeekConfiguration: false | ScrollSeekConfiguration

Use to display placeholders if the user scrolls fast through the list.

Set components.ScrollSeekPlaceholder to change the placeholder content.


isScrolling

Optional isScrolling: (isScrolling: boolean) => void

Called when the list starts/stops scrolling.

Type declaration

▸ (isScrolling): void

Parameters
NameType
isScrollingboolean
Returns

void


endReached

Optional endReached: (index: number) => void

Gets called when the user scrolls to the end of the list. Receives the last item index as an argument. Can be used to implement endless scrolling.

Type declaration

▸ (index): void

Parameters
NameType
indexnumber
Returns

void


startReached

Optional startReached: (index: number) => void

Called when the user scrolls to the start of the list.

Type declaration

▸ (index): void

Parameters
NameType
indexnumber
Returns

void


rangeChanged

Optional rangeChanged: (range: ListRange) => void

Called with the new set of items each time the list items are rendered due to scrolling.

Type declaration

▸ (range): void

Parameters
NameType
rangeListRange
Returns

void


stateChanged

Optional stateChanged: (state: GridStateSnapshot) => void

reports when the grid state changes. The reported value can be stored and passed back to restoreStateFrom to restore the grid to the same state.

Type declaration

▸ (state): void

Parameters
NameType
stateGridStateSnapshot
Returns

void


restoreStateFrom

Optional restoreStateFrom: GridStateSnapshot


atBottomStateChange

Optional atBottomStateChange: (atBottom: boolean) => void

Called with true / false when the list has reached the bottom / gets scrolled up. Can be used to load newer items, like tail -f.

Type declaration

▸ (atBottom): void

Parameters
NameType
atBottomboolean
Returns

void


atTopStateChange

Optional atTopStateChange: (atTop: boolean) => void

Called with true / false when the list has reached the top / gets scrolled down.

Type declaration

▸ (atTop): void

Parameters
NameType
atTopboolean
Returns

void


scrollerRef

Optional scrollerRef: (ref: HTMLElement) => any

Provides access to the root DOM element

Type declaration

▸ (ref): any

Parameters
NameType
refHTMLElement
Returns

any


listClassName

Optional listClassName: string

Sets the className for the list DOM element


itemClassName

Optional itemClassName: string

Sets the grid items' className


useWindowScroll

Optional useWindowScroll: boolean

Uses the document scroller rather than wrapping the grid in its own.


customScrollParent

Optional customScrollParent: HTMLElement

Pass a reference to a scrollable parent element, so that the grid won't wrap in its own.


logLevel

Optional logLevel: LogLevel

set to LogLevel.DEBUG to enable various diagnostics in the console, the most useful being the item measurement reports.

Ensure that you have "all levels" enabled in the browser console too see the messages.


initialTopMostItemIndex

Optional initialTopMostItemIndex: GridIndexLocation


className

Optional className: string

Inherited from

GridRootProps.className


type

Optional type: string

Inherited from

GridRootProps.type


label

Optional label: string

Inherited from

GridRootProps.label


id

Optional id: string

Inherited from

GridRootProps.id


href

Optional href: string

Inherited from

GridRootProps.href


title

Optional title: string

Inherited from

GridRootProps.title


kind

Optional kind: string

Inherited from

GridRootProps.kind


style

Optional style: CSSProperties

Inherited from

GridRootProps.style


alt

Optional alt: string

Inherited from

GridRootProps.alt


src

Optional src: string

Inherited from

GridRootProps.src


width

Optional width: string | number

Inherited from

GridRootProps.width


height

Optional height: string | number

Inherited from

GridRootProps.height


target

Optional target: string

Inherited from

GridRootProps.target


color

Optional color: string

Inherited from

GridRootProps.color


value

Optional value: string | number | readonly string[]

Inherited from

GridRootProps.value


children

Optional children: ReactNode

Inherited from

GridRootProps.children


cite

Optional cite: string

Inherited from

GridRootProps.cite


form

Optional form: string

Inherited from

GridRootProps.form


slot

Optional slot: string

Inherited from

GridRootProps.slot


span

Optional span: number

Inherited from

GridRootProps.span


summary

Optional summary: string

Inherited from

GridRootProps.summary


pattern

Optional pattern: string

Inherited from

GridRootProps.pattern


as

Optional as: string

Inherited from

GridRootProps.as


sandbox

Optional sandbox: string

Inherited from

GridRootProps.sandbox


key

Optional key: Key

Inherited from

GridRootProps.key


start

Optional start: number

Inherited from

GridRootProps.start


onClick

Optional onClick: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onClick


tabIndex

Optional tabIndex: number

Inherited from

GridRootProps.tabIndex


accept

Optional accept: string

Inherited from

GridRootProps.accept


acceptCharset

Optional acceptCharset: string

Inherited from

GridRootProps.acceptCharset


action

Optional action: string

Inherited from

GridRootProps.action


allowFullScreen

Optional allowFullScreen: boolean

Inherited from

GridRootProps.allowFullScreen


allowTransparency

Optional allowTransparency: boolean

Inherited from

GridRootProps.allowTransparency


async

Optional async: boolean

Inherited from

GridRootProps.async


autoComplete

Optional autoComplete: string

Inherited from

GridRootProps.autoComplete


autoPlay

Optional autoPlay: boolean

Inherited from

GridRootProps.autoPlay


capture

Optional capture: boolean | "environment" | "user"

Inherited from

GridRootProps.capture


cellPadding

Optional cellPadding: string | number

Inherited from

GridRootProps.cellPadding


cellSpacing

Optional cellSpacing: string | number

Inherited from

GridRootProps.cellSpacing


charSet

Optional charSet: string

Inherited from

GridRootProps.charSet


challenge

Optional challenge: string

Inherited from

GridRootProps.challenge


checked

Optional checked: boolean

Inherited from

GridRootProps.checked


classID

Optional classID: string

Inherited from

GridRootProps.classID


cols

Optional cols: number

Inherited from

GridRootProps.cols


colSpan

Optional colSpan: number

Inherited from

GridRootProps.colSpan


controls

Optional controls: boolean

Inherited from

GridRootProps.controls


coords

Optional coords: string

Inherited from

GridRootProps.coords


crossOrigin

Optional crossOrigin: CrossOrigin

Inherited from

GridRootProps.crossOrigin


dateTime

Optional dateTime: string

Inherited from

GridRootProps.dateTime


default

Optional default: boolean

Inherited from

GridRootProps.default


defer

Optional defer: boolean

Inherited from

GridRootProps.defer


disabled

Optional disabled: boolean

Inherited from

GridRootProps.disabled


download

Optional download: any

Inherited from

GridRootProps.download


encType

Optional encType: string

Inherited from

GridRootProps.encType


formAction

Optional formAction: string

Inherited from

GridRootProps.formAction


formEncType

Optional formEncType: string

Inherited from

GridRootProps.formEncType


formMethod

Optional formMethod: string

Inherited from

GridRootProps.formMethod


formNoValidate

Optional formNoValidate: boolean

Inherited from

GridRootProps.formNoValidate


formTarget

Optional formTarget: string

Inherited from

GridRootProps.formTarget


frameBorder

Optional frameBorder: string | number

Inherited from

GridRootProps.frameBorder


headers

Optional headers: string

Inherited from

GridRootProps.headers


high

Optional high: number

Inherited from

GridRootProps.high


hrefLang

Optional hrefLang: string

Inherited from

GridRootProps.hrefLang


htmlFor

Optional htmlFor: string

Inherited from

GridRootProps.htmlFor


httpEquiv

Optional httpEquiv: string

Inherited from

GridRootProps.httpEquiv


integrity

Optional integrity: string

Inherited from

GridRootProps.integrity


keyParams

Optional keyParams: string

Inherited from

GridRootProps.keyParams


keyType

Optional keyType: string

Inherited from

GridRootProps.keyType


list

Optional list: string

Inherited from

GridRootProps.list


loop

Optional loop: boolean

Inherited from

GridRootProps.loop


low

Optional low: number

Inherited from

GridRootProps.low


manifest

Optional manifest: string

Inherited from

GridRootProps.manifest


marginHeight

Optional marginHeight: number

Inherited from

GridRootProps.marginHeight


marginWidth

Optional marginWidth: number

Inherited from

GridRootProps.marginWidth


max

Optional max: string | number

Inherited from

GridRootProps.max


maxLength

Optional maxLength: number

Inherited from

GridRootProps.maxLength


media

Optional media: string

Inherited from

GridRootProps.media


mediaGroup

Optional mediaGroup: string

Inherited from

GridRootProps.mediaGroup


method

Optional method: string

Inherited from

GridRootProps.method


min

Optional min: string | number

Inherited from

GridRootProps.min


minLength

Optional minLength: number

Inherited from

GridRootProps.minLength


multiple

Optional multiple: boolean

Inherited from

GridRootProps.multiple


muted

Optional muted: boolean

Inherited from

GridRootProps.muted


name

Optional name: string

Inherited from

GridRootProps.name


noValidate

Optional noValidate: boolean

Inherited from

GridRootProps.noValidate


open

Optional open: boolean

Inherited from

GridRootProps.open


optimum

Optional optimum: number

Inherited from

GridRootProps.optimum


placeholder

Optional placeholder: string

Inherited from

GridRootProps.placeholder


playsInline

Optional playsInline: boolean

Inherited from

GridRootProps.playsInline


poster

Optional poster: string

Inherited from

GridRootProps.poster


preload

Optional preload: string

Inherited from

GridRootProps.preload


readOnly

Optional readOnly: boolean

Inherited from

GridRootProps.readOnly


required

Optional required: boolean

Inherited from

GridRootProps.required


reversed

Optional reversed: boolean

Inherited from

GridRootProps.reversed


rows

Optional rows: number

Inherited from

GridRootProps.rows


rowSpan

Optional rowSpan: number

Inherited from

GridRootProps.rowSpan


scope

Optional scope: string

Inherited from

GridRootProps.scope


scoped

Optional scoped: boolean

Inherited from

GridRootProps.scoped


scrolling

Optional scrolling: string

Inherited from

GridRootProps.scrolling


seamless

Optional seamless: boolean

Inherited from

GridRootProps.seamless


selected

Optional selected: boolean

Inherited from

GridRootProps.selected


shape

Optional shape: string

Inherited from

GridRootProps.shape


size

Optional size: number

Inherited from

GridRootProps.size


sizes

Optional sizes: string

Inherited from

GridRootProps.sizes


srcDoc

Optional srcDoc: string

Inherited from

GridRootProps.srcDoc


srcLang

Optional srcLang: string

Inherited from

GridRootProps.srcLang


srcSet

Optional srcSet: string

Inherited from

GridRootProps.srcSet


step

Optional step: string | number

Inherited from

GridRootProps.step


useMap

Optional useMap: string

Inherited from

GridRootProps.useMap


wmode

Optional wmode: string

Inherited from

GridRootProps.wmode


wrap

Optional wrap: string

Inherited from

GridRootProps.wrap


defaultChecked

Optional defaultChecked: boolean

Inherited from

GridRootProps.defaultChecked


defaultValue

Optional defaultValue: string | number | readonly string[]

Inherited from

GridRootProps.defaultValue


suppressContentEditableWarning

Optional suppressContentEditableWarning: boolean

Inherited from

GridRootProps.suppressContentEditableWarning


suppressHydrationWarning

Optional suppressHydrationWarning: boolean

Inherited from

GridRootProps.suppressHydrationWarning


accessKey

Optional accessKey: string

Inherited from

GridRootProps.accessKey


autoFocus

Optional autoFocus: boolean

Inherited from

GridRootProps.autoFocus


contentEditable

Optional contentEditable: "inherit" | Booleanish | "plaintext-only"

Inherited from

GridRootProps.contentEditable


contextMenu

Optional contextMenu: string

Inherited from

GridRootProps.contextMenu


dir

Optional dir: string

Inherited from

GridRootProps.dir


draggable

Optional draggable: Booleanish

Inherited from

GridRootProps.draggable


hidden

Optional hidden: boolean

Inherited from

GridRootProps.hidden


lang

Optional lang: string

Inherited from

GridRootProps.lang


nonce

Optional nonce: string

Inherited from

GridRootProps.nonce


spellCheck

Optional spellCheck: Booleanish

Inherited from

GridRootProps.spellCheck


translate

Optional translate: "yes" | "no"

Inherited from

GridRootProps.translate


radioGroup

Optional radioGroup: string

Inherited from

GridRootProps.radioGroup


role

Optional role: AriaRole

Inherited from

GridRootProps.role


about

Optional about: string

Inherited from

GridRootProps.about


content

Optional content: string

Inherited from

GridRootProps.content


datatype

Optional datatype: string

Inherited from

GridRootProps.datatype


inlist

Optional inlist: any

Inherited from

GridRootProps.inlist


prefix

Optional prefix: string

Inherited from

GridRootProps.prefix


property

Optional property: string

Inherited from

GridRootProps.property


rel

Optional rel: string

Inherited from

GridRootProps.rel


resource

Optional resource: string

Inherited from

GridRootProps.resource


rev

Optional rev: string

Inherited from

GridRootProps.rev


typeof

Optional typeof: string

Inherited from

GridRootProps.typeof


vocab

Optional vocab: string

Inherited from

GridRootProps.vocab


autoCapitalize

Optional autoCapitalize: string

Inherited from

GridRootProps.autoCapitalize


autoCorrect

Optional autoCorrect: string

Inherited from

GridRootProps.autoCorrect


autoSave

Optional autoSave: string

Inherited from

GridRootProps.autoSave


itemProp

Optional itemProp: string

Inherited from

GridRootProps.itemProp


itemScope

Optional itemScope: boolean

Inherited from

GridRootProps.itemScope


itemType

Optional itemType: string

Inherited from

GridRootProps.itemType


itemID

Optional itemID: string

Inherited from

GridRootProps.itemID


itemRef

Optional itemRef: string

Inherited from

GridRootProps.itemRef


results

Optional results: number

Inherited from

GridRootProps.results


security

Optional security: string

Inherited from

GridRootProps.security


unselectable

Optional unselectable: "on" | "off"

Inherited from

GridRootProps.unselectable


inputMode

Optional inputMode: "url" | "search" | "none" | "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

See

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

Inherited from

GridRootProps.inputMode


is

Optional is: string

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

See

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

Inherited from

GridRootProps.is


aria-activedescendant

Optional aria-activedescendant: string

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

Inherited from

GridRootProps.aria-activedescendant


aria-atomic

Optional 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.

Inherited from

GridRootProps.aria-atomic


aria-autocomplete

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

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.

Inherited from

GridRootProps.aria-autocomplete


aria-braillelabel

Optional aria-braillelabel: string

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

See

aria-label.

Inherited from

GridRootProps.aria-braillelabel


aria-brailleroledescription

Optional 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.

See

aria-roledescription.

Inherited from

GridRootProps.aria-brailleroledescription


aria-busy

Optional aria-busy: Booleanish

Inherited from

GridRootProps.aria-busy


aria-checked

Optional aria-checked: boolean | "true" | "false" | "mixed"

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

See

  • aria-pressed
  • aria-selected.

Inherited from

GridRootProps.aria-checked


aria-colcount

Optional aria-colcount: number

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

See

aria-colindex.

Inherited from

GridRootProps.aria-colcount


aria-colindex

Optional 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.

See

  • aria-colcount
  • aria-colspan.

Inherited from

GridRootProps.aria-colindex


aria-colindextext

Optional aria-colindextext: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

Inherited from

GridRootProps.aria-colindextext


aria-colspan

Optional aria-colspan: number

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

See

  • aria-colindex
  • aria-rowspan.

Inherited from

GridRootProps.aria-colspan


aria-controls

Optional aria-controls: string

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

See

aria-owns.

Inherited from

GridRootProps.aria-controls


aria-current

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

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

Inherited from

GridRootProps.aria-current


aria-describedby

Optional aria-describedby: string

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

See

aria-labelledby

Inherited from

GridRootProps.aria-describedby


aria-description

Optional aria-description: string

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

See

related aria-describedby.

Inherited from

GridRootProps.aria-description


aria-details

Optional aria-details: string

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

See

aria-describedby.

Inherited from

GridRootProps.aria-details


aria-disabled

Optional aria-disabled: Booleanish

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

See

  • aria-hidden
  • aria-readonly.

Inherited from

GridRootProps.aria-disabled


aria-dropeffect

Optional aria-dropeffect: "link" | "none" | "copy" | "execute" | "move" | "popup"

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

Deprecated

in ARIA 1.1

Inherited from

GridRootProps.aria-dropeffect


aria-errormessage

Optional aria-errormessage: string

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

See

  • aria-invalid
  • aria-describedby.

Inherited from

GridRootProps.aria-errormessage


aria-expanded

Optional aria-expanded: Booleanish

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

Inherited from

GridRootProps.aria-expanded


aria-flowto

Optional 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.

Inherited from

GridRootProps.aria-flowto


aria-grabbed

Optional aria-grabbed: Booleanish

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

Deprecated

in ARIA 1.1

Inherited from

GridRootProps.aria-grabbed


aria-haspopup

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

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

Inherited from

GridRootProps.aria-haspopup


aria-hidden

Optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Inherited from

GridRootProps.aria-hidden


aria-invalid

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

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

See

aria-errormessage.

Inherited from

GridRootProps.aria-invalid


aria-keyshortcuts

Optional aria-keyshortcuts: string

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

Inherited from

GridRootProps.aria-keyshortcuts


aria-label

Optional aria-label: string

Defines a string value that labels the current element.

See

aria-labelledby.

Inherited from

GridRootProps.aria-label


aria-labelledby

Optional aria-labelledby: string

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

See

aria-describedby.

Inherited from

GridRootProps.aria-labelledby


aria-level

Optional aria-level: number

Defines the hierarchical level of an element within a structure.

Inherited from

GridRootProps.aria-level


aria-live

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

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.

Inherited from

GridRootProps.aria-live


aria-modal

Optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from

GridRootProps.aria-modal


aria-multiline

Optional aria-multiline: Booleanish

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

Inherited from

GridRootProps.aria-multiline


aria-multiselectable

Optional aria-multiselectable: Booleanish

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

Inherited from

GridRootProps.aria-multiselectable


aria-orientation

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

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

Inherited from

GridRootProps.aria-orientation


aria-owns

Optional 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.

See

aria-controls.

Inherited from

GridRootProps.aria-owns


aria-placeholder

Optional 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.

Inherited from

GridRootProps.aria-placeholder


aria-posinset

Optional 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.

See

aria-setsize.

Inherited from

GridRootProps.aria-posinset


aria-pressed

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

Indicates the current "pressed" state of toggle buttons.

See

  • aria-checked
  • aria-selected.

Inherited from

GridRootProps.aria-pressed


aria-readonly

Optional aria-readonly: Booleanish

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

See

aria-disabled.

Inherited from

GridRootProps.aria-readonly


aria-relevant

Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "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.

See

aria-atomic.

Inherited from

GridRootProps.aria-relevant


aria-required

Optional aria-required: Booleanish

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

Inherited from

GridRootProps.aria-required


aria-roledescription

Optional aria-roledescription: string

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

Inherited from

GridRootProps.aria-roledescription


aria-rowcount

Optional aria-rowcount: number

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

See

aria-rowindex.

Inherited from

GridRootProps.aria-rowcount


aria-rowindex

Optional 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.

See

  • aria-rowcount
  • aria-rowspan.

Inherited from

GridRootProps.aria-rowindex


aria-rowindextext

Optional aria-rowindextext: string

Defines a human readable text alternative of aria-rowindex.

See

aria-colindextext.

Inherited from

GridRootProps.aria-rowindextext


aria-rowspan

Optional aria-rowspan: number

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

See

  • aria-rowindex
  • aria-colspan.

Inherited from

GridRootProps.aria-rowspan


aria-selected

Optional aria-selected: Booleanish

Indicates the current "selected" state of various widgets.

See

  • aria-checked
  • aria-pressed.

Inherited from

GridRootProps.aria-selected


aria-setsize

Optional 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.

See

aria-posinset.

Inherited from

GridRootProps.aria-setsize


aria-sort

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

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

Inherited from

GridRootProps.aria-sort


aria-valuemax

Optional aria-valuemax: number

Defines the maximum allowed value for a range widget.

Inherited from

GridRootProps.aria-valuemax


aria-valuemin

Optional aria-valuemin: number

Defines the minimum allowed value for a range widget.

Inherited from

GridRootProps.aria-valuemin


aria-valuenow

Optional aria-valuenow: number

Defines the current value for a range widget.

See

aria-valuetext.

Inherited from

GridRootProps.aria-valuenow


aria-valuetext

Optional aria-valuetext: string

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

Inherited from

GridRootProps.aria-valuetext


dangerouslySetInnerHTML

Optional dangerouslySetInnerHTML: Object

Type declaration

NameType
__htmlstring | TrustedHTML

Inherited from

GridRootProps.dangerouslySetInnerHTML


onCopy

Optional onCopy: ClipboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCopy


onCopyCapture

Optional onCopyCapture: ClipboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCopyCapture


onCut

Optional onCut: ClipboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCut


onCutCapture

Optional onCutCapture: ClipboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCutCapture


onPaste

Optional onPaste: ClipboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPaste


onPasteCapture

Optional onPasteCapture: ClipboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPasteCapture


onCompositionEnd

Optional onCompositionEnd: CompositionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCompositionEnd


onCompositionEndCapture

Optional onCompositionEndCapture: CompositionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCompositionEndCapture


onCompositionStart

Optional onCompositionStart: CompositionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCompositionStart


onCompositionStartCapture

Optional onCompositionStartCapture: CompositionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCompositionStartCapture


onCompositionUpdate

Optional onCompositionUpdate: CompositionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCompositionUpdate


onCompositionUpdateCapture

Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCompositionUpdateCapture


onFocus

Optional onFocus: FocusEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onFocus


onFocusCapture

Optional onFocusCapture: FocusEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onFocusCapture


onBlur

Optional onBlur: FocusEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onBlur


onBlurCapture

Optional onBlurCapture: FocusEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onBlurCapture


onChange

Optional onChange: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onChange


onChangeCapture

Optional onChangeCapture: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onChangeCapture


onBeforeInput

Optional onBeforeInput: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onBeforeInput


onBeforeInputCapture

Optional onBeforeInputCapture: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onBeforeInputCapture


onInput

Optional onInput: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onInput


onInputCapture

Optional onInputCapture: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onInputCapture


onReset

Optional onReset: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onReset


onResetCapture

Optional onResetCapture: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onResetCapture


onSubmit

Optional onSubmit: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSubmit


onSubmitCapture

Optional onSubmitCapture: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSubmitCapture


onInvalid

Optional onInvalid: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onInvalid


onInvalidCapture

Optional onInvalidCapture: FormEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onInvalidCapture


onLoad

Optional onLoad: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoad


onLoadCapture

Optional onLoadCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadCapture


onError

Optional onError: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onError


onErrorCapture

Optional onErrorCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onErrorCapture


onKeyDown

Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onKeyDown


onKeyDownCapture

Optional onKeyDownCapture: KeyboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onKeyDownCapture


onKeyPress

Optional onKeyPress: KeyboardEventHandler<HTMLDivElement>

Deprecated

Inherited from

GridRootProps.onKeyPress


onKeyPressCapture

Optional onKeyPressCapture: KeyboardEventHandler<HTMLDivElement>

Deprecated

Inherited from

GridRootProps.onKeyPressCapture


onKeyUp

Optional onKeyUp: KeyboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onKeyUp


onKeyUpCapture

Optional onKeyUpCapture: KeyboardEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onKeyUpCapture


onAbort

Optional onAbort: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAbort


onAbortCapture

Optional onAbortCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAbortCapture


onCanPlay

Optional onCanPlay: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCanPlay


onCanPlayCapture

Optional onCanPlayCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCanPlayCapture


onCanPlayThrough

Optional onCanPlayThrough: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCanPlayThrough


onCanPlayThroughCapture

Optional onCanPlayThroughCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onCanPlayThroughCapture


onDurationChange

Optional onDurationChange: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDurationChange


onDurationChangeCapture

Optional onDurationChangeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDurationChangeCapture


onEmptied

Optional onEmptied: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onEmptied


onEmptiedCapture

Optional onEmptiedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onEmptiedCapture


onEncrypted

Optional onEncrypted: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onEncrypted


onEncryptedCapture

Optional onEncryptedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onEncryptedCapture


onEnded

Optional onEnded: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onEnded


onEndedCapture

Optional onEndedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onEndedCapture


onLoadedData

Optional onLoadedData: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadedData


onLoadedDataCapture

Optional onLoadedDataCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadedDataCapture


onLoadedMetadata

Optional onLoadedMetadata: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadedMetadata


onLoadedMetadataCapture

Optional onLoadedMetadataCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadedMetadataCapture


onLoadStart

Optional onLoadStart: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadStart


onLoadStartCapture

Optional onLoadStartCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLoadStartCapture


onPause

Optional onPause: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPause


onPauseCapture

Optional onPauseCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPauseCapture


onPlay

Optional onPlay: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPlay


onPlayCapture

Optional onPlayCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPlayCapture


onPlaying

Optional onPlaying: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPlaying


onPlayingCapture

Optional onPlayingCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPlayingCapture


onProgress

Optional onProgress: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onProgress


onProgressCapture

Optional onProgressCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onProgressCapture


onRateChange

Optional onRateChange: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onRateChange


onRateChangeCapture

Optional onRateChangeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onRateChangeCapture


onResize

Optional onResize: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onResize


onResizeCapture

Optional onResizeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onResizeCapture


onSeeked

Optional onSeeked: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSeeked


onSeekedCapture

Optional onSeekedCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSeekedCapture


onSeeking

Optional onSeeking: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSeeking


onSeekingCapture

Optional onSeekingCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSeekingCapture


onStalled

Optional onStalled: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onStalled


onStalledCapture

Optional onStalledCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onStalledCapture


onSuspend

Optional onSuspend: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSuspend


onSuspendCapture

Optional onSuspendCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSuspendCapture


onTimeUpdate

Optional onTimeUpdate: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTimeUpdate


onTimeUpdateCapture

Optional onTimeUpdateCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTimeUpdateCapture


onVolumeChange

Optional onVolumeChange: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onVolumeChange


onVolumeChangeCapture

Optional onVolumeChangeCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onVolumeChangeCapture


onWaiting

Optional onWaiting: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onWaiting


onWaitingCapture

Optional onWaitingCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onWaitingCapture


onAuxClick

Optional onAuxClick: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAuxClick


onAuxClickCapture

Optional onAuxClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAuxClickCapture


onClickCapture

Optional onClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onClickCapture


onContextMenu

Optional onContextMenu: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onContextMenu


onContextMenuCapture

Optional onContextMenuCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onContextMenuCapture


onDoubleClick

Optional onDoubleClick: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDoubleClick


onDoubleClickCapture

Optional onDoubleClickCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDoubleClickCapture


onDrag

Optional onDrag: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDrag


onDragCapture

Optional onDragCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragCapture


onDragEnd

Optional onDragEnd: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragEnd


onDragEndCapture

Optional onDragEndCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragEndCapture


onDragEnter

Optional onDragEnter: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragEnter


onDragEnterCapture

Optional onDragEnterCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragEnterCapture


onDragExit

Optional onDragExit: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragExit


onDragExitCapture

Optional onDragExitCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragExitCapture


onDragLeave

Optional onDragLeave: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragLeave


onDragLeaveCapture

Optional onDragLeaveCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragLeaveCapture


onDragOver

Optional onDragOver: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragOver


onDragOverCapture

Optional onDragOverCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragOverCapture


onDragStart

Optional onDragStart: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragStart


onDragStartCapture

Optional onDragStartCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDragStartCapture


onDrop

Optional onDrop: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDrop


onDropCapture

Optional onDropCapture: DragEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onDropCapture


onMouseDown

Optional onMouseDown: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseDown


onMouseDownCapture

Optional onMouseDownCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseDownCapture


onMouseEnter

Optional onMouseEnter: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseEnter


onMouseLeave

Optional onMouseLeave: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseLeave


onMouseMove

Optional onMouseMove: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseMove


onMouseMoveCapture

Optional onMouseMoveCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseMoveCapture


onMouseOut

Optional onMouseOut: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseOut


onMouseOutCapture

Optional onMouseOutCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseOutCapture


onMouseOver

Optional onMouseOver: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseOver


onMouseOverCapture

Optional onMouseOverCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseOverCapture


onMouseUp

Optional onMouseUp: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseUp


onMouseUpCapture

Optional onMouseUpCapture: MouseEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onMouseUpCapture


onSelect

Optional onSelect: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSelect


onSelectCapture

Optional onSelectCapture: ReactEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onSelectCapture


onTouchCancel

Optional onTouchCancel: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchCancel


onTouchCancelCapture

Optional onTouchCancelCapture: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchCancelCapture


onTouchEnd

Optional onTouchEnd: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchEnd


onTouchEndCapture

Optional onTouchEndCapture: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchEndCapture


onTouchMove

Optional onTouchMove: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchMove


onTouchMoveCapture

Optional onTouchMoveCapture: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchMoveCapture


onTouchStart

Optional onTouchStart: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchStart


onTouchStartCapture

Optional onTouchStartCapture: TouchEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTouchStartCapture


onPointerDown

Optional onPointerDown: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerDown


onPointerDownCapture

Optional onPointerDownCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerDownCapture


onPointerMove

Optional onPointerMove: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerMove


onPointerMoveCapture

Optional onPointerMoveCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerMoveCapture


onPointerUp

Optional onPointerUp: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerUp


onPointerUpCapture

Optional onPointerUpCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerUpCapture


onPointerCancel

Optional onPointerCancel: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerCancel


onPointerCancelCapture

Optional onPointerCancelCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerCancelCapture


onPointerEnter

Optional onPointerEnter: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerEnter


onPointerLeave

Optional onPointerLeave: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerLeave


onPointerOver

Optional onPointerOver: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerOver


onPointerOverCapture

Optional onPointerOverCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerOverCapture


onPointerOut

Optional onPointerOut: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerOut


onPointerOutCapture

Optional onPointerOutCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onPointerOutCapture


onGotPointerCapture

Optional onGotPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onGotPointerCapture


onGotPointerCaptureCapture

Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onGotPointerCaptureCapture


onLostPointerCapture

Optional onLostPointerCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLostPointerCapture


onLostPointerCaptureCapture

Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onLostPointerCaptureCapture


onScroll

Optional onScroll: UIEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onScroll


onScrollCapture

Optional onScrollCapture: UIEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onScrollCapture


onWheel

Optional onWheel: WheelEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onWheel


onWheelCapture

Optional onWheelCapture: WheelEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onWheelCapture


onAnimationStart

Optional onAnimationStart: AnimationEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAnimationStart


onAnimationStartCapture

Optional onAnimationStartCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAnimationStartCapture


onAnimationEnd

Optional onAnimationEnd: AnimationEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAnimationEnd


onAnimationEndCapture

Optional onAnimationEndCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAnimationEndCapture


onAnimationIteration

Optional onAnimationIteration: AnimationEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAnimationIteration


onAnimationIterationCapture

Optional onAnimationIterationCapture: AnimationEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onAnimationIterationCapture


onTransitionEnd

Optional onTransitionEnd: TransitionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTransitionEnd


onTransitionEndCapture

Optional onTransitionEndCapture: TransitionEventHandler<HTMLDivElement>

Inherited from

GridRootProps.onTransitionEndCapture