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/audiotrackprops.publication.md CHANGED Viewed

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "AudioTrackProps.trackRef property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## AudioTrackProps.trackRef property
+# AudioTrackProps.trackRef property
 The track reference of the track from which the audio is to be rendered.

package/generated-docs/react/audiotrackprops.volume.md CHANGED Viewed

@@ -1,8 +1,12 @@
+---
+{ "title": "AudioTrackProps.volume property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## AudioTrackProps.volume property
+# AudioTrackProps.volume property
-by the default the range is between 0 and 1
+Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.
 **Signature:**

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

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

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

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

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

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

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

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

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

package/generated-docs/react/carousellayoutprops.orientation.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "CarouselLayoutProps.orientation property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## CarouselLayoutProps.orientation property
+# CarouselLayoutProps.orientation property
 Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container.

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

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

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

@@ -1,10 +1,21 @@
+---
+{
+  "title": "CarouselView variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/layout/CarouselLayout.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## CarouselView variable
+# CarouselView variable
+{% callout type="caution" variation="normal" %}
+This API is deprecated:
+Renamed to \[\[CarouselLayout\]\]
-> Warning: This API is now obsolete.
->
-> Renamed to \[\[CarouselLayout\]\]
+{% /callout %}
 **Signature:**

package/generated-docs/react/chatentryprops.entry.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.entry property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ChatEntryProps.entry property
+# ChatEntryProps.entry property
 The chat massage object to display.

package/generated-docs/react/chatentryprops.hidename.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.hideName property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ChatEntryProps.hideName property
+# ChatEntryProps.hideName property
 Hide sender name. Useful when displaying multiple consecutive chat messages from the same person.

package/generated-docs/react/chatentryprops.hidetimestamp.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.hideTimestamp property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ChatEntryProps.hideTimestamp property
+# ChatEntryProps.hideTimestamp property
 Hide message timestamp.

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

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ChatEntryProps interface",
+  "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. -->
-## ChatEntryProps interface
+# ChatEntryProps interface
 ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component:

package/generated-docs/react/chatentryprops.messageformatter.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.messageFormatter property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ChatEntryProps.messageFormatter property
+# ChatEntryProps.messageFormatter property
 An optional formatter for the message body.

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

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

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

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

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

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

package/generated-docs/react/chatprops.messageformatter.md CHANGED Viewed

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

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

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

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

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

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "AudioConference",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/AudioConference.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # AudioConference
@@ -7,7 +14,7 @@ This component is the default setup of a classic LiveKit audio conferencing app.
 ## Import
 ```typescript
-import { AudioConference } from '@livekit/components-react';
+import { AudioConference } from "@livekit/components-react";
 ```
 ## Remarks

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "AudioTrack",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioTrack.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # AudioTrack
@@ -7,7 +14,7 @@ The AudioTrack component is responsible for rendering participant audio tracks.
 ## Import
 ```typescript
-import { AudioTrack } from '@livekit/components-react';
+import { AudioTrack } from "@livekit/components-react";
 ```
 ## Usage
@@ -22,8 +29,8 @@ import { AudioTrack } from '@livekit/components-react';
 ## Properties
-{% parameter name="name" type="string" optional=true %}
-_(Optional)_
+{% parameter name="muted" type="boolean" optional=true %}
+_(Optional)_ Mutes the audio track if set to `true`<!-- -->.
 {% /parameter %}
@@ -32,27 +39,48 @@ _(Optional)_
 {% /parameter %}
-{% parameter name="participant" type="Participant" optional=true %}
-_(Optional)_
+{% parameter name="trackRef" type="TrackReference" optional=true %}
+_(Optional)_ The track reference of the track from which the audio is to be rendered.
+{% /parameter %}
+{% parameter name="volume" type="number" optional=true %}
+_(Optional)_ Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.
 {% /parameter %}
-{% parameter name="publication" type="TrackPublication" 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="source" type="Track.Source" 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="trackRef" type="TrackReference" optional=true %}
-_(Optional)_ The track reference of the track from which the audio is to be rendered.
+{% 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="volume" type="number" optional=true %}
-_(Optional)_ by the default the range is between 0 and 1
+{% 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/component/audiovisualizer.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "AudioVisualizer",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioVisualizer.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # AudioVisualizer
@@ -7,7 +14,7 @@ The AudioVisualizer component is used to visualize the audio volume of a given a
 ## Import
 ```typescript
-import { AudioVisualizer } from '@livekit/components-react';
+import { AudioVisualizer } from "@livekit/components-react";
 ```
 ## Remarks
@@ -24,12 +31,16 @@ Requires a `TrackReferenceOrPlaceholder` to be provided either as a property or
 ## Properties
-{% parameter name="participant" type="Participant" optional=true %}
+{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 _(Optional)_
 {% /parameter %}
-{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" 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 %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "CarouselLayout",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/layout/CarouselLayout.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # CarouselLayout
@@ -7,7 +14,7 @@ The `CarouselLayout` component displays a list of tracks in a scroll container.
 ## Import
 ```typescript
-import { CarouselLayout } from '@livekit/components-react';
+import { CarouselLayout } from "@livekit/components-react";
 ```
 ## Remarks

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "Chat",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/Chat.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # Chat
@@ -7,7 +14,7 @@ The Chat component adds a basis chat functionality to the LiveKit room. The mess
 ## Import
 ```typescript
-import { Chat } from '@livekit/components-react';
+import { Chat } from "@livekit/components-react";
 ```
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "ChatEntry",
+  "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. -->
 # ChatEntry
@@ -7,7 +14,7 @@ The `ChatEntry` component holds and displays one chat message.
 ## Import
 ```typescript
-import { ChatEntry } from '@livekit/components-react';
+import { ChatEntry } from "@livekit/components-react";
 ```
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "ChatToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/ChatToggle.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # ChatToggle
@@ -7,7 +14,7 @@ The `ChatToggle` component is a button that toggles the visibility of the `Chat`
 ## Import
 ```typescript
-import { ChatToggle } from '@livekit/components-react';
+import { ChatToggle } from "@livekit/components-react";
 ```
 ## Remarks

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "ClearPinButton",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/ClearPinButton.tsx"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # ClearPinButton
@@ -7,7 +14,7 @@ The `ClearPinButton` is a basic html button with the added ability to signal the
 ## Import
 ```typescript
-import { ClearPinButton } from '@livekit/components-react';
+import { ClearPinButton } from "@livekit/components-react";
 ```
 ## Remarks

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "ConnectionQualityIndicator",
+  "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. -->
 # ConnectionQualityIndicator
@@ -7,7 +14,7 @@ The `ConnectionQualityIndicator` shows the individual connection quality of a pa
 ## Import
 ```typescript
-import { ConnectionQualityIndicator } from '@livekit/components-react';
+import { ConnectionQualityIndicator } from "@livekit/components-react";
 ```
 ## Usage

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "ConnectionState",
+  "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. -->
 # ConnectionState
@@ -7,7 +14,7 @@ The `ConnectionState` component displays the connection status of the room as st
 ## Import
 ```typescript
-import { ConnectionState } from '@livekit/components-react';
+import { ConnectionState } from "@livekit/components-react";
 ```
 ## Usage