@livekit/components-js-docs 0.1.1 → 0.1.3

package/generated-docs/react/carousellayoutprops.md

@@ -21,8 +21,8 @@ export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaEleme
 
 ## Properties
 
-| Property                                                   | Type                                                                             | Description                                                                                                                                         |
-| ---------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [children](./react/carousellayoutprops.children.md)        | React.ReactNode                                                                  |                                                                                                                                                     |
-| [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal'                                                       | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
-| [tracks](./react/carousellayoutprops.tracks.md)            | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |
+| Property                                                   | Type                                                                              | Description                                                                                                                                         |
+| ---------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [children](./react/carousellayoutprops.children.md)        | React.ReactNode                                                                   |                                                                                                                                                     |
+| [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal'                                                        | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
+| [tracks](./react/carousellayoutprops.tracks.md)            | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |

package/generated-docs/react/chatentryprops.md

@@ -23,9 +23,9 @@ export interface ChatEntryProps extends React.HTMLAttributes<HTMLLIElement>
 
 ## Properties
 
-| Property                                                        | Type                                                 | Description                                                                                                    |
-| --------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| [entry](./react/chatentryprops.entry.md)                        | [ReceivedChatMessage](./core/receivedchatmessage.md) | The chat massage object to display.                                                                            |
-| [hideName?](./react/chatentryprops.hidename.md)                 | boolean                                              | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
-| [hideTimestamp?](./react/chatentryprops.hidetimestamp.md)       | boolean                                              | _(Optional)_ Hide message timestamp.                                                                           |
-| [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md)      | _(Optional)_ An optional formatter for the message body.                                                       |
+| Property                                                        | Type                                                  | Description                                                                                                    |
+| --------------------------------------------------------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| [entry](./react/chatentryprops.entry.md)                        | [ReceivedChatMessage](./react/receivedchatmessage.md) | The chat massage object to display.                                                                            |
+| [hideName?](./react/chatentryprops.hidename.md)                 | boolean                                               | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
+| [hideTimestamp?](./react/chatentryprops.hidetimestamp.md)       | boolean                                               | _(Optional)_ Hide message timestamp.                                                                           |
+| [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md)       | _(Optional)_ An optional formatter for the message body.                                                       |

package/generated-docs/react/chatmessage.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "ChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface ChatMessage
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                      | Type   | Description |
+| --------------------------------------------- | ------ | ----------- |
+| [message](./react/chatmessage.message.md)     | string |             |
+| [timestamp](./react/chatmessage.timestamp.md) | number |             |

package/generated-docs/{core/participantclickevent.track.md → react/chatmessage.message.md}

@@ -1,13 +1,13 @@
 ---
-{ "title": "ParticipantClickEvent.track property" }
+{ "title": "ChatMessage.message property" }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ParticipantClickEvent.track property
+# ChatMessage.message property
 
 **Signature:**
 
 ```typescript
-track?: TrackPublication;
+message: string;
 ```

package/generated-docs/react/{chatprops.messageencoder.md → chatmessage.timestamp.md}

@@ -1,13 +1,13 @@
 ---
-{ "title": "ChatProps.messageEncoder property" }
+{ "title": "ChatMessage.timestamp property" }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ChatProps.messageEncoder property
+# ChatMessage.timestamp property
 
 **Signature:**
 
 ```typescript
-messageEncoder?: MessageEncoder;
+timestamp: number;
 ```

package/generated-docs/react/chatprops.md

@@ -12,10 +12,10 @@
 **Signature:**
 
 ```typescript
-export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>
+export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>, ChatOptions
 ```
 
-**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, ChatOptions
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
@@ -23,6 +23,4 @@ export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>
 
 | Property                                                   | Type                                            | Description  |
 | ---------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [messageDecoder?](./react/chatprops.messagedecoder.md)     | [MessageDecoder](./core/messagedecoder.md)      | _(Optional)_ |
-| [messageEncoder?](./react/chatprops.messageencoder.md)     | [MessageEncoder](./core/messageencoder.md)      | _(Optional)_ |
 | [messageFormatter?](./react/chatprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |

package/generated-docs/react/component/audiotrack.md

@@ -29,6 +29,11 @@ import { AudioTrack } from "@livekit/components-react";
 
 ## Properties
 
+{% parameter name="muted" type="boolean" optional=true %}
+_(Optional)_ Mutes the audio track if set to `true`<!-- -->.
+
+{% /parameter %}
+
 {% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
 _(Optional)_
 
@@ -40,7 +45,7 @@ _(Optional)_ The track reference of the track from which the audio is to be rend
 {% /parameter %}
 
 {% parameter name="volume" type="number" optional=true %}
-_(Optional)_ by the default the range is between 0 and 1
+_(Optional)_ Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.
 
 {% /parameter %}
 

package/generated-docs/react/component/chat.md

@@ -29,16 +29,6 @@ import { Chat } from "@livekit/components-react";
 
 ## Properties
 
-{% parameter name="messageDecoder" type="MessageDecoder" optional=true %}
-_(Optional)_
-
-{% /parameter %}
-
-{% parameter name="messageEncoder" type="MessageEncoder" optional=true %}
-_(Optional)_
-
-{% /parameter %}
-
 {% parameter name="messageFormatter" type="MessageFormatter" optional=true %}
 _(Optional)_
 

package/generated-docs/react/component/controlbar.md

@@ -38,6 +38,11 @@ _(Optional)_
 
 {% /parameter %}
 
+{% parameter name="saveUserChoices" type="boolean" optional=true %}
+_(Optional)_ If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
+
+{% /parameter %}
+
 {% parameter name="variation" type="'minimal' | 'verbose' | 'textOnly'" optional=true %}
 _(Optional)_
 

package/generated-docs/react/component/layoutcontextprovider.md

@@ -0,0 +1,35 @@
+---
+{
+  "title": "LayoutContextProvider",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/layout/LayoutContextProvider.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LayoutContextProvider
+
+## Import
+
+```typescript
+import { LayoutContextProvider } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="onPinChange" type="(state: PinState) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onWidgetChange" type="(state: WidgetState) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="value" type="LayoutContextType" optional=true %}
+_(Optional)_
+
+{% /parameter %}

package/generated-docs/react/component/livekitroom.md

@@ -64,6 +64,11 @@ _(Optional)_
 
 {% /parameter %}
 
+{% parameter name="onEncryptionError" type="(error: Error) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
 {% parameter name="onError" type="(error: Error) => void" optional=true %}
 _(Optional)_
 

package/generated-docs/react/component/mediadeviceselect.md

@@ -57,6 +57,11 @@ _(Optional)_
 
 {% /parameter %}
 
+{% parameter name="onError" type="(e: Error) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
 {% parameter name="requestPermissions" type="boolean" optional=true %}
 _(Optional)_ this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
 

package/generated-docs/react/component/prejoin.md

@@ -19,7 +19,7 @@ import { PreJoin } from "@livekit/components-react";
 
 ## Remarks
 
-This component is independent from the `LiveKitRoom` component and don't has to be nested inside it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
+This component is independent of the `LiveKitRoom` component and should not be nested within it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
 
 ## Usage
 
@@ -71,8 +71,8 @@ _(Optional)_ Provide your custom validation function. Only if validation is succ
 
 {% /parameter %}
 
-{% parameter name="showE2EEOptions" type="boolean" optional=true %}
-_(Optional)_
+{% parameter name="persistUserChoices" type="boolean" optional=true %}
+_(Optional)_ If true, user choices are persisted across sessions.
 
 {% /parameter %}
 
@@ -80,3 +80,12 @@ _(Optional)_
 _(Optional)_
 
 {% /parameter %}
+
+{% parameter name="showE2EEOptions" type="boolean" optional=true deprecated=true %}
+_(Optional)_
+
+{% callout type="caution" variation="compact" %}
+E2EE options will be removed from PreJoin in a future version \*
+
+{% /callout %}
+{% /parameter %}

package/generated-docs/react/component/roomaudiorenderer.md

@@ -26,3 +26,15 @@ import { RoomAudioRenderer } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="muted" type="boolean" optional=true %}
+_(Optional)_ If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
+
+{% /parameter %}
+
+{% parameter name="volume" type="number" optional=true %}
+_(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.
+
+{% /parameter %}

package/generated-docs/react/controlbarprops.md

@@ -21,7 +21,8 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
 
 ## Properties
 
-| Property                                           | Type                                                | Description  |
-| -------------------------------------------------- | --------------------------------------------------- | ------------ |
-| [controls?](./react/controlbarprops.controls.md)   | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_ |
-| [variation?](./react/controlbarprops.variation.md) | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_ |
+| Property                                                       | Type                                                | Description                                                                                                                                                           |
+| -------------------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [controls?](./react/controlbarprops.controls.md)               | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_                                                                                                                                                          |
+| [saveUserChoices?](./react/controlbarprops.saveuserchoices.md) | boolean                                             | _(Optional)_ If <code>true</code>, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room. |
+| [variation?](./react/controlbarprops.variation.md)             | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_                                                                                                                                                          |

package/generated-docs/react/controlbarprops.saveuserchoices.md

@@ -0,0 +1,17 @@
+---
+{ "title": "ControlBarProps.saveUserChoices property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ControlBarProps.saveUserChoices property
+
+If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
+
+**Signature:**
+
+```typescript
+saveUserChoices?: boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/focuslayoutcontainerprops.md

@@ -21,7 +21,7 @@ export interface FocusLayoutContainerProps extends React.HTMLAttributes<HTMLDivE
 
 ## Properties
 
-| Property                                                           | Type                                       | Description  |
-| ------------------------------------------------------------------ | ------------------------------------------ | ------------ |
-| [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md)     | [TrackReference](./core/trackreference.md) | _(Optional)_ |
-| [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt;                   | _(Optional)_ |
+| Property                                                           | Type                                        | Description  |
+| ------------------------------------------------------------------ | ------------------------------------------- | ------------ |
+| [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md)     | [TrackReference](./react/trackreference.md) | _(Optional)_ |
+| [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt;                    | _(Optional)_ |

package/generated-docs/react/focuslayoutprops.md

@@ -21,8 +21,8 @@ export interface FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
 
 ## Properties
 
-| Property                                                              | Type                                                                               | Description                                            |
-| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------ |
-| [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                           |
-| [track?](./react/focuslayoutprops.track.md)                           | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)               | _(Optional)_                                           |
-| [trackRef?](./react/focuslayoutprops.trackref.md)                     | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)               | _(Optional)_ The track to display in the focus layout. |
+| Property                                                              | Type                                                                  | Description                                            |
+| --------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------ |
+| [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: ParticipantClickEvent) =&gt; void                               | _(Optional)_                                           |
+| [track?](./react/focuslayoutprops.track.md)                           | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_                                           |
+| [trackRef?](./react/focuslayoutprops.trackref.md)                     | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track to display in the focus layout. |

package/generated-docs/react/focustoggleprops.md

@@ -21,8 +21,8 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
 
 ## Properties
 
-| Property                                                | Type                                                                 | Description  |
-| ------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
-| [participant?](./react/focustoggleprops.participant.md) | Participant                                                          | _(Optional)_ |
-| [trackRef?](./react/focustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
-| [trackSource?](./react/focustoggleprops.tracksource.md) | Track.Source                                                         | _(Optional)_ |
+| Property                                                | Type                                                                  | Description  |
+| ------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [participant?](./react/focustoggleprops.participant.md) | Participant                                                           | _(Optional)_ |
+| [trackRef?](./react/focustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
+| [trackSource?](./react/focustoggleprops.tracksource.md) | Track.Source                                                          | _(Optional)_ |

package/generated-docs/react/gridlayoutprops.md

@@ -21,7 +21,7 @@ export interface GridLayoutProps extends React.HTMLAttributes<HTMLDivElement>, P
 
 ## Properties
 
-| Property                                        | Type                                                                             | Description |
-| ----------------------------------------------- | -------------------------------------------------------------------------------- | ----------- |
-| [children](./react/gridlayoutprops.children.md) | React.ReactNode                                                                  |             |
-| [tracks](./react/gridlayoutprops.tracks.md)     | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |             |
+| Property                                        | Type                                                                              | Description |
+| ----------------------------------------------- | --------------------------------------------------------------------------------- | ----------- |
+| [children](./react/gridlayoutprops.children.md) | React.ReactNode                                                                   |             |
+| [tracks](./react/gridlayoutprops.tracks.md)     | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] |             |

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

@@ -0,0 +1,34 @@
+---
+{
+  "title": "useAudioPlayback",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAudioPlayback.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useAudioPlayback
+
+In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The `useAudioPlayback` hook returns an object with a boolean `canPlayAudio` flag that indicates whether audio playback is allowed in the current context, as well as a `startAudio` function that can be called in a button `onClick` callback to start audio playback in the current context.
+
+## Import
+
+```typescript
+import { useAudioPlayback } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+  canPlayAudio: boolean;
+  startAudio: () => Promise<void>;
+}
+```

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

@@ -25,10 +25,7 @@ It is possible to pass configurations for custom message encoding and decoding.
 
 ## Properties
 
-{% parameter name="options" type="{
-      messageEncoder?: MessageEncoder;
-      messageDecoder?: MessageDecoder;
-  }" optional=true %}
+{% parameter name="options" type="ChatOptions" optional=true %}
 {% /parameter %}
 
 ## Returns
@@ -36,7 +33,7 @@ It is possible to pass configurations for custom message encoding and decoding.
 ```typescript
 {
     send: ((message: string) => Promise<void>) | undefined;
-    chatMessages: import("@livekit/components-core").ReceivedChatMessage[];
+    chatMessages: ReceivedChatMessage[];
     isSending: boolean;
 }
 ```

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

@@ -0,0 +1,35 @@
+---
+{
+  "title": "useFacingMode",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useFacingMode.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useFacingMode
+
+Try to determine the `facingMode` of a local participant video track.
+
+## Import
+
+```typescript
+import { useFacingMode } from "@livekit/components-react";
+```
+
+## Remarks
+
+Works only on local video tracks.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="trackReference" type="TrackReferenceOrPlaceholder" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+"user" | "environment" | "left" | "right" | "undefined";
+```

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

@@ -0,0 +1,29 @@
+---
+{
+  "title": "useIsEncrypted",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useIsEncrypted.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useIsEncrypted
+
+## Import
+
+```typescript
+import { useIsEncrypted } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+boolean;
+```

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

@@ -59,6 +59,9 @@ Define options how to connect to the LiveKit server.
 {% parameter name="onDisconnected" type="() => void" optional=true %}
 {% /parameter %}
 
+{% parameter name="onEncryptionError" type="(error: Error) => void" optional=true %}
+{% /parameter %}
+
 {% parameter name="onError" type="(error: Error) => void" optional=true %}
 {% /parameter %}
 

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

@@ -32,6 +32,11 @@ const { devices, activeDeviceId, setActiveMediaDevice } = useMediaDeviceSelect({
 {% parameter name="kind" type="MediaDeviceKind" optional=false %}
 {% /parameter %}
 
+{% parameter name="onError" type="(e: Error) => void" optional=true %}
+this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the `requestPermissions` option is set to `true`<!-- -->. Most commonly this will emit a MediaDeviceError
+
+{% /parameter %}
+
 {% parameter name="requestPermissions" type="boolean" optional=true %}
 this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
 

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

@@ -0,0 +1,52 @@
+---
+{
+  "title": "usePagination",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/usePagination.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePagination
+
+The `usePagination` hook implements simple pagination logic for use with arrays.
+
+## Import
+
+```typescript
+import { usePagination } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const tracks = useTracks();
+const pagination = usePagination(4, tracks);
+
+<TrackLoop tracks={pagination.tracks} />;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="itemPerPage" type="number" optional=false %}
+{% /parameter %}
+
+{% parameter name="trackReferences" type="TrackReferenceOrPlaceholder[]" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    totalPageCount: number;
+    nextPage: () => void;
+    prevPage: () => void;
+    setPage: (num: number) => void;
+    firstItemIndex: number;
+    lastItemIndex: number;
+    tracks: TrackReferenceOrPlaceholder[];
+    currentPage: number;
+}
+```

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

@@ -0,0 +1,38 @@
+---
+{
+  "title": "usePersistentUserChoices",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/usePersistentUserChoices.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePersistentUserChoices
+
+A hook that provides access to user choices stored in local storage, such as selected media devices and their current state (on or off), as well as the user name.
+
+## Import
+
+```typescript
+import { usePersistentUserChoices } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="options" type="UsePersistentUserChoicesOptions" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    userChoices: LocalUserChoices;
+    saveAudioInputEnabled: (isEnabled: boolean) => void;
+    saveVideoInputEnabled: (isEnabled: boolean) => void;
+    saveAudioInputDeviceId: (deviceId: string) => void;
+    saveVideoInputDeviceId: (deviceId: string) => void;
+    saveUsername: (username: string) => void;
+}
+```