npm - @livekit/components-js-docs - Versions diffs - 0.1.47 → 0.1.49 - Mend

@livekit/components-js-docs 0.1.47 → 0.1.49

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/usestartaudioprops.room.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UseStartAudioProps.room 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 %}
 **Signature:**
 ```typescript

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

@@ -9,14 +9,18 @@
 # UseStartVideoProps interface
+{% callout type="note" variation="normal" %}
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+{% /callout %}
 **Signature:**
 ```typescript
 export interface UseStartVideoProps
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                     | Type                                                | Description  |

package/generated-docs/react/usestartvideoprops.props.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UseStartVideoProps.props 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 %}
 **Signature:**
 ```typescript

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

@@ -6,6 +6,12 @@
 # UseStartVideoProps.room 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 %}
 **Signature:**
 ```typescript

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

@@ -9,6 +9,12 @@
 # UseSwipeOptions type
+{% callout type="note" variation="normal" %}
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+{% /callout %}
 **Signature:**
 ```typescript
@@ -18,5 +24,3 @@ export type UseSwipeOptions = {
   onRightSwipe?: () => void;
 };
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

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

@@ -20,5 +20,3 @@ export type UseTracksHookReturnType<T> = T extends Track.Source[]
 ```
 **References:** [TrackReference](./react/trackreference.md)<!-- -->, [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -18,5 +18,3 @@ export type UseTracksOptions = {
   room?: Room;
 };
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -16,5 +16,3 @@ export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackT
 ```
 **Extends:** Omit&lt;[TrackToggleProps](./react/tracktoggleprops.md)<!-- -->&lt;T&gt;, 'showIcon'&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md CHANGED Viewed

@@ -13,5 +13,3 @@ Overwrites the default sort function.
 ```typescript
 customSortFunction?: (trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[];
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

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

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

package/generated-docs/react/videoconferenceprops.settingscomponent.md CHANGED Viewed

@@ -6,10 +6,14 @@
 # VideoConferenceProps.SettingsComponent 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 %}
 **Signature:**
 ```typescript
 SettingsComponent?: React.ComponentType;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

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

@@ -13,5 +13,3 @@ The track reference of the track to render.
 ```typescript
 trackRef?: TrackReference;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/voiceassistant.agent.md CHANGED Viewed

@@ -6,7 +6,11 @@
 # VoiceAssistant.agent property
-> 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 %}
 **Signature:**

package/generated-docs/react/voiceassistant.agentattributes.md CHANGED Viewed

@@ -6,7 +6,11 @@
 # VoiceAssistant.agentAttributes property
-> 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 %}
 **Signature:**

package/generated-docs/react/voiceassistant.agenttranscriptions.md CHANGED Viewed

@@ -6,7 +6,11 @@
 # VoiceAssistant.agentTranscriptions property
-> 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 %}
 **Signature:**

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

@@ -6,7 +6,11 @@
 # VoiceAssistant.audioTrack property
-> 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 %}
 **Signature:**

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

@@ -9,7 +9,11 @@
 # VoiceAssistant interface
-> 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 %}
 **Signature:**
@@ -17,8 +21,6 @@
 export interface VoiceAssistant
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                             | Type                                                     | Description  |

package/generated-docs/react/voiceassistant.state.md CHANGED Viewed

@@ -6,7 +6,11 @@
 # VoiceAssistant.state property
-> 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 %}
 **Signature:**

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

@@ -9,7 +9,11 @@
 # VoiceAssistantControlBarControls type
-> 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 %}
 **Signature:**
@@ -19,5 +23,3 @@ export type VoiceAssistantControlBarControls = {
   leave?: boolean;
 };
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/voiceassistantcontrolbarprops.controls.md CHANGED Viewed

@@ -6,7 +6,11 @@
 # VoiceAssistantControlBarProps.controls property
-> 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 %}
 **Signature:**

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

@@ -9,7 +9,11 @@
 # VoiceAssistantControlBarProps interface
-> 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 %}
 **Signature:**
@@ -19,8 +23,6 @@ export interface VoiceAssistantControlBarProps extends React.HTMLAttributes<HTML
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                                     | Type                                                                            | Description                                                                                                                                                                        |

package/generated-docs/react/voiceassistantcontrolbarprops.ondeviceerror.md CHANGED Viewed

@@ -6,7 +6,11 @@
 # VoiceAssistantControlBarProps.onDeviceError property
-> 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 %}
 **Signature:**

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

@@ -6,7 +6,11 @@
 # VoiceAssistantControlBarProps.saveUserChoices property
-> 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 %}
 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.
@@ -15,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/widgetstate.md CHANGED Viewed

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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.47",
+  "version": "0.1.49",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "2.6.9"
+    "@livekit/components-react": "2.6.11"
   },
   "author": "",
   "license": "Apache-2.0",