@livekit/components-js-docs 0.0.2 → 0.0.3

package/generated-docs/react/chatprops.messagedecoder.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatProps.messageDecoder property
+
+**Signature:**
+
+```typescript
+messageDecoder?: MessageDecoder;
+```

package/generated-docs/react/chatprops.messageencoder.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatProps.messageEncoder property
+
+**Signature:**
+
+```typescript
+messageEncoder?: MessageEncoder;
+```

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# AudioConference (prefab)
+# AudioConference
 
 This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view.
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# AudioTrack (component)
+# AudioTrack
 
 The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a `Participant` as a property.
 
@@ -22,11 +22,30 @@ import { AudioTrack } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                                               | Type                             | Description                                              |
-| -------------------------------------------------------------------------------------- | -------------------------------- | -------------------------------------------------------- |
-| [name?](./react/audiotrackprops.name.md)                                               | string                           | _(Optional)_                                             |
-| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_                                             |
-| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                      | _(Optional)_                                             |
-| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                 | _(Optional)_                                             |
-| [source](./react/audiotrackprops.source.md)                                            | Track.Source                     |                                                          |
-| [volume?](./react/audiotrackprops.volume.md)                                           | number                           | _(Optional)_ by the default the range is between 0 and 1 |
+{% parameter name="source" type="Track.Source" optional=false %}
+{% /parameter %}
+
+{% parameter name="name" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => 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="volume" type="number" optional=true %}
+_(Optional)_ by the default the range is between 0 and 1
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# AudioVisualizer (component)
+# AudioVisualizer
 
 ## Import
 
@@ -12,6 +12,7 @@ import { AudioVisualizer } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                    | Type        | Description  |
-| ----------------------------------------------------------- | ----------- | ------------ |
-| [participant?](./react/audiovisualizerprops.participant.md) | Participant | _(Optional)_ |
+{% parameter name="participant" type="Participant" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# CarouselView (component)
+# CarouselView
 
 The `CarouselLayout` displays a list of tracks horizontally or vertically. Depending on the size of the container, the carousel will display as many tiles as possible and overflows the rest. The CarouselLayout uses the `useVisualStableUpdate` hook to ensure that tile reordering due to track updates is visually stable but still moves the important tiles (speaking participants) to the front.
 
@@ -23,8 +23,13 @@ const tracks = useTracks();
 
 ## Properties
 
-| Property                                                 | Type                                                                             | Description                                                                                                                                         |
-| -------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [children](./react/carouselviewprops.children.md)        | React.ReactNode                                                                  |                                                                                                                                                     |
-| [orientation?](./react/carouselviewprops.orientation.md) | 'vertical' \| 'horizontal'                                                       | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
-| [tracks](./react/carouselviewprops.tracks.md)            | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |
+{% parameter name="children" type="React.ReactNode" optional=false %}
+{% /parameter %}
+
+{% parameter name="tracks" type="TrackReferenceOrPlaceholder[]" optional=false %}
+{% /parameter %}
+
+{% parameter name="orientation" type="'vertical' | 'horizontal'" optional=true %}
+_(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container.
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# Chat (prefab)
+# Chat
 
 The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message.
 
@@ -22,6 +22,17 @@ import { Chat } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                   | Type                                            | Description  |
-| ---------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [messageFormatter?](./react/chatprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
+{% parameter name="messageDecoder" type="MessageDecoder" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="messageEncoder" type="MessageEncoder" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="messageFormatter" type="MessageFormatter" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ChatEntry (component)
+# ChatEntry
 
 The `ChatEntry` component holds and displays one chat message.
 
@@ -22,9 +22,22 @@ import { ChatEntry } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                        | Type                                                 | Description                                                                                                    |
-| --------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| [entry](./react/chatentryprops.entry.md)                        | [ReceivedChatMessage](./core/receivedchatmessage.md) | The chat massage object to display.                                                                            |
-| [hideName?](./react/chatentryprops.hidename.md)                 | boolean                                              | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
-| [hideTimestamp?](./react/chatentryprops.hidetimestamp.md)       | boolean                                              | _(Optional)_ Hide message timestamp.                                                                           |
-| [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md)      | _(Optional)_ An optional formatter for the message body.                                                       |
+{% parameter name="entry" type="ReceivedChatMessage" optional=false %}
+The chat massage object to display.
+
+{% /parameter %}
+
+{% parameter name="hideName" type="boolean" optional=true %}
+_(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person.
+
+{% /parameter %}
+
+{% parameter name="hideTimestamp" type="boolean" optional=true %}
+_(Optional)_ Hide message timestamp.
+
+{% /parameter %}
+
+{% parameter name="messageFormatter" type="MessageFormatter" optional=true %}
+_(Optional)_ An optional formatter for the message body.
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ChatToggle (component)
+# ChatToggle
 
 The ChatToggle component toggles the visibility of the chat component.
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ClearPinButton (component)
+# ClearPinButton
 
 The ClearPinButton is a basic html button with the added ability to signal the LiveKitRoom that it should display the grid view again.
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ConnectionQualityIndicator (component)
+# ConnectionQualityIndicator
 
 The ConnectionQualityIndicator shows the individual connection quality of a participant.
 

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ConnectionState (component)
+# ConnectionState
 
 The ConnectionState component displays the connection status of the room in written form.
 
@@ -22,6 +22,7 @@ import { ConnectionState } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                       | Type | Description                                                                 |
-| ---------------------------------------------- | ---- | --------------------------------------------------------------------------- |
-| [room?](./react/connectionstatusprops.room.md) | Room | _(Optional)_ The room from which the connection status should be displayed. |
+{% parameter name="room" type="Room" optional=true %}
+_(Optional)_ The room from which the connection status should be displayed.
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ConnectionStateToast (component)
+# ConnectionStateToast
 
 ## Import
 
@@ -12,6 +12,7 @@ import { ConnectionStateToast } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                           | Type | Description  |
-| -------------------------------------------------- | ---- | ------------ |
-| [room?](./react/connectionstatetoastprops.room.md) | Room | _(Optional)_ |
+{% parameter name="room" type="Room" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ControlBar (prefab)
+# ControlBar
 
 The ControlBar prefab component gives the user the basic user interface to control their media devices and leave the room.
 
@@ -26,7 +26,12 @@ This component is build with other LiveKit components like `TrackToggle`<!-- -->
 
 ## Properties
 
-| Property                                           | Type                                                | Description  |
-| -------------------------------------------------- | --------------------------------------------------- | ------------ |
-| [controls?](./react/controlbarprops.controls.md)   | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_ |
-| [variation?](./react/controlbarprops.variation.md) | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_ |
+{% parameter name="controls" type="ControlBarControls" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="variation" type="'minimal' | 'verbose' | 'textOnly'" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# DisconnectButton (component)
+# DisconnectButton
 
 The DisconnectButton is a basic html button with the added ability to disconnect from a LiveKit room. Normally, it is used by end-users to leave a video or audio call.
 
@@ -22,6 +22,7 @@ import { DisconnectButton } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                   | Type    | Description  |
-| ---------------------------------------------------------- | ------- | ------------ |
-| [stopTracks?](./react/disconnectbuttonprops.stoptracks.md) | boolean | _(Optional)_ |
+{% parameter name="stopTracks" type="boolean" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# FocusLayout (component)
+# FocusLayout
 
 ## Import
 
@@ -12,7 +12,12 @@ import { FocusLayout } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                              | Type                                                                               | Description  |
-| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------ |
-| [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
-| [track?](./react/focuslayoutprops.track.md)                           | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)               | _(Optional)_ |
+{% parameter name="onParticipantClick" type="(evt: ParticipantClickEvent) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# FocusLayoutContainer (component)
+# FocusLayoutContainer
 
 ## Import
 
@@ -12,7 +12,12 @@ import { FocusLayoutContainer } from '@livekit/components-react';
 
 ## Properties
 
-| Property                                                           | Type                                       | Description  |
-| ------------------------------------------------------------------ | ------------------------------------------ | ------------ |
-| [focusTrack?](./react/focuslayoutcontainerprops.focustrack.md)     | [TrackReference](./core/trackreference.md) | _(Optional)_ |
-| [participants?](./react/focuslayoutcontainerprops.participants.md) | Array&lt;Participant&gt;                   | _(Optional)_ |
+{% parameter name="focusTrack" type="TrackReference" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="participants" type="Array<Participant>" optional=true %}
+_(Optional)_
+
+{% /parameter %}

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

@@ -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.
 
@@ -22,7 +22,10 @@ import { FocusToggle } from '@livekit/components-react';
 
 ## 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/formatchatmessagelinks.md

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

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

@@ -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.
 
@@ -24,7 +24,8 @@ import { GridLayout } from '@livekit/components-react';
 
 ## 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

@@ -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.
 
@@ -22,19 +22,72 @@ import { LiveKitRoom } from '@livekit/components-react';
 
 ## 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

@@ -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.
 
@@ -26,10 +26,27 @@ This component is implemented with the `MediaDeviceSelect` LiveKit components.
 
 ## 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 %}