@livekit/components-js-docs 0.1.1 → 0.1.2

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

@@ -0,0 +1,35 @@
+---
+{
+  "title": "useFacingMode",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useFacingMode.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useFacingMode
+
+Try to determine the `facingMode` of a local participant video track.
+
+## Import
+
+```typescript
+import { useFacingMode } from "@livekit/components-react";
+```
+
+## Remarks
+
+Works only on local video tracks.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="trackReference" type="TrackReferenceOrPlaceholder" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+"user" | "environment" | "left" | "right" | "undefined";
+```

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

@@ -0,0 +1,52 @@
+---
+{
+  "title": "usePagination",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/usePagination.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePagination
+
+The `usePagination` hook implements simple pagination logic for use with arrays.
+
+## Import
+
+```typescript
+import { usePagination } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const tracks = useTracks();
+const pagination = usePagination(4, tracks);
+
+<TrackLoop tracks={pagination.tracks} />;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="itemPerPage" type="number" optional=false %}
+{% /parameter %}
+
+{% parameter name="trackReferences" type="TrackReferenceOrPlaceholder[]" optional=false %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+    totalPageCount: number;
+    nextPage: () => void;
+    prevPage: () => void;
+    setPage: (num: number) => void;
+    firstItemIndex: number;
+    lastItemIndex: number;
+    tracks: TrackReferenceOrPlaceholder[];
+    currentPage: number;
+}
+```

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/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/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
+```