@livekit/components-js-docs 0.0.2 → 0.0.3

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# MediaDeviceSelect (component)
+# MediaDeviceSelect
 
 The MediaDeviceSelect list all media devices of one kind. Clicking on one of the listed devices make it the active media device.
 
@@ -22,13 +22,40 @@ import { MediaDeviceSelect } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                                        | Type                                      | Description                                                                                                                                                                                                                                                                                                                                              |
-| ------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [exactMatch?](./react/mediadeviceselectprops.exactmatch.md)                     | boolean                                   | _(Optional)_ will force the browser to only return the specified device will call <code>onDeviceSelectError</code> with the error in case this fails                                                                                                                                                                                                     |
-| [initialSelection?](./react/mediadeviceselectprops.initialselection.md)         | string                                    | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [kind](./react/mediadeviceselectprops.kind.md)                                  | MediaDeviceKind                           |                                                                                                                                                                                                                                                                                                                                                          |
-| [onActiveDeviceChange?](./react/mediadeviceselectprops.onactivedevicechange.md) | (deviceId: string) =&gt; void             | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [onDeviceListChange?](./react/mediadeviceselectprops.ondevicelistchange.md)     | (devices: MediaDeviceInfo\[\]) =&gt; void | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [onDeviceSelectError?](./react/mediadeviceselectprops.ondeviceselecterror.md)   | (e: Error) =&gt; void                     | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [requestPermissions?](./react/mediadeviceselectprops.requestpermissions.md)     | boolean                                   | _(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. |
-| [track?](./react/mediadeviceselectprops.track.md)                               | LocalAudioTrack \| LocalVideoTrack        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+{% parameter name="kind" type="MediaDeviceKind" optional=false %}
+{% /parameter %}
+
+{% parameter name="exactMatch" type="boolean" optional=true %}
+_(Optional)_ will force the browser to only return the specified device will call `onDeviceSelectError` with the error in case this fails
+
+{% /parameter %}
+
+{% parameter name="initialSelection" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onActiveDeviceChange" type="(deviceId: string) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onDeviceListChange" type="(devices: MediaDeviceInfo[]) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onDeviceSelectError" 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.
+
+{% /parameter %}
+
+{% parameter name="track" type="LocalAudioTrack | LocalVideoTrack" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ParticipantAudioTile (component)
+# ParticipantAudioTile
 
 The ParticipantAudioTile component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the `TileLoop` or independently if a participant is passed as a property.
 
@@ -20,10 +20,27 @@ import { ParticipantAudioTile } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                                              | Type                                                                                 | Description  |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------ |
-| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_ |
-| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_ |
-| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_ |
-| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_ |
+{% parameter name="disableSpeakingIndicator" type="boolean" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="participant" type="Participant" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="publication" type="TrackPublication" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="source" type="Track.Source" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ParticipantContextIfNeeded (component)
+# ParticipantContextIfNeeded
 
 ## Import
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ParticipantLoop (component)
+# ParticipantLoop
 
 The ParticipantLoop component loops over an array of participants to create a context for every participant. This component takes exactly one child component as a template. By providing your own template as a child you have full control over the look and feel of your participant representations.
 
@@ -27,7 +27,12 @@ const participants = useParticipants();
 
 ## Properties
 
-| Property                                                     | Type            | Description                                                                                              |
-| ------------------------------------------------------------ | --------------- | -------------------------------------------------------------------------------------------------------- |
-| [children](./react/participantloopprops.children.md)         | React.ReactNode | The template component to be used in the loop.                                                           |
-| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over. If not provided, the participants from the current room context are used. |
+{% parameter name="children" type="React.ReactNode" optional=false %}
+The template component to be used in the loop.
+
+{% /parameter %}
+
+{% parameter name="participants" type="Participant[]" optional=false %}
+The participants to loop over. Use `useParticipants()` hook to get participants.
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ParticipantName (component)
+# ParticipantName
 
 The ParticipantName component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed.
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ParticipantTile (component)
+# ParticipantTile
 
 The ParticipantTile component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the `TrackLoop` component or by spreading a track reference as properties.
 
@@ -22,10 +22,27 @@ import { ParticipantTile } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                                              | Type                                                                                 | Description  |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------ |
-| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_ |
-| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_ |
-| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_ |
-| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_ |
+{% parameter name="disableSpeakingIndicator" type="boolean" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="participant" type="Participant" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="publication" type="TrackPublication" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="source" type="Track.Source" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# PreJoin (prefab)
+# PreJoin
 
 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.
 
@@ -24,14 +24,47 @@ This component is independent from the LiveKitRoom component and don't has to be
 
 ## Properties
 
-| Property                                             | Type                                                                            | Description                                                                                                                                |
-| ---------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [camLabel?](./react/prejoinprops.camlabel.md)        | string                                                                          | _(Optional)_                                                                                                                               |
-| [debug?](./react/prejoinprops.debug.md)              | boolean                                                                         | _(Optional)_ Display a debug window for your convenience.                                                                                  |
-| [defaults?](./react/prejoinprops.defaults.md)        | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
-| [joinLabel?](./react/prejoinprops.joinlabel.md)      | string                                                                          | _(Optional)_                                                                                                                               |
-| [micLabel?](./react/prejoinprops.miclabel.md)        | string                                                                          | _(Optional)_                                                                                                                               |
-| [onError?](./react/prejoinprops.onerror.md)          | (error: Error) =&gt; void                                                       | _(Optional)_                                                                                                                               |
-| [onSubmit?](./react/prejoinprops.onsubmit.md)        | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
-| [onValidate?](./react/prejoinprops.onvalidate.md)    | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
-| [userLabel?](./react/hook/prejoinprops.userlabel.md) | string                                                                          | _(Optional)_                                                                                                                               |
+{% parameter name="camLabel" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="debug" type="boolean" optional=true %}
+_(Optional)_ Display a debug window for your convenience.
+
+{% /parameter %}
+
+{% parameter name="defaults" type="Partial<LocalUserChoices>" optional=true %}
+_(Optional)_ Prefill the input form with initial values.
+
+{% /parameter %}
+
+{% parameter name="joinLabel" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="micLabel" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onError" type="(error: Error) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onSubmit" type="(values: LocalUserChoices) => void" optional=true %}
+_(Optional)_ This function is called with the `LocalUserChoices` if validation is passed.
+
+{% /parameter %}
+
+{% parameter name="onValidate" type="(values: LocalUserChoices) => boolean" optional=true %}
+_(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
+
+{% /parameter %}
+
+{% parameter name="userLabel" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# RoomAudioRenderer (component)
+# RoomAudioRenderer
 
 The RoomAudioRenderer component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible.
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# RoomName (component)
+# RoomName
 
 The RoomName component renders the name of the connected LiveKit room inside a span tag.
 
@@ -22,6 +22,7 @@ import { RoomName } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                       | Type                | Description  |
-| -------------------------------------------------------------- | ------------------- | ------------ |
-| [childrenPosition?](./react/roomnameprops.childrenposition.md) | 'before' \| 'after' | _(Optional)_ |
+{% parameter name="childrenPosition" type="'before' | 'after'" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# StartAudio (component)
+# StartAudio
 
 The StartAudio component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again.
 
@@ -22,6 +22,5 @@ import { StartAudio } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                          | Type   | Description |
-| ------------------------------------------------- | ------ | ----------- |
-| [label](./react/allowaudioplaybackprops.label.md) | string |             |
+{% parameter name="label" type="string" optional=false %}
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# Toast (component)
+# Toast
 
 ## Import
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# TrackLoop (component)
+# TrackLoop
 
 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.
 
@@ -25,7 +25,12 @@ const tracks = useTracks([Track.Source.Camera]);
 
 ## Properties
 
-| Property                                       | Type                                                                                                                                       | Description                                    |
-| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
-| [children](./react/trackloopprops.children.md) | React.ReactNode                                                                                                                            | The template component to be used in the loop. |
-| [tracks](./react/trackloopprops.tracks.md)     | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over.                 |
+{% parameter name="children" type="React.ReactNode" optional=false %}
+The template component to be used in the loop.
+
+{% /parameter %}
+
+{% parameter name="tracks" type="TrackReference[] | TrackReferenceOrPlaceholder[]" optional=false %}
+Track references to loop over. You can the use `useTracks()` hook to get TrackReferences.
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# TrackMutedIndicator (component)
+# TrackMutedIndicator
 
 The TrackMutedIndicator shows whether the participant's camera or microphone is muted or not.
 
@@ -21,8 +21,15 @@ import { TrackMutedIndicator } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                        | Type                             | Description  |
-| --------------------------------------------------------------- | -------------------------------- | ------------ |
-| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                      | _(Optional)_ |
-| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
-| [source](./react/trackmutedindicatorprops.source.md)            | Track.Source                     |              |
+{% parameter name="source" type="Track.Source" optional=false %}
+{% /parameter %}
+
+{% parameter name="participant" type="Participant" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="show" type="'always' | 'muted' | 'unmuted'" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# TrackToggle (component)
+# TrackToggle
 
 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.
 
@@ -23,10 +23,25 @@ import { TrackToggle } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                      | Type                                                                        | Description  |
-| ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------ |
-| [captureOptions?](./react/tracktoggleprops.captureoptions.md) | [CaptureOptionsBySource](./core/captureoptionsbysource.md)<!-- -->&lt;T&gt; | _(Optional)_ |
-| [initialState?](./react/tracktoggleprops.initialstate.md)     | boolean                                                                     | _(Optional)_ |
-| [onChange?](./react/tracktoggleprops.onchange.md)             | (enabled: boolean) =&gt; void                                               | _(Optional)_ |
-| [showIcon?](./react/tracktoggleprops.showicon.md)             | boolean                                                                     | _(Optional)_ |
-| [source](./react/tracktoggleprops.source.md)                  | T                                                                           |              |
+{% parameter name="source" type="T" optional=false %}
+{% /parameter %}
+
+{% parameter name="captureOptions" type="CaptureOptionsBySource<T>" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="initialState" type="boolean" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onChange" type="(enabled: boolean) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="showIcon" type="boolean" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# VideoConference (prefab)
+# VideoConference
 
 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.
 
@@ -26,6 +26,17 @@ The component is implemented with other LiveKit components like `FocusContextPro
 
 ## Properties
 
-| Property                                                                      | Type                                            | Description  |
-| ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
+{% parameter name="chatMessageDecoder" type="MessageDecoder" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="chatMessageEncoder" type="MessageEncoder" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="chatMessageFormatter" type="MessageFormatter" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# VideoTrack (component)
+# VideoTrack
 
 The VideoTrack component is responsible for rendering participant video tracks like `camera` and `screen_share`<!-- -->. This component must have access to the participant's context, or alternatively pass it a `Participant` as a property.
 
@@ -20,11 +20,35 @@ import { VideoTrack } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                                               | Type                                                                               | Description  |
-| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------ |
-| [name?](./react/videotrackprops.name.md)                                               | string                                                                             | _(Optional)_ |
-| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void                                                   | _(Optional)_ |
-| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [participant?](./react/videotrackprops.participant.md)                                 | Participant                                                                        | _(Optional)_ |
-| [publication?](./react/videotrackprops.publication.md)                                 | TrackPublication                                                                   | _(Optional)_ |
-| [source](./react/videotrackprops.source.md)                                            | Track.Source                                                                       |              |
+{% parameter name="source" type="Track.Source" optional=false %}
+{% /parameter %}
+
+{% parameter name="manageSubscription" type="boolean" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="name" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onTrackClick" type="(evt: ParticipantClickEvent) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="participant" type="Participant" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="publication" type="TrackPublication" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useChat (hook)
+# useChat
 
 ## Import
 
@@ -10,6 +10,14 @@ import { useChat } from '@livekit/components-react';
 
 {% partial file="p_usage.md" /%}
 
-**Returns:**
+## Parameters
 
-{ send: ((message: string) =&gt; Promise&lt;void&gt;) \| undefined; chatMessages: [ReceivedChatMessage](./core/receivedchatmessage.md)<!-- -->\[\]; isSending: boolean; }
+{% parameter name="options" type="{
+    messageEncoder?: MessageEncoder;
+    messageDecoder?: MessageDecoder;
+}" optional=true %}
+{% /parameter %}
+
+## Returns
+
+`{     send: ((message: string) => Promise<void>) | undefined;     chatMessages: ReceivedChatMessage[];     isSending: boolean; }`

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

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

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

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

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# useConnectionQualityIndicator (hook)
+# useConnectionQualityIndicator
 
 ## Import
 
@@ -12,10 +12,9 @@ import { useConnectionQualityIndicator } from '@livekit/components-react';
 
 ## Parameters
 
-| Parameter | Type                                                                              | Description  |
-| --------- | --------------------------------------------------------------------------------- | ------------ |
-| options   | [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | _(Optional)_ |
+{% parameter name="options" type="ConnectionQualityIndicatorOptions" optional=true %}
+{% /parameter %}
 
-**Returns:**
+## Returns
 
-{ className: "lk-rotate" \| "lk-audio-conference" \| "lk-audio-conference-stage" \| "lk-audio-container" \| "lk-button" \| "lk-button-group" \| "lk-button-group-container" \| "lk-camera-off-note" \| "lk-chat" \| "lk-chat-entry" \| "lk-chat-form" \| "lk-chat-form-input" \| "lk-chat-messages" \| "lk-control-bar" \| "lk-focus-layout-wrapper" \| "lk-form-control" \| "lk-grid-layout-wrapper" \| "lk-join-button" \| "lk-list" \| "lk-message-body" \| "lk-meta-data" \| "lk-participant-name" \| "lk-prejoin" \| "lk-timestamp" \| "lk-username-container" \| "lk-video-conference" \| "lk-video-conference-inner" \| "lk-video-container" \| "lk-audio-visualizer" \| "lk-button-group-menu" \| "lk-button-menu" \| "lk-carousel" \| "lk-chat-toggle" \| "lk-connection-quality" \| "lk-device-menu" \| "lk-device-menu-heading" \| "lk-disconnect-button" \| "lk-focus-layout" \| "lk-focus-toggle-button" \| "lk-focused-participant" \| "lk-grid-layout" \| "lk-media-device-select" \| "lk-pagination-control" \| "lk-pagination-count" \| "lk-pagination-indicator" \| "lk-participant-media-audio" \| "lk-participant-media-video" \| "lk-participant-metadata" \| "lk-participant-metadata-item" \| "lk-participant-placeholder" \| "lk-participant-tile" \| "lk-pip-track" \| "lk-room-container" \| "lk-spinner" \| "lk-start-audio-button" \| "lk-toast" \| "lk-track-muted-indicator-camera" \| "lk-track-muted-indicator-microphone"; quality: ConnectionQuality; }
+`{     className: "lk-rotate" | "lk-audio-conference" | "lk-audio-conference-stage" | "lk-audio-container" | "lk-button" | "lk-button-group" | "lk-button-group-container" | "lk-camera-off-note" | "lk-chat" | "lk-chat-entry" | "lk-chat-form" | "lk-chat-form-input" | "lk-chat-messages" | "lk-control-bar" | "lk-focus-layout-wrapper" | "lk-form-control" | "lk-grid-layout-wrapper" | "lk-join-button" | "lk-list" | "lk-message-body" | "lk-meta-data" | "lk-participant-name" | "lk-prejoin" | "lk-timestamp" | "lk-username-container" | "lk-video-conference" | "lk-video-conference-inner" | "lk-video-container" | "lk-audio-visualizer" | "lk-button-group-menu" | "lk-button-menu" | "lk-carousel" | "lk-chat-toggle" | "lk-connection-quality" | "lk-device-menu" | "lk-device-menu-heading" | "lk-disconnect-button" | "lk-focus-layout" | "lk-focus-toggle-button" | "lk-focused-participant" | "lk-grid-layout" | "lk-media-device-select" | "lk-pagination-control" | "lk-pagination-count" | "lk-pagination-indicator" | "lk-participant-media-audio" | "lk-participant-media-video" | "lk-participant-metadata" | "lk-participant-metadata-item" | "lk-participant-placeholder" | "lk-participant-tile" | "lk-pip-track" | "lk-room-container" | "lk-spinner" | "lk-start-audio-button" | "lk-toast" | "lk-track-muted-indicator-camera" | "lk-track-muted-indicator-microphone";     quality: ConnectionQuality; }`