@livekit/components-js-docs 0.0.5 → 0.1.0

package/generated-docs/react/hook/usetracktoggle.md

@@ -2,13 +2,22 @@
 
 # useTrackToggle
 
+The `useTrackToggle` hook is used to implement the `TrackToggle` component and returns state and functionality of the given track.
+
 ## Import
 
 ```typescript
 import { useTrackToggle } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Usage
+
+```tsx
+const { buttonProps, enabled } = useTrackToggle(trackRef);
+return <button {...buttonProps}>{enabled ? 'disable' : 'enable'}</button>;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Parameters
 

package/generated-docs/react/hook/usevisualstableupdate.md

@@ -2,11 +2,7 @@
 
 # useVisualStableUpdate
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-
-The useVisualStableUpdate hook tries to keep visual updates of the TackBundles array to a minimum, while still trying to display important tiles such as speaking participants or screen shares.
-
-Updating works with pagination. For example, if a participant starts speaking on the second page, they will be moved to the first page by replacing the least active/interesting participant on the first page.
+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. Updating the array can occur because attendees leave or join a room, or because they mute/unmute or start speaking.
 
 ## Import
 
@@ -14,7 +10,18 @@ Updating works with pagination. For example, if a participant starts speaking on
 import { useVisualStableUpdate } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Remarks
+
+The hook is used for the `GridLayout` and `CarouselLayout` components.
+
+## Usage
+
+```tsx
+const trackRefs = useTracks();
+const updatedTrackRefs = useVisualStableUpdate(trackRefs, itemPerPage);
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Parameters