trait VirtuosoProps[D] extends Object
- Annotations
- @JSType() @native()
- Alphabetic
- By Inheritance
- VirtuosoProps
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val alignToBottom: UndefOr[Boolean]
Setting
alignToBottomtotruealigns the items to the bottom of the list if the list is shorter than the viewport.Setting
alignToBottomtotruealigns the items to the bottom of the list if the list is shorter than the viewport. UsefollowOutputproperty to keep the list aligned when new items are appended. - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val atBottomStateChange: UndefOr[Function1[Boolean, Unit]]
Called with true / false when the list has reached the bottom / gets scrolled up.
Called with true / false when the list has reached the bottom / gets scrolled up. Can be used to load newer items, like
tail -f. - val atTopStateChange: UndefOr[Function1[Boolean, Unit]]
Called with
true/falsewhen the list has reached the top / gets scrolled down. - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val computeItemKey: UndefOr[Function1[Double, japgolly.scalajs.react.Key]]
If specified, the component will use the function to generate the
keyproperty for each list item. - val data: UndefOr[Array[D]]
The data items to be rendered.
The data items to be rendered. If data is set, the total count will be inferred from the length of the array.
- val defaultItemHeight: UndefOr[JsNumber]
By default, the component assumes the default item height from the first rendered item (rendering it as a "probe").
By 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
defaultItemHeightcauses the component to skip the "probe" rendering and use the property value as default height instead. - val endReached: UndefOr[Function1[Double, Unit]]
Gets called when the user scrolls to the end of the list.
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.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val firstItemIndex: UndefOr[JsNumber]
Use when implementing inverse infinite scrolling - decrease the value this property in combination with
dataortotalCountto prepend items to the top of the list.Use when implementing inverse infinite scrolling - decrease the value this property in combination with
dataortotalCountto 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.
- val fixedItemHeight: UndefOr[JsNumber]
Can be used to improve performance if the rendered items are of known size.
Can be used to improve performance if the rendered items are of known size. Setting it causes the component to skip item measurements.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val headerFooterTag: UndefOr[String]
Set to customize the wrapper tag for the header and footer components (default is
div). - val initialItemCount: UndefOr[JsNumber]
Use for server-side rendering - if set, the list will render the specified amount of items regardless of the container / item size.
- val initialScrollTop: UndefOr[JsNumber]
Set this value to offset the initial location of the list.
Set 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
initialTopMostItemIndexinstead. - val initialTopMostItemIndex: UndefOr[JsNumber]
Set to a value between 0 and totalCount - 1 to make the list start scrolled to that item.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- val isScrolling: UndefOr[Function1[Boolean, Unit]]
Called when the list starts/stops scrolling.
- val itemContent: UndefOr[Function2[Double, D, Node]]
Set the callback to specify the contents of the item.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val overscan: UndefOr[|[JsNumber, OverScan]]
Increases the visual window which is used to calculate the rendered items with the specified **amount in pixels**.
Increases the visual window which is used to calculate the rendered items with the specified **amount in pixels**. Effectively, this makes the component "chunk" the rendering of new items by renderng more items than the necessary, but reducing the re-renders on scroll. Setting { main: number, reverse: number } lets you extend the list in both the main and the reverse scrollable directions.
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- val rangeChanged: UndefOr[Function1[ListRange, Unit]]
Called with the new set of items each time the list items are rendered due to scrolling.
- val startReached: UndefOr[Function1[Double, Unit]]
Called when the user scrolls to the start of the list.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- val topItemCount: UndefOr[JsNumber]
Set the amount of items to remain fixed at the top of the list.
Set the amount of items to remain fixed at the top of the list.
For a header that scrolls away when scrolling, check the
components.Headerproperty. - val totalCount: UndefOr[JsNumber]
The total amount of items to be rendered.
- val totalListHeightChanged: UndefOr[Function1[Double, Unit]]
Called when the total list height is changed due to new items or viewport resize.
- val useWindowScroll: UndefOr[Boolean]
Experimental - uses the document scroller rather than wrapping the list in its own.
- def valueOf(): Any
- Definition Classes
- Object
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated