npm - @livekit/components-js-docs - Versions diffs - 0.1.48 → 0.1.50 - Mend

@livekit/components-js-docs 0.1.48 → 0.1.50

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

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

@@ -28,5 +28,3 @@ The component is implemented with other LiveKit components like `FocusContextPro
   <AudioConference />
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -25,8 +25,6 @@ import { AudioTrack } from "@livekit/components-react";
 </ParticipantTile>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="muted" type="boolean" optional=true %}

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

@@ -33,8 +33,6 @@ Requires a `TrackReferenceOrPlaceholder` to be provided either as a property or
 <AudioVisualizer />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="trackRef" type="TrackReference" optional=true %}

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

@@ -9,7 +9,11 @@
 # BarVisualizer
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+This feature is under active development and may change based on developer feedback and real-world usage.
+{% /callout %}
 Visualizes audio signals from a TrackReference as bars. If the `state` prop is set, it automatically transitions between VoiceAssistant states.
@@ -31,5 +35,3 @@ function SimpleVoiceAssistant() {
   return <BarVisualizer state={state} trackRef={audioTrack} />;
 }
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -30,8 +30,6 @@ const tracks = useTracks([Track.Source.Camera]);
 </CarouselLayout>;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="children" type="React.ReactNode" optional=false %}

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

@@ -25,8 +25,6 @@ import { Chat } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="messageFormatter" type="MessageFormatter" optional=true %}

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

@@ -25,8 +25,6 @@ import { ChatEntry } from "@livekit/components-react";
 </Chat>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="entry" type="ReceivedChatMessage" optional=false %}

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

@@ -28,5 +28,3 @@ For the component to have any effect it has to live inside a `LayoutContext` con
   <ToggleChat />
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -28,5 +28,3 @@ This component works only inside a `LayoutContext`<!-- -->.
   <ClearPinButton>Back to grid view</ClearPinButton>
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -22,5 +22,3 @@ import { ConnectionQualityIndicator } from "@livekit/components-react";
 ```tsx
 <ConnectionQualityIndicator />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -25,8 +25,6 @@ import { ConnectionState } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="room" type="Room" optional=true %}

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

@@ -17,8 +17,6 @@ The `ConnectionStateToast` component displays a toast notification indicating th
 import { ConnectionStateToast } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 {% parameter name="room" type="Room" optional=true %}

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

@@ -29,8 +29,6 @@ This component is build with other LiveKit components like `TrackToggle`<!-- -->
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="controls" type="ControlBarControls" optional=true %}

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

@@ -25,8 +25,6 @@ import { DisconnectButton } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="stopTracks" type="boolean" optional=true %}

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

@@ -17,8 +17,6 @@ The `FocusLayout` component is just a light wrapper around the `ParticipantTile`
 import { FocusLayout } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 {% parameter name="onParticipantClick" type="(evt: ParticipantClickEvent) => void" optional=true %}

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

@@ -16,5 +16,3 @@ The `FocusLayoutContainer` is a layout component that expects two children: A sm
 ```typescript
 import { FocusLayoutContainer } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -29,8 +29,6 @@ This component needs to live inside `LayoutContext` to work properly.
 </ParticipantTile>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}

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

@@ -31,8 +31,6 @@ To ensure visual stability when tiles are reordered due to track updates, the co
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="children" type="React.ReactNode" optional=false %}

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

@@ -14,5 +14,3 @@
 ```typescript
 import { LayoutContext } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -9,14 +9,18 @@
 # LayoutContextProvider
+{% callout type="note" variation="normal" %}
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+{% /callout %}
 ## Import
 ```typescript
 import { LayoutContextProvider } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 {% parameter name="onPinChange" type="(state: PinState) => void" optional=true %}

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

@@ -25,8 +25,6 @@ import { LiveKitRoom } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="serverUrl" type="string | undefined" optional=false %}

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

@@ -29,8 +29,6 @@ This component is implemented with the `MediaDeviceSelect` LiveKit components.
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="initialSelection" type="string" optional=true %}

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

@@ -25,8 +25,6 @@ import { MediaDeviceSelect } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="kind" type="MediaDeviceKind" optional=false %}

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

@@ -23,8 +23,6 @@ import { ParticipantAudioTile } from "@livekit/components-react";
 <ParticipantAudioTile />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="disableSpeakingIndicator" type="boolean" optional=true %}

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

@@ -14,5 +14,3 @@
 ```typescript
 import { ParticipantContext } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -24,5 +24,3 @@ import { ParticipantContextIfNeeded } from "@livekit/components-react";
   ...
 </ParticipantContextIfNeeded>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -30,8 +30,6 @@ const participants = useParticipants();
 </ParticipantLoop>;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="children" type="React.ReactNode" optional=false %}

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

@@ -22,5 +22,3 @@ import { ParticipantName } from "@livekit/components-react";
 ```tsx
 <ParticipantName />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -17,17 +17,19 @@ The `ParticipantTile` component is the base utility wrapper for displaying a vis
 import { ParticipantTile } from "@livekit/components-react";
 ```
-## Usage Example 1
+## Usage
-Using the `ParticipantTile` component with a track reference:
+### Using the
+`ParticipantTile` component with a track reference:
 ```tsx
 <ParticipantTile trackRef={trackRef} />
 ```
-## Usage Example 2
+### Using the
-Using the `ParticipantTile` component as a child of the `TrackLoop` component:
+`ParticipantTile` component as a child of the `TrackLoop` component:
 ```tsx
 <TrackLoop>
@@ -35,8 +37,6 @@ Using the `ParticipantTile` component as a child of the `TrackLoop` component:
 </TrackLoop>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 2} /%}
 ## Properties
 {% parameter name="disableSpeakingIndicator" type="boolean" optional=true %}

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

@@ -27,8 +27,6 @@ This component is independent of the `LiveKitRoom` component and should not be n
 <PreJoin />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="camLabel" type="string" optional=true %}

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

@@ -25,8 +25,6 @@ import { RoomAudioRenderer } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="muted" type="boolean" optional=true %}

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

@@ -14,5 +14,3 @@
 ```typescript
 import { RoomContext } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -24,5 +24,3 @@ import { RoomName } from "@livekit/components-react";
   <RoomName />
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -25,8 +25,6 @@ import { StartAudio } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="label" type="string" optional=false %}

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

@@ -25,8 +25,6 @@ import { StartMediaButton } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="label" type="string" optional=true %}

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

@@ -22,5 +22,3 @@ import { Toast } from "@livekit/components-react";
 ```tsx
 <Toast>Connecting...</Toast>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}

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

@@ -28,8 +28,6 @@ const trackRefs = useTracks([Track.Source.Camera]);
 </TrackLoop>;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="children" type="React.ReactNode" optional=false %}

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

@@ -23,8 +23,6 @@ import { TrackMutedIndicator } from "@livekit/components-react";
 <TrackMutedIndicator trackRef={trackRef} />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=false %}

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

@@ -16,5 +16,3 @@ This context provides a `TrackReferenceOrPlaceholder` to all child components.
 ```typescript
 import { TrackRefContext } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -26,8 +26,6 @@ import { TrackToggle } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="source" type="T" optional=false %}

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

@@ -29,8 +29,6 @@ The component is implemented with other LiveKit components like `FocusContextPro
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="chatMessageDecoder" type="MessageDecoder" optional=true %}

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

@@ -23,8 +23,6 @@ import { VideoTrack } from "@livekit/components-react";
 <VideoTrack trackRef={trackRef} />
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="manageSubscription" type="boolean" optional=true %}

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

@@ -9,7 +9,11 @@
 # VoiceAssistantControlBar
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+This feature is under active development and may change based on developer feedback and real-world usage.
+{% /callout %}
 ## Import
@@ -25,8 +29,6 @@ import { VoiceAssistantControlBar } from "@livekit/components-react";
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 {% parameter name="controls" type="VoiceAssistantControlBarControls" optional=true %}

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

@@ -15,8 +15,6 @@
 export interface ConnectionQualityIndicatorOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                                 | Type        | Description  |

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

@@ -16,5 +16,3 @@ export interface ConnectionQualityIndicatorProps extends React.HTMLAttributes<HT
 ```
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -17,8 +17,6 @@ export interface ConnectionStateToastProps extends React.HTMLAttributes<HTMLDivE
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                           | Type | Description  |

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

@@ -17,8 +17,6 @@ export interface ConnectionStatusProps extends React.HTMLAttributes<HTMLDivEleme
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                       | Type | Description                                                                 |

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

@@ -13,5 +13,3 @@ The room from which the connection status should be displayed.
 ```typescript
 room?: Room;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -21,5 +21,3 @@ export type ControlBarControls = {
   settings?: boolean;
 };
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -17,8 +17,6 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                       | Type                                                        | Description                                                                                                                                                          |

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

@@ -6,6 +6,12 @@
 # ControlBarProps.saveUserChoices property
+{% callout type="note" variation="normal" %}
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+{% /callout %}
 If `true`<!-- -->, the user's device choices will be persisted. This will enable the user to have the same device choices when they rejoin the room.
 **Signature:**
@@ -13,5 +19,3 @@ If `true`<!-- -->, the user's device choices will be persisted. This will enable
 ```typescript
 saveUserChoices?: boolean;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -17,8 +17,6 @@ export interface DisconnectButtonProps extends React.ButtonHTMLAttributes<HTMLBu
 **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                   | Type    | Description  |

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

@@ -16,5 +16,3 @@ export interface FocusLayoutContainerProps extends React.HTMLAttributes<HTMLDivE
 ```
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -17,8 +17,6 @@ export interface FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
 **Extends:** React.HTMLAttributes&lt;HTMLElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                              | Type                                                                  | Description                                            |

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

@@ -13,5 +13,3 @@ The track to display in the focus layout.
 ```typescript
 trackRef?: TrackReferenceOrPlaceholder;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -17,8 +17,6 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
 **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                          | Type                                                                  | Description  |

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

@@ -14,5 +14,3 @@
 ```typescript
 export declare function formatChatMessageLinks(message: string): React.ReactNode;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -20,5 +20,3 @@ export type GridLayoutDefinition = {
   orientation?: "landscape" | "portrait";
 };
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -17,8 +17,6 @@ export interface GridLayoutProps extends React.HTMLAttributes<HTMLDivElement>, P
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, Pick&lt;[UseParticipantsOptions](./react/useparticipantsoptions.md)<!-- -->, 'updateOnlyOn'&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                        | Type                                                                              | Description |

package/generated-docs/react/hook/useaudioplayback.md CHANGED Viewed

@@ -9,6 +9,12 @@
 # useAudioPlayback
+{% callout type="note" variation="normal" %}
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+{% /callout %}
 In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The `useAudioPlayback` hook returns an object with a boolean `canPlayAudio` flag that indicates whether audio playback is allowed in the current context, as well as a `startAudio` function that can be called in a button `onClick` callback to start audio playback in the current context.
 ## Import
@@ -17,8 +23,6 @@ In many browsers to start audio playback, the user must perform a user-initiated
 import { useAudioPlayback } from "@livekit/components-react";
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 {% parameter name="room" type="Room" optional=true %}