OptionalaboutRDFa Attributes
OptionalacceptStandard HTML Attributes
OptionalacceptOptionalaccessStandard HTML Attributes
OptionalactionOptionalalignSetting alignToBottom to true aligns the items to the bottom of the list if the list is shorter than the viewport.
Use followOutput property to keep the list aligned when new items are appended.
OptionalallowOptionalallowOptionalaltOptionalaria-Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Defines a string value that labels the current element, which is intended to be converted into Braille.
Optionalaria-Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
Optionalaria-Optionalaria-Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
Optionalaria-Defines the total number of columns in a table, grid, or treegrid.
Optionalaria-Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-colindex.
Optionalaria-Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Identifies the element (or elements) whose contents or presence are controlled by the current element.
Optionalaria-Indicates the element that represents the current item within a container or set of related elements.
Optionalaria-Identifies the element (or elements) that describes the object.
Optionalaria-Defines a string value that describes or annotates the current element.
Optionalaria-Identifies the element that provides a detailed, extended description for the object.
Optionalaria-Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Optionalaria-Indicates what functions can be performed when a dragged object is released on the drop target.
Optionalaria-Identifies the element that provides an error message for the object.
Optionalaria-Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
Optionalaria-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.
Optionalaria-Indicates an element's "grabbed" state in a drag-and-drop operation.
Optionalaria-Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
Optionalaria-Indicates whether the element is exposed to an accessibility API.
Optionalaria-Indicates the entered value does not conform to the format expected by the application.
Optionalaria-Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
Optionalaria-Defines a string value that labels the current element.
Optionalaria-Identifies the element (or elements) that labels the current element.
Optionalaria-Defines the hierarchical level of an element within a structure.
Optionalaria-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.
Optionalaria-Indicates whether an element is modal when displayed.
Optionalaria-Indicates whether a text box accepts multiple lines of input or only a single line.
Optionalaria-Indicates that the user may select more than one item from the current selectable descendants.
Optionalaria-Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
Optionalaria-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.
Optionalaria-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.
Optionalaria-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.
Optionalaria-Indicates the current "pressed" state of toggle buttons.
Optionalaria-Indicates that the element is not editable, but is otherwise operable.
Optionalaria-Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
Optionalaria-Indicates that user input is required on the element before a form may be submitted.
Optionalaria-Defines a human-readable, author-localized description for the role of an element.
Optionalaria-Defines the total number of rows in a table, grid, or treegrid.
Optionalaria-Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
Optionalaria-Defines a human readable text alternative of aria-rowindex.
Optionalaria-Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
Optionalaria-Indicates the current "selected" state of various widgets.
Optionalaria-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.
Optionalaria-Indicates if items in a table or grid are sorted in ascending or descending order.
Optionalaria-Defines the maximum allowed value for a range widget.
Optionalaria-Defines the minimum allowed value for a range widget.
Optionalaria-Defines the current value for a range widget.
Optionalaria-Defines the human readable text alternative of aria-valuenow for a range widget.
OptionalasOptionalasyncOptionalatCalled with true / false when the list has reached the bottom / gets scrolled up.
Can be used to load newer items, like tail -f.
OptionalatThe property accepts pixel values.
By default 4. Redefine to change how much away from the bottom the scroller can be before the list is not considered not at bottom.
OptionalatCalled with true / false when the list has reached the top / gets scrolled down.
OptionalatThe property accepts pixel values.
By default 0. Redefine to change how much away from the top the scroller can be before the list is not considered not at top.
OptionalautoOptionalautoOptionalautoNon-standard Attributes
OptionalautoOptionalautoOptionalautoOptionalcaptureOptionalcellOptionalcellOptionalchallengeOptionalcharOptionalcheckedOptionalchildrenOptionalciteOptionalclassOptionalclassOptionalcolorOptionalcolsOptionalcolOptionalcomponentsUse the components property for advanced customization of the elements rendered by the list.
OptionalcomputeIf specified, the component will use the function to generate the key property for each list item.
OptionalcontentOptionalcontentOptionalcontextAdditional context available in the custom components and content callbacks
OptionalcontextOptionalcontrolsOptionalcoordsOptionalcrossOptionalcustomPass a reference to a scrollable parent element, so that the list won't wrap in its own.
OptionaldangerouslyShould be InnerHTML['innerHTML']. But unfortunately we're mixing renderer-specific type declarations.
OptionaldataThe data items to be rendered. If data is set, the total count will be inferred from the length of the array.
OptionaldatatypeOptionaldateOptionaldefaultOptionaldefaultReact-specific Attributes
OptionaldefaultBy default, the component assumes the default item height from the first rendered item (rendering it as a "probe").
If the first item turns out to be an outlier (very short or tall), the rest of the rendering will be slower, as multiple passes of rendering should happen for the list to fill the viewport.
Setting defaultItemHeight causes the component to skip the "probe" rendering and use the property
value as default height instead.
OptionaldefaultOptionaldeferOptionaldirOptionaldisabledOptionaldownloadOptionaldraggableOptionalencOptionalendGets 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.
OptionalenterOptionalexportpartsOptionalfirstUse when implementing inverse infinite scrolling - decrease the value this property
in combination with data or totalCount to prepend items to the top of the list.
Warning: the firstItemIndex should be a positive number, based on the total amount of items to be displayed.
OptionalfixedCan be used to improve performance if the rendered items are of known size. Setting it causes the component to skip item measurements.
OptionalfollowIf set to true, the list automatically scrolls to bottom if the total count is changed.
Set to "smooth" for an animated scrolling.
By default, followOutput scrolls down only if the list is already at the bottom.
To implement an arbitrary logic behind that, pass a function:
<Virtuoso
followOutput={(isAtBottom: boolean) => {
if (expression) {
return 'smooth' // can be 'auto' or false to avoid scrolling
} else {
return false
}
}} />
OptionalformOptionalformOptionalformOptionalformOptionalformOptionalformOptionalframeOptionalheaderSet to customize the wrapper tag for the header and footer components (default is div).
OptionalheadersThe height property.
OptionalhiddenOptionalhighOptionalhrefOptionalhrefOptionalhtmlOptionalhttpOptionalidOptionalincreaseThe property accepts pixel values.
Set the increaseViewportBy property to artificially increase the viewport size, causing items to be rendered before outside of the viewport.
The property causes the component to render more items than the necessary, but can help with slow loading content.
Using { top?: number, bottom?: number } lets you set the increase for each end separately.
OptionalinertOptionalinitialUse for server-side rendering - if set, the list will render the specified amount of items regardless of the container / item size.
OptionalinitialSet this value to offset the initial location of the list.
Warning: using this property will still run a render cycle at the scrollTop: 0 list window.
If possible, avoid using it and stick to initialTopMostItemIndex instead.
OptionalinitialSet to a value between 0 and totalCount - 1 to make the list start scrolled to that item.
Pass in an object to achieve additional effects similar to scrollToIndex.
OptionalinlistOptionalinputHints at the type of data that might be entered by the user while editing the element or its contents
OptionalintegrityOptionalisSpecify that a standard HTML element should behave like a defined custom built-in element
OptionalisCalled when the list starts/stops scrolling.
OptionalitemSet the callback to specify the contents of the item.
OptionalitemOptionalitemOptionalitemOptionalitemOptionalitemAllows customizing the height/width calculation of Item elements.
The default implementation reads el.getBoundingClientRect().height and el.getBoundingClientRect().width.
OptionalitemsCalled with the new set of items each time the list items are rendered due to scrolling.
OptionalitemOptionalkeyOptionalkeyOptionalkeyOptionalkindOptionallabelOptionallangOptionallistOptionalloopOptionallowOptionalmanifestOptionalmarginOptionalmarginOptionalmaxOptionalmaxOptionalmediaOptionalmediaOptionalmethodOptionalminOptionalminOptionalmultipleOptionalmutedOptionalnameOptionalnonceOptionalnoOptionalonMedia Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonAnimation Events
OptionalonOptionalonOptional emitter fired when the at-bottom state changes.
OptionalonMouseEvents
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonform related Events
OptionalonOptionalonOptionalonOptionalonComposition Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonClipboard Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonFocus Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonKeyboard Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonImage Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonPointer Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonUI Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonSelection Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonToggle Events
OptionalonTouch Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonTransition Events
OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonWheel Events
OptionalonOptionalopenOptionaloptimumOptionaloverscanThe property accepts pixel values.
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.
See the increaseViewportBy property for a similar behavior (equivalent to the overscan in react-window).
OptionalpartOptionalpatternOptionalplaceholderOptionalplaysOptionalpopoverPopover API
OptionalpopoverOptionalpopoverOptionalposterOptionalprefixOptionalpreloadOptionalpropertyOptionalradioUnknown
OptionalrangeCalled with the new set of items each time the list items are rendered due to scrolling.
Optionalreact18No longer necessary after 2.10.2. component should work out of the box.
OptionalreadOptionalrelOptionalrequiredOptionalresourceOptionalresultsOptionalrevOptionalreversedOptionalroleWAI-ARIA
The list of node rows.
OptionalrowOptionalsandboxOptionalscopeOptionalscopedOptionalscrollerProvides access to the root DOM element
OptionalscrollingOptionalscrollUse to display placeholders if the user scrolls fast through the list.
Set components.ScrollSeekPlaceholder to change the placeholder content.
OptionalscrollThe scroll to row value.
OptionalscrollChanges with every scroll request, so that the view scrolls to scrollToRow again even if the row did not change.
OptionalseamlessOptionalsecurityOptionalselectedOptionalshapeOptionalsizeOptionalsizesOptionalslotOptionalspanOptionalspellOptionalsrcOptionalsrcOptionalsrcOptionalsrcOptionalstartOptionalstartCalled when the user scrolls to the start of the list.
OptionalstepOptionalstyleOptionalsummaryOptionalsuppressOptionalsuppressOptionaltabOptionaltargetOptionaltitleOptionaltopSet the amount of items to remain fixed at the top of the list.
For a header that scrolls away when scrolling, check the components.Header property.
OptionaltotalThe total amount of items to be rendered.
OptionaltotalCalled when the total list height is changed due to new items or viewport resize.
OptionaltranslateOptionaltypeOptionaltypeofOptionalunselectableOptionaluseOptionaluseUses the document scroller rather than wrapping the list in its own.
OptionalvalueOptionalvocabThe width property.
OptionalwmodeOptionalwrap
Representation of the tree view properties.