@livekit/components-js-docs 0.1.0 → 0.1.2

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useParticipants",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipants.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useParticipants
@@ -7,7 +14,7 @@ The `useParticipants` hook returns all participants (local and remote) of the cu
 ## Import
 
 ```typescript
-import { useParticipants } from '@livekit/components-react';
+import { useParticipants } from "@livekit/components-react";
 ```
 
 ## Remarks
@@ -25,7 +32,7 @@ const participants = useParticipants();
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="options" type="UseParticipantsOptions" optional=true %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useParticipantTile",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantTile.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useParticipantTile
@@ -7,7 +14,7 @@ The `useParticipantTile` hook is used to implement the `ParticipantTile` and ret
 ## Import
 
 ```typescript
-import { useParticipantTile } from '@livekit/components-react';
+import { useParticipantTile } from "@livekit/components-react";
 ```
 
 ## Remarks
@@ -16,9 +23,41 @@ The returned props include many data attributes that are useful for CSS styling
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
+
+{% parameter name="htmlProps" type="React.HTMLAttributes<T>" optional=false %}
+{% /parameter %}
+
+{% parameter name="disableSpeakingIndicator" type="boolean" optional=true %}
+{% /parameter %}
+
+{% parameter name="onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
+{% /parameter %}
+
+{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+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.
 
-{% parameter name="{ trackRef, participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, }" type="UseParticipantTileProps<T>" optional=false %}
+{% /callout %}
 {% /parameter %}
 
 ## Returns

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

@@ -0,0 +1,38 @@
+---
+{
+  "title": "usePersistentUserChoices",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/usePersistentUserChoices.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePersistentUserChoices
+
+A hook that provides access to user choices stored in local storage, such as selected media devices and their current state (on or off), as well as the user name.
+
+## Import
+
+```typescript
+import { usePersistentUserChoices } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="options" type="UsePersistentUserChoicesOptions" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    userChoices: LocalUserChoices;
+    saveAudioInputEnabled: (isEnabled: boolean) => void;
+    saveVideoInputEnabled: (isEnabled: boolean) => void;
+    saveAudioInputDeviceId: (deviceId: string) => void;
+    saveVideoInputDeviceId: (deviceId: string) => void;
+    saveUsername: (username: string) => void;
+}
+```

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "usePinnedTracks",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/usePinnedTracks.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # usePinnedTracks
@@ -7,7 +14,7 @@ The `usePinnedTracks` hook returns a array of the pinned tracks of the current r
 ## Import
 
 ```typescript
-import { usePinnedTracks } from '@livekit/components-react';
+import { usePinnedTracks } from "@livekit/components-react";
 ```
 
 ## Remarks
@@ -22,7 +29,7 @@ const pinnedTracks = usePinnedTracks();
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="layoutContext" type="LayoutContextType" optional=true %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "usePreviewDevice",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # usePreviewDevice
@@ -5,12 +12,12 @@
 ## Import
 
 ```typescript
-import { usePreviewDevice } from '@livekit/components-react';
+import { usePreviewDevice } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="deviceId" type="string" optional=false %}
 {% /parameter %}

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

@@ -0,0 +1,32 @@
+---
+{
+  "title": "usePreviewTracks",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePreviewTracks
+
+## Import
+
+```typescript
+import { usePreviewTracks } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="options" type="CreateLocalTracksOptions" optional=false %}
+{% /parameter %}
+
+{% parameter name="onError" type="(err: Error) => void" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+LocalTrack[] | undefined
+```

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useRemoteParticipant",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRemoteParticipant.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useRemoteParticipant
@@ -7,7 +14,7 @@ The `useRemoteParticipant` hook returns the RemoteParticipant with the given `id
 ## Import
 
 ```typescript
-import { useRemoteParticipant } from '@livekit/components-react';
+import { useRemoteParticipant } from "@livekit/components-react";
 ```
 
 ## Remarks
@@ -17,12 +24,12 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
 ## Usage
 
 ```tsx
-const participant = useRemoteParticipant('Russ');
+const participant = useRemoteParticipant("Russ");
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="identity" type="string" optional=false %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useRemoteParticipants",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRemoteParticipants.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useRemoteParticipants
@@ -7,7 +14,7 @@ The `useRemoteParticipants` hook returns all remote participants (without the lo
 ## Import
 
 ```typescript
-import { useRemoteParticipants } from '@livekit/components-react';
+import { useRemoteParticipants } from "@livekit/components-react";
 ```
 
 ## Remarks
@@ -25,7 +32,7 @@ const participants = useRemoteParticipants();
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="options" type="UseRemoteParticipantsOptions" optional=true %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useRoomContext",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/room-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useRoomContext
@@ -7,7 +14,7 @@ Ensures that a room is provided via context. If no room is provided, an error is
 ## Import
 
 ```typescript
-import { useRoomContext } from '@livekit/components-react';
+import { useRoomContext } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useRoomInfo",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRoomInfo.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useRoomInfo
@@ -5,12 +12,12 @@
 ## Import
 
 ```typescript
-import { useRoomInfo } from '@livekit/components-react';
+import { useRoomInfo } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="options" type="UseRoomInfoOptions" optional=true %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useSortedParticipants",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSortedParticipants.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useSortedParticipants
@@ -7,12 +14,12 @@ The `useSortedParticipants` hook returns the participants sorted by importance.
 ## Import
 
 ```typescript
-import { useSortedParticipants } from '@livekit/components-react';
+import { useSortedParticipants } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="participants" type="Array<Participant>" optional=false %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useSpeakingParticipants",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSpeakingParticipants.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useSpeakingParticipants
@@ -7,7 +14,7 @@ The `useSpeakingParticipants` hook returns the only the active speakers of all p
 ## Import
 
 ```typescript
-import { useSpeakingParticipants } from '@livekit/components-react';
+import { useSpeakingParticipants } from "@livekit/components-react";
 ```
 
 ## Usage

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

@@ -0,0 +1,43 @@
+---
+{
+  "title": "useStartAudio",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartAudio.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useStartAudio
+
+In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The `useStatAudio` 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
+
+```typescript
+import { useStartAudio } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% /parameter %}
+
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        style: {
+            display: string;
+        };
+    };
+    canPlayAudio: boolean;
+}
+```

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

@@ -0,0 +1,44 @@
+---
+{
+  "title": "useSwipe",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSwipe.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSwipe
+
+Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes.
+
+## Import
+
+```typescript
+import { useSwipe } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+ <div
+      onTouchStart={onTouchStart}
+      onTouchMove={onTouchMove}
+      onTouchEnd={onTouchEnd}
+    >
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="element" type="React.RefObject<HTMLElement>" optional=false %}
+{% /parameter %}
+
+{% parameter name="options" type="UseSwipeOptions" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+void
+```

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useToken",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useToken.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useToken
@@ -7,7 +14,7 @@ The `useToken` hook fetches a token from the given token endpoint with the given
 ## Import
 
 ```typescript
-import { useToken } from '@livekit/components-react';
+import { useToken } from "@livekit/components-react";
 ```
 
 ## Usage
@@ -18,7 +25,7 @@ const token = useToken(<token-endpoint>, roomName, { userInfo: { identity, name
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="roomName" type="string" optional=false %}
 {% /parameter %}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useTrack",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrack.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useTrack
@@ -5,12 +12,12 @@
 ## Import
 
 ```typescript
-import { useTrack } from '@livekit/components-react';
+import { useTrack } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="trackRef" type="TrackIdentifier" optional=false %}
 {% /parameter %}
@@ -22,10 +29,10 @@ import { useTrack } from '@livekit/components-react';
 
 ```typescript
 {
-  publication: import('livekit-client').TrackPublication | undefined;
+  publication: import("livekit-client").TrackPublication | undefined;
   isMuted: boolean | undefined;
   isSubscribed: boolean | undefined;
-  track: import('livekit-client').Track | undefined;
+  track: import("livekit-client").Track | undefined;
   elementProps: React.HTMLAttributes<HTMLElement>;
 }
 ```

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useTrackByName",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackByName.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useTrackByName
@@ -5,12 +12,12 @@
 ## Import
 
 ```typescript
-import { useTrackByName } from '@livekit/components-react';
+import { useTrackByName } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="options" type="UseMediaTrackOptions" optional=true %}
 {% /parameter %}
@@ -22,10 +29,10 @@ import { useTrackByName } from '@livekit/components-react';
 
 ```typescript
 {
-  publication: import('livekit-client').TrackPublication | undefined;
+  publication: import("livekit-client").TrackPublication | undefined;
   isMuted: boolean | undefined;
   isSubscribed: boolean | undefined;
-  track: import('livekit-client').Track | undefined;
-  elementProps: import('react').HTMLAttributes<HTMLElement>;
+  track: import("livekit-client").Track | undefined;
+  elementProps: import("react").HTMLAttributes<HTMLElement>;
 }
 ```

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

@@ -1,17 +1,28 @@
+---
+{
+  "title": "useTrackContext",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useTrackContext
 
-> Warning: This API is now obsolete.
->
-> `useTrackContext` has been to `useTrackRefContext`<!-- -->, use this as a drop in replacement.
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+`useTrackContext` has been renamed to `useTrackRefContext`<!-- -->, use this as a drop in replacement.
+
+{% /callout %}
 
 Ensures that a track reference is provided via context. If not inside a `TrackRefContext`<!-- -->, an error is thrown.
 
 ## Import
 
 ```typescript
-import { useTrackContext } from '@livekit/components-react';
+import { useTrackContext } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -1,3 +1,10 @@
+---
+{
+  "title": "useTrackMutedIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackMutedIndicator.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useTrackMutedIndicator
@@ -7,7 +14,7 @@ The `useTrackMutedIndicator` hook is used to implement the `TrackMutedIndicator`
 ## Import
 
 ```typescript
-import { useTrackMutedIndicator } from '@livekit/components-react';
+import { useTrackMutedIndicator } from "@livekit/components-react";
 ```
 
 ## Usage
@@ -18,7 +25,7 @@ const { isMuted } = useTrackMutedIndicator(trackRef);
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 {% /parameter %}

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

@@ -1,20 +1,31 @@
+---
+{
+  "title": "useTrackMutedIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackMutedIndicator.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # useTrackMutedIndicator
 
-> Warning: This API is now obsolete.
->
-> This overload will be removed in a future version, pass in trackRef instead.
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This overload will be removed in a future version, pass in trackRef instead.
+
+{% /callout %}
 
 ## Import
 
 ```typescript
-import { useTrackMutedIndicator } from '@livekit/components-react';
+import { useTrackMutedIndicator } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
-## Parameters
+## Properties
 
 {% parameter name="source" type="Track.Source" optional=false %}
 {% /parameter %}