@livekit/components-js-docs 0.1.0 → 0.1.1

package/generated-docs/react/mediadevicemenuprops.requestpermissions.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.requestPermissions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.requestPermissions property
+# MediaDeviceMenuProps.requestPermissions property
 
 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.
 

package/generated-docs/react/mediadevicemenuprops.tracks.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.tracks property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.tracks property
+# MediaDeviceMenuProps.tracks property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.exactmatch.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.exactMatch property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.exactMatch property
+# MediaDeviceSelectProps.exactMatch property
 
 will force the browser to only return the specified device will call `onDeviceSelectError` with the error in case this fails
 

package/generated-docs/react/mediadeviceselectprops.initialselection.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.initialSelection property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.initialSelection property
+# MediaDeviceSelectProps.initialSelection property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.kind.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.kind property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.kind property
+# MediaDeviceSelectProps.kind property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MediaDeviceSelectProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/MediaDeviceSelect.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps interface
+# MediaDeviceSelectProps interface
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.onactivedevicechange.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.onActiveDeviceChange property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.onActiveDeviceChange property
+# MediaDeviceSelectProps.onActiveDeviceChange property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.ondevicelistchange.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.onDeviceListChange property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.onDeviceListChange property
+# MediaDeviceSelectProps.onDeviceListChange property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.ondeviceselecterror.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.onDeviceSelectError property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.onDeviceSelectError property
+# MediaDeviceSelectProps.onDeviceSelectError property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.requestpermissions.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.requestPermissions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.requestPermissions property
+# MediaDeviceSelectProps.requestPermissions property
 
 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.
 

package/generated-docs/react/mediadeviceselectprops.track.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.track property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.track property
+# MediaDeviceSelectProps.track property
 
 **Signature:**
 

package/generated-docs/react/messageformatter.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MessageFormatter type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ChatEntry.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MessageFormatter type
+# MessageFormatter type
 
 **Signature:**
 

package/generated-docs/react/participantcontext.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantContext variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/participant-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantContext variable
+# ParticipantContext variable
 
 **Signature:**
 

package/generated-docs/react/participantloopprops.children.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantLoopProps.children property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantLoopProps.children property
+# ParticipantLoopProps.children property
 
 The template component to be used in the loop.
 

package/generated-docs/react/participantloopprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantLoopProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ParticipantLoop.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantLoopProps interface
+# ParticipantLoopProps interface
 
 **Signature:**
 

package/generated-docs/react/participantloopprops.participants.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantLoopProps.participants property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantLoopProps.participants property
+# ParticipantLoopProps.participants property
 
 The participants to loop over. Use `useParticipants()` hook to get participants.
 

package/generated-docs/react/participantnameprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantNameProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantName.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantNameProps interface
+# ParticipantNameProps interface
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.disablespeakingindicator.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantTileProps.disableSpeakingIndicator property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.disableSpeakingIndicator property
+# ParticipantTileProps.disableSpeakingIndicator property
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantTileProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantTile.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps interface
+# ParticipantTileProps interface
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.onparticipantclick.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantTileProps.onParticipantClick property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.onParticipantClick property
+# ParticipantTileProps.onParticipantClick property
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.participant.md

@@ -1,10 +1,18 @@
+---
+{ "title": "ParticipantTileProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.participant property
+# ParticipantTileProps.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.publication.md

@@ -1,10 +1,18 @@
+---
+{ "title": "ParticipantTileProps.publication property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.publication property
+# ParticipantTileProps.publication property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.source.md

@@ -1,10 +1,18 @@
+---
+{ "title": "ParticipantTileProps.source property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.source property
+# ParticipantTileProps.source property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.trackref.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantTileProps.trackRef property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.trackRef property
+# ParticipantTileProps.trackRef property
 
 The track reference to display.
 

package/generated-docs/react/prejoinprops.camlabel.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.camLabel property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.camLabel property
+# PreJoinProps.camLabel property
 
 **Signature:**
 

package/generated-docs/react/prejoinprops.debug.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.debug property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.debug property
+# PreJoinProps.debug property
 
 Display a debug window for your convenience.
 

package/generated-docs/react/prejoinprops.defaults.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.defaults property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.defaults property
+# PreJoinProps.defaults property
 
 Prefill the input form with initial values.
 

package/generated-docs/react/prejoinprops.joinlabel.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.joinLabel property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.joinLabel property
+# PreJoinProps.joinLabel property
 
 **Signature:**
 

package/generated-docs/react/prejoinprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "PreJoinProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps interface
+# PreJoinProps interface
 
 **Signature:**
 

package/generated-docs/react/prejoinprops.miclabel.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.micLabel property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.micLabel property
+# PreJoinProps.micLabel property
 
 **Signature:**
 

package/generated-docs/react/prejoinprops.onerror.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.onError property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.onError property
+# PreJoinProps.onError property
 
 **Signature:**
 

package/generated-docs/react/prejoinprops.onsubmit.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.onSubmit property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.onSubmit property
+# PreJoinProps.onSubmit property
 
 This function is called with the `LocalUserChoices` if validation is passed.
 

package/generated-docs/react/prejoinprops.onvalidate.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.onValidate property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.onValidate property
+# PreJoinProps.onValidate property
 
 Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
 

package/generated-docs/react/prejoinprops.showe2eeoptions.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.showE2EEOptions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.showE2EEOptions property
+# PreJoinProps.showE2EEOptions property
 
 **Signature:**
 

package/generated-docs/react/prejoinprops.userlabel.md

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.userLabel property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.userLabel property
+# PreJoinProps.userLabel property
 
 **Signature:**
 

package/generated-docs/react/roomcontext.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "RoomContext variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/room-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## RoomContext variable
+# RoomContext variable
 
 **Signature:**
 

package/generated-docs/react/roomnameprops.childrenposition.md

@@ -1,6 +1,10 @@
+---
+{ "title": "RoomNameProps.childrenPosition property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## RoomNameProps.childrenPosition property
+# RoomNameProps.childrenPosition property
 
 **Signature:**
 

package/generated-docs/react/roomnameprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "RoomNameProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomName.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## RoomNameProps interface
+# RoomNameProps interface
 
 **Signature:**
 

package/generated-docs/react/trackcontext.md

@@ -1,10 +1,21 @@
+---
+{
+  "title": "TrackContext variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackContext variable
+# TrackContext variable
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+`TrackContext` has been renamed to `TrackRefContext`<!-- -->, use this as a drop in replacement.
 
-> Warning: This API is now obsolete.
->
-> `TrackContext` has been to `TrackRefContext`<!-- -->, use this as a drop in replacement.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/trackloopprops.children.md

@@ -1,6 +1,10 @@
+---
+{ "title": "TrackLoopProps.children property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackLoopProps.children property
+# TrackLoopProps.children property
 
 The template component to be used in the loop.
 

package/generated-docs/react/trackloopprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackLoopProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/TrackLoop.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackLoopProps interface
+# TrackLoopProps interface
 
 **Signature:**
 

package/generated-docs/react/trackloopprops.tracks.md

@@ -1,6 +1,10 @@
+---
+{ "title": "TrackLoopProps.tracks property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackLoopProps.tracks property
+# TrackLoopProps.tracks property
 
 Track references to loop over. You can the use `useTracks()` hook to get TrackReferences.
 

package/generated-docs/react/trackmutedindicatorprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackMutedIndicatorProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/TrackMutedIndicator.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackMutedIndicatorProps interface
+# TrackMutedIndicatorProps interface
 
 **Signature:**
 

package/generated-docs/react/trackmutedindicatorprops.participant.md

@@ -1,10 +1,18 @@
+---
+{ "title": "TrackMutedIndicatorProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackMutedIndicatorProps.participant property
+# TrackMutedIndicatorProps.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**