@livekit/components-js-docs 0.1.7 → 0.1.9

package/generated-docs/react/focustoggleprops.md

@@ -21,8 +21,6 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
 
 ## Properties
 
-| Property                                                | Type                                                                  | Description  |
-| ------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
-| [participant?](./react/focustoggleprops.participant.md) | Participant                                                           | _(Optional)_ |
-| [trackRef?](./react/focustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
-| [trackSource?](./react/focustoggleprops.tracksource.md) | Track.Source                                                          | _(Optional)_ |
+| Property                                          | Type                                                                  | Description  |
+| ------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [trackRef?](./react/focustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |

package/generated-docs/react/hook/usechat.md

@@ -9,7 +9,7 @@
 
 # useChat
 
-The `useChat` hook provides chat functionality for a LiveKit room. It returns a simple `send` function to send chat messages and an array of `chatMessages` to hold received messages.
+The `useChat` hook provides chat functionality for a LiveKit room. It returns a simple `send` function to send chat messages and an array of `chatMessages` to hold received messages. It also returns a `update` function that allows you to implement message-edit functionality.
 
 ## Import
 
@@ -19,7 +19,7 @@ import { useChat } from "@livekit/components-react";
 
 ## Remarks
 
-It is possible to pass configurations for custom message encoding and decoding.
+It is possible to pass configurations for custom message encoding and decoding and non-default topics on which to send the messages.
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
@@ -32,7 +32,8 @@ It is possible to pass configurations for custom message encoding and decoding.
 
 ```typescript
 {
-    send: ((message: string) => Promise<void>) | undefined;
+    send: ((message: string) => Promise<import("@livekit/components-core").ChatMessage>) | undefined;
+    update: ((message: string, messageId: string) => Promise<import("@livekit/components-core").ChatMessage>) | undefined;
     chatMessages: ReceivedChatMessage[];
     isSending: boolean;
 }

package/generated-docs/react/hook/usefocustoggle.md

@@ -34,20 +34,6 @@ return <button {...mergedProps}>{inFocus ? "Unfocus" : "Focus"}</button>;
 {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 {% /parameter %}
 
-{% parameter name="participant" type="Participant" optional=true deprecated=true %}
-{% callout type="caution" variation="compact" %}
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-{% /parameter %}
-
-{% parameter name="trackSource" type="Track.Source" optional=true deprecated=true %}
-{% callout type="caution" variation="compact" %}
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-{% /parameter %}
-
 ## Returns
 
 ```typescript

package/generated-docs/react/hook/usemediadevices.md

@@ -28,8 +28,9 @@ const audioDevices = useMediaDevices({ kind: "audioinput" });
 
 ## Properties
 
-{% parameter name="{ kind }" type="{
+{% parameter name="{ kind, onError, }" type="{
       kind: MediaDeviceKind;
+      onError?: (e: Error) => void;
   }" optional=false %}
 {% /parameter %}
 

package/generated-docs/react/hook/useparticipanttile.md

@@ -39,27 +39,6 @@ The track reference to display.
 
 {% /parameter %}
 
-{% parameter name="participant" type="Participant" optional=true deprecated=true %}
-{% callout type="caution" variation="compact" %}
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-{% /parameter %}
-
-{% parameter name="publication" type="TrackPublication" optional=true deprecated=true %}
-{% 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 deprecated=true %}
-{% callout type="caution" variation="compact" %}
-This parameter will be removed in a future version use `trackRef` instead.
-
-{% /callout %}
-{% /parameter %}
-
 ## Returns
 
 ```typescript

package/generated-docs/react/hook/useparticipanttracks.md

@@ -0,0 +1,34 @@
+---
+{
+  "title": "useParticipantTracks",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantTracks.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useParticipantTracks
+
+`useParticipantTracks` is a custom React that allows you to get tracks of a specific participant only, by specifiying the participant's identity. If the participant identity is not passed the hook will try to get the participant from a participant context.
+
+## Import
+
+```typescript
+import { useParticipantTracks } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="sources" type="Track.Source[]" optional=false %}
+{% /parameter %}
+
+{% parameter name="participantIdentity" type="string" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+TrackReference[]
+```

package/generated-docs/react/hook/usepreviewtracks.md

@@ -28,5 +28,5 @@ import { usePreviewTracks } from "@livekit/components-react";
 ## Returns
 
 ```typescript
-LocalTrack[] | undefined
+(LocalTrack < Track.Kind > []) | undefined;
 ```

package/generated-docs/react/hook/usetrackbyname.md

@@ -9,6 +9,8 @@
 
 # useTrackByName
 
+This function `useTrackByName` allows you to access a track by referencing its track name. Inside the function, it ensures that the a valid `participant` reference is available by checking for both a passed participant argument and, if not available, a valid participant context.
+
 ## Import
 
 ```typescript
@@ -19,20 +21,14 @@ import { useTrackByName } from "@livekit/components-react";
 
 ## Properties
 
-{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
+{% parameter name="name" type="string" optional=false %}
 {% /parameter %}
 
-{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% parameter name="participant" type="Participant" optional=true %}
 {% /parameter %}
 
 ## Returns
 
 ```typescript
-{
-  publication: import("livekit-client").TrackPublication | undefined;
-  isMuted: boolean | undefined;
-  isSubscribed: boolean | undefined;
-  track: import("livekit-client").Track | undefined;
-  elementProps: import("react").HTMLAttributes<HTMLElement>;
-}
+import("@livekit/components-core").TrackReferenceOrPlaceholder;
 ```