Props of VList.
Pick<VirtualizerProps<T>,"ref"|"data"|"children"|"overscan"|"itemSize"|"shift"|"horizontal"|"onScroll"|"onScrollEnd">.ViewportComponentAttributes
• T
children: (
data,index) =>Element
The elements renderer function.
T
number
Element
Pick.children
optionalonScroll: (offset) =>void
Callback invoked whenever scroll offset changes.
number
Current scrollTop, or scrollLeft if horizontal: true.
void
Pick.onScroll
optionalshift:boolean
While true is set, scroll position will be maintained from the end not usual start when items are added to/removed from start. It's recommended to set false if you add to/remove from mid/end of the list because it can cause unexpected behavior. This prop is useful for reverse infinite scrolling.
Pick.shift
optionalref: (handle?) =>void
Get reference to VirtualizerHandle.
void
Pick.ref
data:
T[]
The data items rendered by this component.
Pick.data
optionaloverscan:number
Number of items to render above/below the visible bounds of the list. Lower value will give better performance but you can increase to avoid showing blank items in fast scrolling.
4Pick.overscan
optionalitemSize:number
Item size hint for unmeasured items. It will help to reduce scroll jump when items are measured if used properly.
- If not set, initial item sizes will be automatically estimated from measured sizes. This is recommended for most cases.
- If set, you can opt out estimation and use the value as initial item size.
Pick.itemSize
optionalhorizontal:boolean
If true, rendered as a horizontally scrollable list. Otherwise rendered as a vertically scrollable list.
Pick.horizontal
optionalonScrollEnd: () =>void
Callback invoked when scrolling stops.
void
Pick.onScrollEnd
optionalid:string
ViewportComponentAttributes.id
node_modules/solid-js/types/jsx.d.ts:899
optionalrole:"grid"|"table"|"none"|"search"|"link"|"article"|"button"|"dialog"|"figure"|"form"|"img"|"main"|"menu"|"menuitem"|"meter"|"option"|"switch"|"row"|"checkbox"|"listbox"|"radio"|"region"|"cell"|"listitem"|"menubar"|"progressbar"|"separator"|"tab"|"tabpanel"|"toolbar"|"tooltip"|"treeitem"|"scrollbar"|"alert"|"alertdialog"|"application"|"banner"|"columnheader"|"combobox"|"complementary"|"contentinfo"|"definition"|"directory"|"document"|"feed"|"gridcell"|"group"|"heading"|"list"|"log"|"marquee"|"math"|"menuitemcheckbox"|"menuitemradio"|"navigation"|"note"|"presentation"|"radiogroup"|"rowgroup"|"rowheader"|"searchbox"|"slider"|"spinbutton"|"status"|"tablist"|"term"|"textbox"|"timer"|"tree"|"treegrid"
ViewportComponentAttributes.role
node_modules/solid-js/types/jsx.d.ts:808
optionaltabIndex:string|number
ViewportComponentAttributes.tabIndex
node_modules/solid-js/types/jsx.d.ts:939
optionalonKeyDown:EventHandlerUnion<HTMLElement,KeyboardEvent,EventHandler<HTMLElement,KeyboardEvent>>
ViewportComponentAttributes.onKeyDown
node_modules/solid-js/types/jsx.d.ts:255
optionalonWheel:EventHandlerUnion<HTMLElement,WheelEvent,EventHandler<HTMLElement,WheelEvent>>
ViewportComponentAttributes.onWheel
node_modules/solid-js/types/jsx.d.ts:304
optionalclass:string
ViewportComponentAttributes.class
node_modules/solid-js/types/jsx.d.ts:893
optionalaria-activedescendant:string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
ViewportComponentAttributes.aria-activedescendant
node_modules/solid-js/types/jsx.d.ts:533
optionalaria-atomic:boolean|"false"|"true"
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.
ViewportComponentAttributes.aria-atomic
node_modules/solid-js/types/jsx.d.ts:538
optionalaria-autocomplete:"inline"|"none"|"both"|"list"
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.
ViewportComponentAttributes.aria-autocomplete
node_modules/solid-js/types/jsx.d.ts:544
optionalaria-busy:boolean|"false"|"true"
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
ViewportComponentAttributes.aria-busy
node_modules/solid-js/types/jsx.d.ts:549
optionalaria-checked:boolean|"mixed"|"false"|"true"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
- aria-pressed
- aria-selected.
ViewportComponentAttributes.aria-checked
node_modules/solid-js/types/jsx.d.ts:555
optionalaria-colcount:string|number
Defines the total number of columns in a table, grid, or treegrid.
aria-colindex.
ViewportComponentAttributes.aria-colcount
node_modules/solid-js/types/jsx.d.ts:561
optionalaria-colindex:string|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.
ViewportComponentAttributes.aria-colindex
node_modules/solid-js/types/jsx.d.ts:568
optionalaria-colspan:string|number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
- aria-colindex
- aria-rowspan.
ViewportComponentAttributes.aria-colspan
node_modules/solid-js/types/jsx.d.ts:575
optionalaria-controls:string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-owns.
ViewportComponentAttributes.aria-controls
node_modules/solid-js/types/jsx.d.ts:582
optionalaria-current:boolean|"time"|"page"|"false"|"true"|"location"|"date"|"step"
Indicates the element that represents the current item within a container or set of related elements.
ViewportComponentAttributes.aria-current
node_modules/solid-js/types/jsx.d.ts:587
optionalaria-describedby:string
Identifies the element (or elements) that describes the object.
aria-labelledby
ViewportComponentAttributes.aria-describedby
node_modules/solid-js/types/jsx.d.ts:602
optionalaria-details:string
Identifies the element that provides a detailed, extended description for the object.
aria-describedby.
ViewportComponentAttributes.aria-details
node_modules/solid-js/types/jsx.d.ts:608
optionalaria-disabled:boolean|"false"|"true"
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
- aria-hidden
- aria-readonly.
ViewportComponentAttributes.aria-disabled
node_modules/solid-js/types/jsx.d.ts:615
optionalaria-dropeffect:"copy"|"none"|"link"|"move"|"execute"|"popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
In ARIA 1.1
ViewportComponentAttributes.aria-dropeffect
node_modules/solid-js/types/jsx.d.ts:622
optionalaria-errormessage:string
Identifies the element that provides an error message for the object.
- aria-invalid
- aria-describedby.
ViewportComponentAttributes.aria-errormessage
node_modules/solid-js/types/jsx.d.ts:628
optionalaria-expanded:boolean|"false"|"true"
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
ViewportComponentAttributes.aria-expanded
node_modules/solid-js/types/jsx.d.ts:633
optionalaria-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.
ViewportComponentAttributes.aria-flowto
node_modules/solid-js/types/jsx.d.ts:639
optionalaria-grabbed:boolean|"false"|"true"
Indicates an element's "grabbed" state in a drag-and-drop operation.
In ARIA 1.1
ViewportComponentAttributes.aria-grabbed
node_modules/solid-js/types/jsx.d.ts:645
optionalaria-haspopup:boolean|"grid"|"dialog"|"menu"|"listbox"|"false"|"true"|"tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
ViewportComponentAttributes.aria-haspopup
node_modules/solid-js/types/jsx.d.ts:650
aria-hidden?
optionalaria-hidden:boolean|"false"|"true"
Indicates whether the element is exposed to an accessibility API.
aria-disabled.
ViewportComponentAttributes.aria-hidden
node_modules/solid-js/types/jsx.d.ts:665
optionalaria-invalid:boolean|"false"|"true"|"grammar"|"spelling"
Indicates the entered value does not conform to the format expected by the application.
aria-errormessage.
ViewportComponentAttributes.aria-invalid
node_modules/solid-js/types/jsx.d.ts:671
optionalaria-keyshortcuts:string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
ViewportComponentAttributes.aria-keyshortcuts
node_modules/solid-js/types/jsx.d.ts:676
optionalaria-label:string
Defines a string value that labels the current element.
aria-labelledby.
ViewportComponentAttributes.aria-label
node_modules/solid-js/types/jsx.d.ts:682
optionalaria-labelledby:string
Identifies the element (or elements) that labels the current element.
aria-describedby.
ViewportComponentAttributes.aria-labelledby
node_modules/solid-js/types/jsx.d.ts:688
optionalaria-level:string|number
Defines the hierarchical level of an element within a structure.
ViewportComponentAttributes.aria-level
node_modules/solid-js/types/jsx.d.ts:690
optionalaria-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.
ViewportComponentAttributes.aria-live
node_modules/solid-js/types/jsx.d.ts:695
optionalaria-modal:boolean|"false"|"true"
Indicates whether an element is modal when displayed.
ViewportComponentAttributes.aria-modal
node_modules/solid-js/types/jsx.d.ts:697
optionalaria-multiline:boolean|"false"|"true"
Indicates whether a text box accepts multiple lines of input or only a single line.
ViewportComponentAttributes.aria-multiline
node_modules/solid-js/types/jsx.d.ts:699
optionalaria-multiselectable:boolean|"false"|"true"
Indicates that the user may select more than one item from the current selectable descendants.
ViewportComponentAttributes.aria-multiselectable
node_modules/solid-js/types/jsx.d.ts:704
optionalaria-orientation:"horizontal"|"vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
ViewportComponentAttributes.aria-orientation
node_modules/solid-js/types/jsx.d.ts:706
optionalaria-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.
ViewportComponentAttributes.aria-owns
node_modules/solid-js/types/jsx.d.ts:714
optionalaria-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.
ViewportComponentAttributes.aria-placeholder
node_modules/solid-js/types/jsx.d.ts:720
optionalaria-posinset:string|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.
ViewportComponentAttributes.aria-posinset
node_modules/solid-js/types/jsx.d.ts:727
optionalaria-pressed:boolean|"mixed"|"false"|"true"
Indicates the current "pressed" state of toggle buttons.
- aria-checked
- aria-selected.
ViewportComponentAttributes.aria-pressed
node_modules/solid-js/types/jsx.d.ts:733
optionalaria-readonly:boolean|"false"|"true"
Indicates that the element is not editable, but is otherwise operable.
aria-disabled.
ViewportComponentAttributes.aria-readonly
node_modules/solid-js/types/jsx.d.ts:739
optionalaria-relevant:"text"|"all"|"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.
ViewportComponentAttributes.aria-relevant
node_modules/solid-js/types/jsx.d.ts:746
optionalaria-required:boolean|"false"|"true"
Indicates that user input is required on the element before a form may be submitted.
ViewportComponentAttributes.aria-required
node_modules/solid-js/types/jsx.d.ts:759
optionalaria-roledescription:string
Defines a human-readable, author-localized description for the role of an element.
ViewportComponentAttributes.aria-roledescription
node_modules/solid-js/types/jsx.d.ts:761
optionalaria-rowcount:string|number
Defines the total number of rows in a table, grid, or treegrid.
aria-rowindex.
ViewportComponentAttributes.aria-rowcount
node_modules/solid-js/types/jsx.d.ts:767
optionalaria-rowindex:string|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.
ViewportComponentAttributes.aria-rowindex
node_modules/solid-js/types/jsx.d.ts:774
optionalaria-rowspan:string|number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
- aria-rowindex
- aria-colspan.
ViewportComponentAttributes.aria-rowspan
node_modules/solid-js/types/jsx.d.ts:780
optionalaria-selected:boolean|"false"|"true"
Indicates the current "selected" state of various widgets.
- aria-checked
- aria-pressed.
ViewportComponentAttributes.aria-selected
node_modules/solid-js/types/jsx.d.ts:786
optionalaria-setsize:string|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.
ViewportComponentAttributes.aria-setsize
node_modules/solid-js/types/jsx.d.ts:793
optionalaria-sort:"none"|"ascending"|"descending"|"other"
Indicates if items in a table or grid are sorted in ascending or descending order.
ViewportComponentAttributes.aria-sort
node_modules/solid-js/types/jsx.d.ts:795
optionalaria-valuemax:string|number
Defines the maximum allowed value for a range widget.
ViewportComponentAttributes.aria-valuemax
node_modules/solid-js/types/jsx.d.ts:797
optionalaria-valuemin:string|number
Defines the minimum allowed value for a range widget.
ViewportComponentAttributes.aria-valuemin
node_modules/solid-js/types/jsx.d.ts:799
optionalaria-valuenow:string|number
Defines the current value for a range widget.
aria-valuetext.
ViewportComponentAttributes.aria-valuenow
node_modules/solid-js/types/jsx.d.ts:805
optionalaria-valuetext:string
Defines the human readable text alternative of aria-valuenow for a range widget.
ViewportComponentAttributes.aria-valuetext
node_modules/solid-js/types/jsx.d.ts:807
optionalstyle:CSSProperties
ViewportComponentAttributes.style