@livekit/components-js-docs 0.0.2 → 0.0.3

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useConnectionState (hook)
+# useConnectionState
 
 The `useConnectionState` hook allows you to simply implement your own `ConnectionState` component.
 
@@ -20,10 +20,9 @@ const connectionState = useConnectionState(room);
 
 ## Parameters
 
-| Parameter | Type | Description  |
-| --------- | ---- | ------------ |
-| room      | Room | _(Optional)_ |
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-import("livekit-client").ConnectionState
+`import("livekit-client").ConnectionState`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useCreateLayoutContext (hook)
+# useCreateLayoutContext
 
 ## Import
 
@@ -10,6 +10,6 @@ import { useCreateLayoutContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-[LayoutContextType](./react/layoutcontexttype.md)
+`LayoutContextType`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useDataChannel (hook)
+# useDataChannel
 
 ## Import
 
@@ -12,11 +12,12 @@ import { useDataChannel } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                                                    | Description  |
-| --------- | --------------------------------------------------------------------------------------- | ------------ |
-| topic     | T                                                                                       |              |
-| onMessage | (msg: [ReceivedDataMessage](./core/receiveddatamessage.md)<!-- -->&lt;T&gt;) =&gt; void | _(Optional)_ |
+{% parameter name="topic" type="T" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="onMessage" type="(msg: ReceivedDataMessage<T>) => void" optional=true %}
+{% /parameter %}
 
-UseDataChannelReturnType&lt;T&gt;
+## Returns
+
+`UseDataChannelReturnType<T>`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useDataChannel (hook)
+# useDataChannel
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useDataChannel } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                                           | Description  |
-| --------- | ------------------------------------------------------------------------------ | ------------ |
-| onMessage | (msg: [ReceivedDataMessage](./core/receiveddatamessage.md)<!-- -->) =&gt; void | _(Optional)_ |
+{% parameter name="onMessage" type="(msg: ReceivedDataMessage) => void" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-UseDataChannelReturnType
+`UseDataChannelReturnType`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useDisconnectButton (hook)
+# useDisconnectButton
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useDisconnectButton } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                      | Description |
-| --------- | --------------------------------------------------------- | ----------- |
-| props     | [DisconnectButtonProps](./react/disconnectbuttonprops.md) |             |
+{% parameter name="props" type="DisconnectButtonProps" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ buttonProps: [DisconnectButtonProps](./react/disconnectbuttonprops.md) &amp; { className: string; onClick: () =&gt; void; disabled: boolean; }; }
+`{     buttonProps: DisconnectButtonProps & {         className: string;         onClick: () => void;         disabled: boolean;     }; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useEnsureCreateLayoutContext (hook)
+# useEnsureCreateLayoutContext
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useEnsureCreateLayoutContext } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter     | Type                                              | Description  |
-| ------------- | ------------------------------------------------- | ------------ |
-| layoutContext | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
+{% parameter name="layoutContext" type="LayoutContextType" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-[LayoutContextType](./react/layoutcontexttype.md)
+`LayoutContextType`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useEnsureLayoutContext (hook)
+# useEnsureLayoutContext
 
 Ensures that a layout context is provided, either via context or explicitly as a parameter. If not inside a `LayoutContext` and no layout context is provided, an error is thrown.
 
@@ -14,10 +14,9 @@ import { useEnsureLayoutContext } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter     | Type                                              | Description  |
-| ------------- | ------------------------------------------------- | ------------ |
-| layoutContext | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
+{% parameter name="layoutContext" type="LayoutContextType" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-[LayoutContextType](./react/layoutcontexttype.md)
+`LayoutContextType`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useEnsureParticipant (hook)
+# useEnsureParticipant
 
 Ensures that a participant is provided, either via context or explicitly as a parameter. If not inside a `ParticipantContext` and no participant is provided, an error is thrown.
 
@@ -14,10 +14,9 @@ import { useEnsureParticipant } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter   | Type        | Description  |
-| ----------- | ----------- | ------------ |
-| participant | Participant | _(Optional)_ |
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-Participant
+`Participant`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useEnsureRoom (hook)
+# useEnsureRoom
 
 Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.
 
@@ -14,10 +14,9 @@ import { useEnsureRoom } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type | Description  |
-| --------- | ---- | ------------ |
-| room      | Room | _(Optional)_ |
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-Room
+`Room`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useEnsureTrackReference (hook)
+# useEnsureTrackReference
 
 Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a `TrackContext` and no track reference is provided, an error is thrown.
 
@@ -14,10 +14,9 @@ import { useEnsureTrackReference } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                                 | Description  |
-| --------- | -------------------------------------------------------------------- | ------------ |
-| track     | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
+{% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
+`TrackReferenceOrPlaceholder`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useFocusToggle (hook)
+# useFocusToggle
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useFocusToggle } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter                           | Type                                                  | Description |
-| ----------------------------------- | ----------------------------------------------------- | ----------- |
-| { trackSource, participant, props } | [UseFocusToggleProps](./react/usefocustoggleprops.md) |             |
+{% parameter name="{ trackSource, participant, props }" type="UseFocusToggleProps" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ mergedProps: React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; &amp; { className: string; onClick: (event: React.MouseEvent&lt;HTMLButtonElement, MouseEvent&gt;) =&gt; void; }; inFocus: boolean; }
+`{     mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {         className: string;         onClick: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;     };     inFocus: boolean; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useGridLayout (hook)
+# useGridLayout
 
 The useGridLayout hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares.
 
@@ -14,11 +14,12 @@ import { useGridLayout } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter   | Type                                  | Description |
-| ----------- | ------------------------------------- | ----------- |
-| gridElement | React.RefObject&lt;HTMLDivElement&gt; |             |
-| trackCount  | number                                |             |
+{% parameter name="gridElement" type="React.RefObject<HTMLDivElement>" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="trackCount" type="number" optional=false %}
+{% /parameter %}
 
-{ layout: [GridLayoutDefinition](./core/gridlayoutdefinition.md)<!-- -->; }
+## Returns
+
+`{     layout: GridLayoutDefinition; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useIsMuted (hook)
+# useIsMuted
 
 ## Import
 
@@ -12,11 +12,12 @@ import { useIsMuted } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                              | Description  |
-| --------- | ------------------------------------------------- | ------------ |
-| source    | Track.Source                                      |              |
-| options   | [UseIsMutedOptions](./react/useismutedoptions.md) | _(Optional)_ |
+{% parameter name="source" type="Track.Source" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="options" type="UseIsMutedOptions" optional=true %}
+{% /parameter %}
 
-boolean
+## Returns
+
+`boolean`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useIsSpeaking (hook)
+# useIsSpeaking
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useIsSpeaking } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter   | Type        | Description  |
-| ----------- | ----------- | ------------ |
-| participant | Participant | _(Optional)_ |
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-boolean
+`boolean`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useLayoutContext (hook)
+# useLayoutContext
 
 Ensures that a layout context is provided via context. If no layout context is provided, an error is thrown.
 
@@ -12,6 +12,6 @@ import { useLayoutContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-[LayoutContextType](./react/layoutcontexttype.md)
+`LayoutContextType`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useLiveKitRoom (hook)
+# useLiveKitRoom
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useLiveKitRoom } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                            | Description |
-| --------- | ----------------------------------------------- | ----------- |
-| props     | [LiveKitRoomProps](./react/livekitroomprops.md) |             |
+{% parameter name="props" type="LiveKitRoomProps" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ room: Room \| undefined; htmlProps: HTMLAttributes&lt;T&gt;; }
+`{     room: Room | undefined;     htmlProps: HTMLAttributes<T>; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useLocalParticipant (hook)
+# useLocalParticipant
 
 The useLocalParticipant hook the state of the local participant.
 
@@ -14,10 +14,9 @@ import { useLocalParticipant } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                                | Description  |
-| --------- | ------------------------------------------------------------------- | ------------ |
-| options   | [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | _(Optional)_ |
+{% parameter name="options" type="UseLocalParticipantOptions" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ isMicrophoneEnabled: boolean; isScreenShareEnabled: boolean; isCameraEnabled: boolean; microphoneTrack: TrackPublication \| undefined; cameraTrack: TrackPublication \| undefined; localParticipant: LocalParticipant; }
+`{     isMicrophoneEnabled: boolean;     isScreenShareEnabled: boolean;     isCameraEnabled: boolean;     microphoneTrack: TrackPublication | undefined;     cameraTrack: TrackPublication | undefined;     lastMicrophoneError: Error | undefined;     lastCameraError: Error | undefined;     localParticipant: LocalParticipant; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useLocalParticipantPermissions (hook)
+# useLocalParticipantPermissions
 
 ## Import
 
@@ -10,6 +10,6 @@ import { useLocalParticipantPermissions } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-import("livekit-client/dist/src/proto/livekit_models").ParticipantPermission \| undefined
+`import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMaybeLayoutContext (hook)
+# useMaybeLayoutContext
 
 Returns a layout context from the `LayoutContext` if it exists, otherwise `undefined`<!-- -->.
 
@@ -12,6 +12,6 @@ import { useMaybeLayoutContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-[LayoutContextType](./react/layoutcontexttype.md) \| undefined
+`LayoutContextType | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMaybeParticipantContext (hook)
+# useMaybeParticipantContext
 
 Returns a participant from the `ParticipantContext` if it exists, otherwise `undefined`<!-- -->.
 
@@ -12,6 +12,6 @@ import { useMaybeParticipantContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-Participant \| undefined
+`Participant | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMaybeRoomContext (hook)
+# useMaybeRoomContext
 
 Returns the room context if it exists, otherwise undefined.
 
@@ -12,6 +12,6 @@ import { useMaybeRoomContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-Room \| undefined
+`Room | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMaybeTrackContext (hook)
+# useMaybeTrackContext
 
 Returns a track reference from the `TrackContext` if it exists, otherwise `undefined`<!-- -->.
 
@@ -12,6 +12,6 @@ import { useMaybeTrackContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) \| undefined
+`TrackReferenceOrPlaceholder | undefined`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMediaDevices (hook)
+# useMediaDevices
 
 ## Import
 
@@ -12,10 +12,11 @@ import { useMediaDevices } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                       | Description |
-| --------- | -------------------------- | ----------- |
-| { kind }  | { kind: MediaDeviceKind; } |             |
+{% parameter name="{ kind }" type="{
+    kind: MediaDeviceKind;
+}" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-MediaDeviceInfo\[\]
+`MediaDeviceInfo[]`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMediaDeviceSelect (hook)
+# useMediaDeviceSelect
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useMediaDeviceSelect } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter                                  | Type                                                              | Description |
-| ------------------------------------------ | ----------------------------------------------------------------- | ----------- |
-| { kind, room, track, requestPermissions, } | [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) |             |
+{% parameter name="{ kind, room, track, requestPermissions, }" type="UseMediaDeviceSelectProps" optional=false %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ devices: MediaDeviceInfo\[\]; className: string; activeDeviceId: string; setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").[SetMediaDeviceOptions](./core/setmediadeviceoptions.md) \| undefined) =&gt; Promise&lt;void&gt;; }
+`{     devices: MediaDeviceInfo[];     className: string;     activeDeviceId: string;     setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").SetMediaDeviceOptions | undefined) => Promise<void>; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMediaTrack (hook)
+# useMediaTrack
 
 ## Import
 
@@ -12,12 +12,15 @@ import { useMediaTrack } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter   | Type                                                                         | Description  |
-| ----------- | ---------------------------------------------------------------------------- | ------------ |
-| source      | [VideoSource](./core/videosource.md) \| [AudioSource](./core/audiosource.md) |              |
-| participant | Participant                                                                  | _(Optional)_ |
-| options     | [UseMediaTrackOptions](./react/usemediatrackoptions.md)                      | _(Optional)_ |
+{% parameter name="source" type="VideoSource | AudioSource" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
+{% /parameter %}
 
-{ publication: import("livekit-client").TrackPublication \| undefined; isMuted: boolean \| undefined; isSubscribed: boolean \| undefined; track: import("livekit-client").Track \| undefined; elementProps: React.HTMLAttributes&lt;HTMLElement&gt;; }
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
+
+## Returns
+
+`{     publication: import("livekit-client").TrackPublication | undefined;     isMuted: boolean | undefined;     isSubscribed: boolean | undefined;     track: import("livekit-client").Track | undefined;     elementProps: React.HTMLAttributes<HTMLElement>; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useMediaTrackByName (hook)
+# useMediaTrackByName
 
 ## Import
 
@@ -12,12 +12,15 @@ import { useMediaTrackByName } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter   | Type                                                    | Description  |
-| ----------- | ------------------------------------------------------- | ------------ |
-| name        | string                                                  |              |
-| participant | Participant                                             | _(Optional)_ |
-| options     | [UseMediaTrackOptions](./react/usemediatrackoptions.md) | _(Optional)_ |
+{% parameter name="name" type="string" optional=false %}
+{% /parameter %}
 
-**Returns:**
+{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
+{% /parameter %}
 
-{ publication: import("livekit-client").TrackPublication \| undefined; isMuted: boolean \| undefined; isSubscribed: boolean \| undefined; track: import("livekit-client").Track \| undefined; elementProps: import("react").HTMLAttributes&lt;HTMLElement&gt;; }
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
+
+## Returns
+
+`{     publication: import("livekit-client").TrackPublication | undefined;     isMuted: boolean | undefined;     isSubscribed: boolean | undefined;     track: import("livekit-client").Track | undefined;     elementProps: import("react").HTMLAttributes<HTMLElement>; }`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useParticipantContext (hook)
+# useParticipantContext
 
 Ensures that a participant is provided via context. If not inside a `ParticipantContext`<!-- -->, an error is thrown.
 
@@ -12,6 +12,6 @@ import { useParticipantContext } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Returns
 
-Participant
+`Participant`

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useParticipantInfo (hook)
+# useParticipantInfo
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useParticipantInfo } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                              | Description  |
-| --------- | ----------------------------------------------------------------- | ------------ |
-| props     | [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | _(Optional)_ |
+{% parameter name="props" type="UseParticipantInfoOptions" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ identity: string; name: string \| undefined; metadata: string \| undefined; }
+`{     identity: string;     name: string | undefined;     metadata: string | undefined; }`