@livekit/components-js-docs 0.1.0 → 0.1.1

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "ParticipantTile",
+  "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. -->
 
 # ParticipantTile
@@ -7,7 +14,7 @@ The `ParticipantTile` component is the base utility wrapper for displaying a vis
 ## Import
 
 ```typescript
-import { ParticipantTile } from '@livekit/components-react';
+import { ParticipantTile } from "@livekit/components-react";
 ```
 
 ## Usage Example 1
@@ -42,22 +49,34 @@ _(Optional)_
 
 {% /parameter %}
 
-{% parameter name="participant" type="Participant" optional=true %}
-_(Optional)_
+{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+_(Optional)_ The track reference to display.
 
 {% /parameter %}
 
-{% parameter name="publication" type="TrackPublication" optional=true %}
+{% parameter name="participant" type="Participant" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This parameter will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}
 
-{% parameter name="source" type="Track.Source" optional=true %}
+{% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This parameter will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}
 
-{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
-_(Optional)_ The track reference to display.
+{% parameter name="source" type="Track.Source" optional=true deprecated=true %}
+_(Optional)_
+
+{% callout type="caution" variation="compact" %}
+This parameter will be removed in a future version use `trackRef` instead.
 
+{% /callout %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "PreJoin",
+  "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. -->
 
 # PreJoin
@@ -7,7 +14,7 @@ The `PreJoin` prefab component is normally presented to the user before he enter
 ## Import
 
 ```typescript
-import { PreJoin } from '@livekit/components-react';
+import { PreJoin } from "@livekit/components-react";
 ```
 
 ## Remarks

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "RoomAudioRenderer",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomAudioRenderer.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # RoomAudioRenderer
@@ -7,7 +14,7 @@ The `RoomAudioRenderer` component is a drop-in solution for adding audio to your
 ## Import
 
 ```typescript
-import { RoomAudioRenderer } from '@livekit/components-react';
+import { RoomAudioRenderer } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "RoomName",
+  "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. -->
 
 # RoomName
@@ -7,7 +14,7 @@ The `RoomName` component renders the name of the connected LiveKit room inside a
 ## Import
 
 ```typescript
-import { RoomName } from '@livekit/components-react';
+import { RoomName } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "StartAudio",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/StartAudio.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # StartAudio
@@ -7,7 +14,7 @@ The `StartAudio` component is only visible when the browser blocks audio playbac
 ## Import
 
 ```typescript
-import { StartAudio } from '@livekit/components-react';
+import { StartAudio } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "Toast",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/Toast.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # Toast
@@ -7,7 +14,7 @@ The `Toast` component is a rudimentary way to display a message to the user. Thi
 ## Import
 
 ```typescript
-import { Toast } from '@livekit/components-react';
+import { Toast } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "TrackLoop",
+  "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. -->
 
 # TrackLoop
@@ -7,7 +14,7 @@ The `TrackLoop` component loops over tracks. It is for example a easy way to loo
 ## Import
 
 ```typescript
-import { TrackLoop } from '@livekit/components-react';
+import { TrackLoop } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "TrackMutedIndicator",
+  "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. -->
 
 # TrackMutedIndicator
@@ -7,7 +14,7 @@ The `TrackMutedIndicator` shows whether the participant's camera or microphone i
 ## Import
 
 ```typescript
-import { TrackMutedIndicator } from '@livekit/components-react';
+import { TrackMutedIndicator } from "@livekit/components-react";
 ```
 
 ## Usage
@@ -21,22 +28,30 @@ import { TrackMutedIndicator } from '@livekit/components-react';
 
 ## Properties
 
-{% parameter name="participant" type="Participant" optional=true %}
+{% parameter name="show" type="'always' | 'muted' | 'unmuted'" optional=true %}
 _(Optional)_
 
 {% /parameter %}
 
-{% parameter name="show" type="'always' | 'muted' | 'unmuted'" optional=true %}
+{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 _(Optional)_
 
 {% /parameter %}
 
-{% parameter name="source" type="Track.Source" optional=true %}
+{% parameter name="participant" type="Participant" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This parameter will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}
 
-{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% parameter name="source" type="Track.Source" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This parameter will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "TrackToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/TrackToggle.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # TrackToggle
@@ -7,7 +14,7 @@ With the `TrackToggle` component it is possible to mute and unmute your camera a
 ## Import
 
 ```typescript
-import { TrackToggle } from '@livekit/components-react';
+import { TrackToggle } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "VideoConference",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/VideoConference.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # VideoConference
@@ -7,7 +14,7 @@ The `VideoConference` ready-made component is your drop-in solution for a classi
 ## Import
 
 ```typescript
-import { VideoConference } from '@livekit/components-react';
+import { VideoConference } from "@livekit/components-react";
 ```
 
 ## Remarks

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "VideoTrack",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/VideoTrack.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # VideoTrack
@@ -7,7 +14,7 @@ The `VideoTrack` component is responsible for rendering participant video tracks
 ## Import
 
 ```typescript
-import { VideoTrack } from '@livekit/components-react';
+import { VideoTrack } from "@livekit/components-react";
 ```
 
 ## Usage
@@ -25,37 +32,53 @@ _(Optional)_
 
 {% /parameter %}
 
-{% parameter name="name" type="string" optional=true %}
+{% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
 _(Optional)_
 
 {% /parameter %}
 
-{% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
+{% parameter name="onTrackClick" type="(evt: ParticipantClickEvent) => void" optional=true %}
 _(Optional)_
 
 {% /parameter %}
 
-{% parameter name="onTrackClick" type="(evt: ParticipantClickEvent) => void" optional=true %}
-_(Optional)_
+{% parameter name="trackRef" type="TrackReference" optional=true %}
+_(Optional)_ The track reference of the track to render.
 
 {% /parameter %}
 
-{% parameter name="participant" type="Participant" optional=true %}
+{% parameter name="name" type="string" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}
 
-{% parameter name="publication" type="TrackPublication" optional=true %}
+{% parameter name="participant" type="Participant" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}
 
-{% parameter name="source" type="Track.Source" optional=true %}
+{% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
 _(Optional)_
 
+{% callout type="caution" variation="compact" %}
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 {% /parameter %}
 
-{% parameter name="trackRef" type="TrackReference" optional=true %}
-_(Optional)_ The track reference of the track to render.
+{% parameter name="source" type="Track.Source" optional=true deprecated=true %}
+_(Optional)_
+
+{% callout type="caution" variation="compact" %}
+This property will be removed in a future version use `trackRef` instead.
 
+{% /callout %}
 {% /parameter %}

package/generated-docs/react/connectionqualityindicatoroptions.md

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

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

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

package/generated-docs/react/connectionqualityindicatorprops.md

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

package/generated-docs/react/connectionstatetoastprops.md

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

package/generated-docs/react/connectionstatetoastprops.room.md

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

package/generated-docs/react/connectionstatusprops.md

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

package/generated-docs/react/connectionstatusprops.room.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ConnectionStatusProps.room property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ConnectionStatusProps.room property
+# ConnectionStatusProps.room property
 
 The room from which the connection status should be displayed.
 

package/generated-docs/react/controlbarcontrols.md

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

package/generated-docs/react/controlbarprops.controls.md

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

package/generated-docs/react/controlbarprops.md

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

package/generated-docs/react/controlbarprops.variation.md

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

package/generated-docs/react/disconnectbuttonprops.md

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

package/generated-docs/react/disconnectbuttonprops.stoptracks.md

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

package/generated-docs/react/focuslayoutcontainerprops.focustrack.md

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

package/generated-docs/react/focuslayoutcontainerprops.md

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

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

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

package/generated-docs/react/focuslayoutprops.md

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

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

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

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

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