@livekit/components-js-docs 0.0.2 → 0.0.4

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useParticipantTile (hook)
+# useParticipantTile
 
 ## Import
 
@@ -8,14 +8,13 @@
 import { useParticipantTile } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter                                                                                      | Type                                                                           | Description |
-| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------- |
-| { participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, } | [UseParticipantTileProps](./react/useparticipanttileprops.md)<!-- -->&lt;T&gt; |             |
+{% parameter name="{ participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, }" type="UseParticipantTileProps<T>" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ elementProps: React.HTMLAttributes&lt;T&gt;; }
+`{     elementProps: React.HTMLAttributes<T>; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# usePinnedTracks (hook)
+# usePinnedTracks
 
 ## Import
 
@@ -8,14 +8,13 @@
 import { usePinnedTracks } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter     | Type                                              | Description  |
-| ------------- | ------------------------------------------------- | ------------ |
-| layoutContext | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
+{% parameter name="layoutContext" type="LayoutContextType" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]
+`TrackReferenceOrPlaceholder[]`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# usePreviewDevice (hook)
+# usePreviewDevice
 
 ## Import
 
@@ -8,16 +8,19 @@
 import { usePreviewDevice } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter | Type                         | Description |
-| --------- | ---------------------------- | ----------- |
-| enabled   | boolean                      |             |
-| deviceId  | string                       |             |
-| kind      | 'videoinput' \| 'audioinput' |             |
+{% parameter name="deviceId" type="string" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="enabled" type="boolean" optional=false %}
+{% /parameter %}
 
-{ selectedDevice: MediaDeviceInfo \| undefined; localTrack: T \| undefined; deviceError: Error \| null; }
+{% parameter name="kind" type="'videoinput' | 'audioinput'" optional=false %}
+{% /parameter %}
+
+## Returns
+
+`{     selectedDevice: MediaDeviceInfo | undefined;     localTrack: T | undefined;     deviceError: Error | null; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useRemoteParticipant (hook)
+# useRemoteParticipant
 
 ## Import
 
@@ -8,15 +8,16 @@
 import { useRemoteParticipant } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter | Type                                                                  | Description  |
-| --------- | --------------------------------------------------------------------- | ------------ |
-| identity  | string                                                                |              |
-| options   | [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | _(Optional)_ |
+{% parameter name="identity" type="string" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="options" type="UseRemoteParticipantOptions" optional=true %}
+{% /parameter %}
 
-RemoteParticipant \| undefined
+## Returns
+
+`RemoteParticipant | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useRemoteParticipants (hook)
+# useRemoteParticipants
 
 The useRemoteParticipants
 
@@ -10,14 +10,13 @@ The useRemoteParticipants
 import { useRemoteParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter | Type                                                                    | Description  |
-| --------- | ----------------------------------------------------------------------- | ------------ |
-| options   | [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | _(Optional)_ |
+{% parameter name="options" type="UseRemoteParticipantsOptions" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-RemoteParticipant\[\]
+`RemoteParticipant[]`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useRoomContext (hook)
+# useRoomContext
 
 Ensures that a room is provided via context. If no room is provided, an error is thrown.
 
@@ -10,8 +10,8 @@ Ensures that a room is provided via context. If no room is provided, an error is
 import { useRoomContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-**Returns:**
+## Returns
 
-Room
+`Room`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useRoomInfo (hook)
+# useRoomInfo
 
 ## Import
 
@@ -8,14 +8,13 @@
 import { useRoomInfo } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter | Type                                                | Description  |
-| --------- | --------------------------------------------------- | ------------ |
-| options   | [UseRoomInfoOptions](./react/useroominfooptions.md) | _(Optional)_ |
+{% parameter name="options" type="UseRoomInfoOptions" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ name: string; metadata: string \| undefined; }
+`{     name: string;     metadata: string | undefined; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useSortedParticipants (hook)
+# useSortedParticipants
 
 The useSortedParticipants hook returns the only the active speakers of all participants.
 
@@ -10,14 +10,13 @@ The useSortedParticipants hook returns the only the active speakers of all parti
 import { useSortedParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter    | Type                     | Description |
-| ------------ | ------------------------ | ----------- |
-| participants | Array&lt;Participant&gt; |             |
+{% parameter name="participants" type="Array<Participant>" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-Participant\[\]
+`Participant[]`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useSpeakingParticipants (hook)
+# useSpeakingParticipants
 
 The useSpeakingParticipants hook returns the only the active speakers of all participants.
 
@@ -10,8 +10,8 @@ The useSpeakingParticipants hook returns the only the active speakers of all par
 import { useSpeakingParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-**Returns:**
+## Returns
 
-import("livekit-client").Participant\[\]
+`import("livekit-client").Participant[]`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useToken (hook)
+# useToken
 
 ## Import
 
@@ -8,16 +8,19 @@
 import { useToken } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter     | Type                                          | Description  |
-| ------------- | --------------------------------------------- | ------------ |
-| tokenEndpoint | string \| undefined                           |              |
-| roomName      | string                                        |              |
-| options       | [UseTokenOptions](./react/usetokenoptions.md) | _(Optional)_ |
+{% parameter name="roomName" type="string" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="tokenEndpoint" type="string | undefined" optional=false %}
+{% /parameter %}
 
-string \| undefined
+{% parameter name="options" type="UseTokenOptions" optional=true %}
+{% /parameter %}
+
+## Returns
+
+`string | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useTrackContext (hook)
+# useTrackContext
 
 Ensures that a track reference is provided via context. If not inside a `TrackContext`<!-- -->, an error is thrown.
 
@@ -10,8 +10,8 @@ Ensures that a track reference is provided via context. If not inside a `TrackCo
 import { useTrackContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-**Returns:**
+## Returns
 
-[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
+`TrackReferenceOrPlaceholder`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useTrackMutedIndicator (hook)
+# useTrackMutedIndicator
 
 ## Import
 
@@ -8,15 +8,16 @@
 import { useTrackMutedIndicator } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter | Type                                                                      | Description  |
-| --------- | ------------------------------------------------------------------------- | ------------ |
-| source    | Track.Source                                                              |              |
-| options   | [UseTrackMutedIndicatorOptions](./react/usetrackmutedindicatoroptions.md) | _(Optional)_ |
+{% parameter name="source" type="Track.Source" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="options" type="UseTrackMutedIndicatorOptions" optional=true %}
+{% /parameter %}
 
-{ isMuted: boolean; className: string; }
+## Returns
+
+`{     isMuted: boolean;     className: string; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useTracks (hook)
+# useTracks
 
 The `useTracks` hook returns an array of `TrackReference` or `TrackReferenceOrPlaceholder` depending on the provided `sources` property. If only subscribed tracks are desired, set the `onlySubscribed` property to `true`<!-- -->.
 
@@ -27,15 +27,16 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
 ]);
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 2} /%}
 
 ## Parameters
 
-| Parameter | Type                                            | Description  |
-| --------- | ----------------------------------------------- | ------------ |
-| sources   | T                                               | _(Optional)_ |
-| options   | [UseTracksOptions](./react/usetracksoptions.md) | _(Optional)_ |
+{% parameter name="options" type="UseTracksOptions" optional=true %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="sources" type="T" optional=true %}
+{% /parameter %}
 
-[UseTracksHookReturnType](./react/usetrackshookreturntype.md)<!-- -->&lt;T&gt;
+## Returns
+
+`UseTracksHookReturnType<T>`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useTrackToggle (hook)
+# useTrackToggle
 
 ## Import
 
@@ -8,14 +8,13 @@
 import { useTrackToggle } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter                                                   | Type                                                                   | Description |
-| ----------------------------------------------------------- | ---------------------------------------------------------------------- | ----------- |
-| { source, onChange, initialState, captureOptions, ...rest } | [UseTrackToggleProps](./react/usetracktoggleprops.md)<!-- -->&lt;T&gt; |             |
+{% parameter name="{ source, onChange, initialState, captureOptions, ...rest }" type="UseTrackToggleProps<T>" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ toggle: ((forceState?: boolean \| undefined) =&gt; void) \| ((forceState?: boolean \| undefined, captureOptions?: import("@livekit/components-core").[CaptureOptionsBySource](./core/captureoptionsbysource.md)<!-- -->&lt;T&gt; \| undefined) =&gt; Promise&lt;void&gt;); enabled: boolean; pending: boolean; track: import("livekit-client").LocalTrackPublication \| undefined; buttonProps: React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;; }
+`{     toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>);     enabled: boolean;     pending: boolean;     track: import("livekit-client").LocalTrackPublication | undefined;     buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useVisualStableUpdate (hook)
+# 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.
 
@@ -14,16 +14,19 @@ Updating works with pagination. For example, if a participant starts speaking on
 import { useVisualStableUpdate } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
-| Parameter       | Type                                                                             | Description  |
-| --------------- | -------------------------------------------------------------------------------- | ------------ |
-| trackReferences | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |              |
-| maxItemsOnPage  | number                                                                           |              |
-| options         | [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md)          | _(Optional)_ |
+{% parameter name="maxItemsOnPage" type="number" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="trackReferences" type="TrackReferenceOrPlaceholder[]" optional=false %}
+{% /parameter %}
 
-[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]
+{% parameter name="options" type="UseVisualStableUpdateOptions" optional=true %}
+{% /parameter %}
+
+## Returns
+
+`TrackReferenceOrPlaceholder[]`

package/generated-docs/react/index.md

@@ -6,7 +6,7 @@
 
 | Component                                                                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| [AudioTrack({ onSubscriptionStatusChanged, volume, ...props })](./react/component/audiotrack.md)                                                                                                        | The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property.                                                                                                                                                                                                               |
+| [AudioTrack({ onSubscriptionStatusChanged, volume, source, name, publication, participant: p, ...props })](./react/component/audiotrack.md)                                                             | The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property.                                                                                                                                                                                                               |
 | [AudioVisualizer({ participant, ...props })](./react/component/audiovisualizer.md)                                                                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [CarouselView({ tracks, orientation, ...props })](./react/component/carouselview.md)                                                                                                                    | The <code>CarouselLayout</code> displays a list of tracks horizontally or vertically. Depending on the size of the container, the carousel will display as many tiles as possible and overflows the rest. The CarouselLayout uses the <code>useVisualStableUpdate</code> hook to ensure that tile reordering due to track updates is visually stable but still moves the important tiles (speaking participants) to the front. |
 | [ChatEntry({ entry, hideName, hideTimestamp, messageFormatter, ...props })](./react/component/chatentry.md)                                                                                             | The <code>ChatEntry</code> component holds and displays one chat message.                                                                                                                                                                                                                                                                                                                                                      |
@@ -19,7 +19,6 @@
 | [FocusLayout({ track, ...htmlProps })](./react/component/focuslayout.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [FocusLayoutContainer(props)](./react/component/focuslayoutcontainer.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [FocusToggle({ trackSource, participant, ...props })](./react/component/focustoggle.md)                                                                                                                 | The FocusToggle puts the ParticipantTile in focus or removes it from focus.                                                                                                                                                                                                                                                                                                                                                    |
-| [formatChatMessageLinks(message)](./react/component/formatchatmessagelinks.md)                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [GridLayout({ tracks, ...props })](./react/component/gridlayout.md)                                                                                                                                     | The GridLayout component displays the nested participants in a grid where every participants has the same size.                                                                                                                                                                                                                                                                                                                |
 | [LiveKitRoom(props)](./react/component/livekitroom.md)                                                                                                                                                  | The LiveKitRoom component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself.                                                                                                                              |
 | [MediaDeviceSelect({ kind, initialSelection, onActiveDeviceChange, onDeviceListChange, onDeviceSelectError, exactMatch, track, requestPermissions, ...props })](./react/component/mediadeviceselect.md) | The MediaDeviceSelect list all media devices of one kind. Clicking on one of the listed devices make it the active media device.                                                                                                                                                                                                                                                                                               |
@@ -35,24 +34,24 @@
 | [TrackLoop({ tracks, ...props })](./react/component/trackloop.md)                                                                                                                                       | The TrackLoop component loops over tracks. It is for example a easy way to loop over all participant camera and screen share tracks. TrackLoop creates a TrackContext for each track that you can use to e.g. render the track.                                                                                                                                                                                                |
 | [TrackMutedIndicator({ source, participant, show, ...props })](./react/component/trackmutedindicator.md)                                                                                                | The TrackMutedIndicator shows whether the participant's camera or microphone is muted or not.                                                                                                                                                                                                                                                                                                                                  |
 | [TrackToggle({ showIcon, ...props })](./react/component/tracktoggle.md)                                                                                                                                 | With the TrackToggle component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button.                                                                                                                                                                                                                                       |
-| [VideoTrack({ onTrackClick, onClick, onSubscriptionStatusChanged, name, publication, source, ...props })](./react/component/videotrack.md)                                                              | The VideoTrack component is responsible for rendering participant video tracks like <code>camera</code> and <code>screen_share</code>. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property.                                                                                                                                                        |
+| [VideoTrack({ onTrackClick, onClick, onSubscriptionStatusChanged, name, publication, source, participant: p, manageSubscription, ...props })](./react/component/videotrack.md)                          | The VideoTrack component is responsible for rendering participant video tracks like <code>camera</code> and <code>screen_share</code>. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property.                                                                                                                                                        |
 
 ## Prefabs
 
 | Prefab                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                               |
 | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [AudioConference({ ...props })](./react/component/audioconference.md)                                                                               | This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view.                                                                                                                                                                                   |
-| [Chat({ messageFormatter, ...props })](./react/component/chat.md)                                                                                   | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message.                                                                                                                                    |
+| [Chat({ messageFormatter, messageDecoder, messageEncoder, ...props })](./react/component/chat.md)                                                   | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message.                                                                                                                                    |
 | [ControlBar({ variation, controls, ...props })](./react/component/controlbar.md)                                                                    | The ControlBar prefab component gives the user the basic user interface to control their media devices and leave the room.                                                                                                                                                                                                                                |
 | [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md)     | The MediaDeviceMenu prefab component is a button that opens a menu that lists all media devices and allows the user to select them.                                                                                                                                                                                                                       |
 | [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, ...htmlProps })](./react/component/prejoin.md) | The PreJoin prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the LiveKitRoom so that the user enters the room with the correct media devices. |
-| [VideoConference({ chatMessageFormatter, ...props })](./react/component/videoconference.md)                                                         | This component is the default setup of a classic LiveKit video conferencing app. It provides functionality like switching between participant grid view and focus view.                                                                                                                                                                                   |
+| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, ...props })](./react/component/videoconference.md)                 | This component is the default setup of a classic LiveKit video conferencing app. It provides functionality like switching between participant grid view and focus view.                                                                                                                                                                                   |
 
 ## Hooks
 
 | Hook                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| [useChat()](./react/hook/usechat.md)                                                                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useChat(options)](./react/hook/usechat.md)                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | [useChatToggle({ props })](./react/hook/usechattoggle.md)                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | [useClearPinButton(props)](./react/hook/useclearpinbutton.md)                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
@@ -125,6 +124,7 @@
 | [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md)                 |                                                                                                                                                 |
 | [FocusLayoutProps](./react/focuslayoutprops.md)                                   |                                                                                                                                                 |
 | [FocusToggleProps](./react/focustoggleprops.md)                                   |                                                                                                                                                 |
+| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md)              |                                                                                                                                                 |
 | [GridLayoutProps](./react/gridlayoutprops.md)                                     |                                                                                                                                                 |
 | [LayoutContext](./react/layoutcontext.md)                                         |                                                                                                                                                 |
 | [LayoutContextType](./react/layoutcontexttype.md)                                 |                                                                                                                                                 |
@@ -132,6 +132,8 @@
 | [LocalUserChoices](./react/localuserchoices.md)                                   |                                                                                                                                                 |
 | [MediaDeviceMenuProps](./react/mediadevicemenuprops.md)                           |                                                                                                                                                 |
 | [MediaDeviceSelectProps](./react/mediadeviceselectprops.md)                       |                                                                                                                                                 |
+| [MessageDecoder](./react/messagedecoder.md)                                       |                                                                                                                                                 |
+| [MessageEncoder](./react/messageencoder.md)                                       |                                                                                                                                                 |
 | [MessageFormatter](./react/messageformatter.md)                                   |                                                                                                                                                 |
 | [ParticipantContext](./react/participantcontext.md)                               |                                                                                                                                                 |
 | [ParticipantLoopProps](./react/participantloopprops.md)                           |                                                                                                                                                 |

package/generated-docs/react/layoutcontext.md

@@ -8,4 +8,4 @@
 LayoutContext: React.Context<LayoutContextType | undefined>;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/layoutcontexttype.md

@@ -11,4 +11,4 @@ export type LayoutContextType = {
 };
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.audio.md

@@ -10,4 +10,4 @@ Publish audio immediately after connecting to your LiveKit room.
 audio?: AudioCaptureOptions | boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.connect.md

@@ -10,4 +10,4 @@ If set to true a connection to LiveKit room is initiated.
 connect?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.connectoptions.md

@@ -10,4 +10,4 @@ Define options how to connect to the LiveKit server.
 connectOptions?: RoomConnectOptions;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.md

@@ -10,7 +10,7 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
 
 **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onError'&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/livekitroomprops.options.md

@@ -10,4 +10,4 @@ Options for when creating a new room. When you pass your own room instance to th
 options?: RoomOptions;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.room.md

@@ -10,4 +10,4 @@ Optional room instance. By passing your own room instance you overwrite the `opt
 room?: Room;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.screen.md

@@ -10,4 +10,4 @@ Publish screen share immediately after connecting to your LiveKit room.
 screen?: ScreenShareCaptureOptions | boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.serverurl.md

@@ -10,4 +10,4 @@ URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simpli
 serverUrl: string | undefined;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.token.md

@@ -10,4 +10,4 @@ A user specific access token for a client to authenticate to the room. This toke
 token: string | undefined;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}