npm - @livekit/components-js-docs - Versions diffs - 0.0.2 → 0.0.4 - Mend

@livekit/components-js-docs 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (260) hide show

package/generated-docs/react/component/focustoggle.md CHANGED Viewed

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# FocusToggle (component)
+# FocusToggle
 The FocusToggle puts the ParticipantTile in focus or removes it from focus.
@@ -18,11 +18,14 @@ import { FocusToggle } from '@livekit/components-react';
 </ParticipantTile>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
-| Property                                                | Type         | Description  |
-| ------------------------------------------------------- | ------------ | ------------ |
-| [participant?](./react/focustoggleprops.participant.md) | Participant  | _(Optional)_ |
-| [trackSource](./react/focustoggleprops.tracksource.md)  | Track.Source |              |
+{% parameter name="trackSource" type="Track.Source" optional=false %}
+{% /parameter %}
+{% parameter name="participant" type="Participant" optional=true %}
+_(Optional)_
+{% /parameter %}

package/generated-docs/react/component/gridlayout.md CHANGED Viewed

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# GridLayout (component)
+# GridLayout
 The GridLayout component displays the nested participants in a grid where every participants has the same size.
@@ -20,11 +20,12 @@ import { GridLayout } from '@livekit/components-react';
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
-| Property                                        | Type                                                                             | Description |
-| ----------------------------------------------- | -------------------------------------------------------------------------------- | ----------- |
-| [children](./react/gridlayoutprops.children.md) | React.ReactNode                                                                  |             |
-| [tracks](./react/gridlayoutprops.tracks.md)     | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |             |
+{% parameter name="children" type="React.ReactNode" optional=false %}
+{% /parameter %}
+{% parameter name="tracks" type="TrackReferenceOrPlaceholder[]" optional=false %}
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# LiveKitRoom (component)
+# LiveKitRoom
 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.
@@ -18,23 +18,76 @@ import { LiveKitRoom } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
-| Property                                                                  | Type                                      | Description                                                                                                                                                                                                                                                                                                   |
-| ------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [audio?](./react/livekitroomprops.audio.md)                               | AudioCaptureOptions \| boolean            | _(Optional)_ Publish audio immediately after connecting to your LiveKit room.                                                                                                                                                                                                                                 |
-| [connect?](./react/livekitroomprops.connect.md)                           | boolean                                   | _(Optional)_ If set to true a connection to LiveKit room is initiated.                                                                                                                                                                                                                                        |
-| [connectOptions?](./react/livekitroomprops.connectoptions.md)             | RoomConnectOptions                        | _(Optional)_ Define options how to connect to the LiveKit server.                                                                                                                                                                                                                                             |
-| [onConnected?](./react/livekitroomprops.onconnected.md)                   | () =&gt; void                             | _(Optional)_                                                                                                                                                                                                                                                                                                  |
-| [onDisconnected?](./react/livekitroomprops.ondisconnected.md)             | () =&gt; void                             | _(Optional)_                                                                                                                                                                                                                                                                                                  |
-| [onError?](./react/livekitroomprops.onerror.md)                           | (error: Error) =&gt; void                 | _(Optional)_                                                                                                                                                                                                                                                                                                  |
-| [onMediaDeviceFailure?](./react/livekitroomprops.onmediadevicefailure.md) | (failure?: MediaDeviceFailure) =&gt; void | _(Optional)_                                                                                                                                                                                                                                                                                                  |
-| [options?](./react/livekitroomprops.options.md)                           | RoomOptions                               | _(Optional)_ Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.                                                                                                              |
-| [room?](./react/livekitroomprops.room.md)                                 | Room                                      | _(Optional)_ Optional room instance. By passing your own room instance you overwrite the <code>options</code> parameter, make sure to set the options directly on the room instance itself.                                                                                                                   |
-| [screen?](./react/livekitroomprops.screen.md)                             | ScreenShareCaptureOptions \| boolean      | _(Optional)_ Publish screen share immediately after connecting to your LiveKit room.                                                                                                                                                                                                                          |
-| [serverUrl](./react/livekitroomprops.serverurl.md)                        | string \| undefined                       | URL to the LiveKit server. For example: <code>wss://&lt;domain&gt;.livekit.cloud</code> To simplify the implementation, <code>undefined</code> is also accepted as an intermediate value, but only with a valid string url can the connection be established.                                                 |
-| [simulateParticipants?](./react/livekitroomprops.simulateparticipants.md) | number \| undefined                       | _(Optional)_                                                                                                                                                                                                                                                                                                  |
-| [token](./react/livekitroomprops.token.md)                                | string \| undefined                       | A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, <code>undefined</code> is also accepted as an intermediate value, but only with a valid string token can the connection be established. |
-| [video?](./react/livekitroomprops.video.md)                               | VideoCaptureOptions \| boolean            | _(Optional)_ Publish video immediately after connecting to your LiveKit room.                                                                                                                                                                                                                                 |
+{% parameter name="serverUrl" type="string | undefined" optional=false %}
+URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string url can the connection be established.
+{% /parameter %}
+{% parameter name="token" type="string | undefined" optional=false %}
+A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string token can the connection be established.
+{% /parameter %}
+{% parameter name="audio" type="AudioCaptureOptions | boolean" optional=true %}
+_(Optional)_ Publish audio immediately after connecting to your LiveKit room.
+{% /parameter %}
+{% parameter name="connect" type="boolean" optional=true %}
+_(Optional)_ If set to true a connection to LiveKit room is initiated.
+{% /parameter %}
+{% parameter name="connectOptions" type="RoomConnectOptions" optional=true %}
+_(Optional)_ Define options how to connect to the LiveKit server.
+{% /parameter %}
+{% parameter name="onConnected" type="() => void" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="onDisconnected" type="() => void" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="onError" type="(error: Error) => void" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="onMediaDeviceFailure" type="(failure?: MediaDeviceFailure) => void" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="options" type="RoomOptions" optional=true %}
+_(Optional)_ Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.
+{% /parameter %}
+{% parameter name="room" type="Room" optional=true %}
+_(Optional)_ Optional room instance. By passing your own room instance you overwrite the `options` parameter, make sure to set the options directly on the room instance itself.
+{% /parameter %}
+{% parameter name="screen" type="ScreenShareCaptureOptions | boolean" optional=true %}
+_(Optional)_ Publish screen share immediately after connecting to your LiveKit room.
+{% /parameter %}
+{% parameter name="simulateParticipants" type="number | undefined" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="video" type="VideoCaptureOptions | boolean" optional=true %}
+_(Optional)_ Publish video immediately after connecting to your LiveKit room.
+{% /parameter %}

package/generated-docs/react/component/mediadevicemenu.md CHANGED Viewed

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# MediaDeviceMenu (prefab)
+# MediaDeviceMenu
 The MediaDeviceMenu prefab component is a button that opens a menu that lists all media devices and allows the user to select them.
@@ -22,14 +22,31 @@ This component is implemented with the `MediaDeviceSelect` LiveKit components.
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
-| Property                                                                      | Type                                                                                          | Description                                                                                                                                                                                                                                                                                                                                              |
-| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [initialSelection?](./react/mediadevicemenuprops.initialselection.md)         | string                                                                                        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [kind?](./react/mediadevicemenuprops.kind.md)                                 | MediaDeviceKind                                                                               | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [onActiveDeviceChange?](./react/mediadevicemenuprops.onactivedevicechange.md) | (kind: MediaDeviceKind, deviceId: string) =&gt; void                                          | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
-| [requestPermissions?](./react/mediadevicemenuprops.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. |
-| [tracks?](./react/mediadevicemenuprops.tracks.md)                             | Partial&lt;Record&lt;MediaDeviceKind, LocalAudioTrack \| LocalVideoTrack \| undefined&gt;&gt; | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+{% parameter name="initialSelection" type="string" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="kind" type="MediaDeviceKind" optional=true %}
+_(Optional)_
+{% /parameter %}
+{% parameter name="onActiveDeviceChange" type="(kind: MediaDeviceKind, deviceId: string) => 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="tracks" type="Partial<Record<MediaDeviceKind, LocalAudioTrack | LocalVideoTrack | undefined>>" optional=true %}
+_(Optional)_
+{% /parameter %}

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

@@ -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.
@@ -18,17 +18,44 @@ import { MediaDeviceSelect } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -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.
@@ -16,14 +16,31 @@ import { ParticipantAudioTile } from '@livekit/components-react';
 <ParticipantAudioTile />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# ParticipantContextIfNeeded (component)
+# ParticipantContextIfNeeded
 ## Import
@@ -8,4 +8,4 @@
 import { ParticipantContextIfNeeded } from '@livekit/components-react';
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -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.
@@ -23,11 +23,16 @@ const participants = useParticipants();
 <ParticipantLoop />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -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.
@@ -16,4 +16,4 @@ import { ParticipantName } from '@livekit/components-react';
 <ParticipantName />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -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.
@@ -18,14 +18,31 @@ import { ParticipantTile } from '@livekit/components-react';
 <ParticipantTile {...trackReference} />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -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.
@@ -20,18 +20,51 @@ This component is independent from the LiveKitRoom component and don't has to be
 <PreJoin />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -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.
@@ -18,4 +18,4 @@ import { RoomAudioRenderer } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -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.
@@ -18,10 +18,11 @@ import { RoomName } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -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.
@@ -18,10 +18,9 @@ import { StartAudio } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 CHANGED Viewed

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# Toast (component)
+# Toast
 ## Import
@@ -8,4 +8,4 @@
 import { Toast } from '@livekit/components-react';
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -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.
@@ -21,11 +21,16 @@ const tracks = useTracks([Track.Source.Camera]);
 <TrackLoop />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## 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 %}