npm - @livekit/components-js-docs - Versions diffs - 0.1.0 → 0.1.2 - Mend

@livekit/components-js-docs 0.1.0 → 0.1.2

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 (455) hide show

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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:**
@@ -14,7 +21,8 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
 ## Properties
-| Property                                           | Type                                                | Description  |
-| -------------------------------------------------- | --------------------------------------------------- | ------------ |
-| [controls?](./react/controlbarprops.controls.md)   | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_ |
-| [variation?](./react/controlbarprops.variation.md) | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_ |
+| Property                                                       | Type                                                | Description                                                                                                                                                           |
+| -------------------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [controls?](./react/controlbarprops.controls.md)               | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_                                                                                                                                                          |
+| [saveUserChoices?](./react/controlbarprops.saveuserchoices.md) | boolean                                             | _(Optional)_ If <code>true</code>, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room. |
+| [variation?](./react/controlbarprops.variation.md)             | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_                                                                                                                                                          |

package/generated-docs/react/controlbarprops.saveuserchoices.md ADDED Viewed

@@ -0,0 +1,17 @@
+---
+{ "title": "ControlBarProps.saveUserChoices property" }
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# ControlBarProps.saveUserChoices property
+If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
+**Signature:**
+```typescript
+saveUserChoices?: boolean;
+```
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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:**

package/generated-docs/react/focuslayoutprops.trackref.md CHANGED Viewed

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

package/generated-docs/react/focustoggleprops.md CHANGED Viewed

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

package/generated-docs/react/focustoggleprops.participant.md CHANGED Viewed

@@ -1,10 +1,18 @@
+---
+{ "title": "FocusToggleProps.participant property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## FocusToggleProps.participant property
+# FocusToggleProps.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/focustoggleprops.trackref.md CHANGED Viewed

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

package/generated-docs/react/focustoggleprops.tracksource.md CHANGED Viewed

@@ -1,10 +1,18 @@
+---
+{ "title": "FocusToggleProps.trackSource property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## FocusToggleProps.trackSource property
+# FocusToggleProps.trackSource 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/formatchatmessagelinks.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "formatChatMessageLinks",
+  "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. -->
 # formatChatMessageLinks

package/generated-docs/react/gridlayoutprops.children.md CHANGED Viewed

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

package/generated-docs/react/gridlayoutprops.md CHANGED Viewed

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

package/generated-docs/react/gridlayoutprops.tracks.md CHANGED Viewed

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