useVisualStableUpdate
The useVisualStableUpdate
hook is used to prevent visually jarring jumps and shifts of elements in an array. The algorithm only starts to update when there are more items than visually fit on a page. If this is the case, it will make sure that speaking participants move to the first page and are always visible.
Import
import { useVisualStableUpdate } from "@livekit/components-react";
Remarks
Updating the array can occur because attendees leave or join a room, or because they mute/unmute or start speaking. The hook is used for the GridLayout
and CarouselLayout
components.
Usage
const trackRefs = useTracks();const updatedTrackRefs = useVisualStableUpdate(trackRefs, itemPerPage);
Properties
maxItemsOnPage
number
trackReferences
TrackReferenceOrPlaceholder[]
options?
UseVisualStableUpdateOptions
Returns
TrackReferenceOrPlaceholder[]