@livekit/components-js-docs 0.1.1 → 0.1.2

package/generated-docs/react/prejoinprops.persistuserchoices.md

@@ -0,0 +1,17 @@
+---
+{ "title": "PreJoinProps.persistUserChoices property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.persistUserChoices property
+
+If true, user choices are persisted across sessions.
+
+**Signature:**
+
+```typescript
+persistUserChoices?: boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.showe2eeoptions.md

@@ -6,8 +6,18 @@
 
 # PreJoinProps.showE2EEOptions property
 
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+E2EE options will be removed from PreJoin in a future version \*
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript
 showE2EEOptions?: boolean;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/roomaudiorendererprops.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "RoomAudioRendererProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomAudioRenderer.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps interface
+
+**Signature:**
+
+```typescript
+export interface RoomAudioRendererProps
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                            | Type    | Description                                                                                                                                           |
+| --------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [muted?](./react/roomaudiorendererprops.muted.md)   | boolean | _(Optional)_ If set to <code>true</code>, mutes all audio tracks rendered by the component.                                                           |
+| [volume?](./react/roomaudiorendererprops.volume.md) | number  | _(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

package/generated-docs/react/roomaudiorendererprops.muted.md

@@ -0,0 +1,21 @@
+---
+{ "title": "RoomAudioRendererProps.muted property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps.muted property
+
+If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
+
+**Signature:**
+
+```typescript
+muted?: boolean;
+```
+
+## Remarks
+
+If set to `true`<!-- -->, the server will stop sending audio track data to the client.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/roomaudiorendererprops.volume.md

@@ -0,0 +1,17 @@
+---
+{ "title": "RoomAudioRendererProps.volume property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps.volume property
+
+Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.
+
+**Signature:**
+
+```typescript
+volume?: number;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usepersistentuserchoicesoptions.defaults.md

@@ -0,0 +1,17 @@
+---
+{ "title": "UsePersistentUserChoicesOptions.defaults property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions.defaults property
+
+The default value to use if reading from local storage returns no results or fails.
+
+**Signature:**
+
+```typescript
+defaults?: Partial<LocalUserChoices>;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usepersistentuserchoicesoptions.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "UsePersistentUserChoicesOptions interface",
+  "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. -->
+
+# UsePersistentUserChoicesOptions interface
+
+Options for the `usePersistentDeviceSettings` hook.
+
+**Signature:**
+
+```typescript
+export interface UsePersistentUserChoicesOptions
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                                               | Type                                                                  | Description                                                                                                         |
+| ---------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| [defaults?](./react/usepersistentuserchoicesoptions.defaults.md)       | Partial&lt;[LocalUserChoices](./core/localuserchoices.md)<!-- -->&gt; | _(Optional)_ The default value to use if reading from local storage returns no results or fails.                    |
+| [preventLoad?](./react/usepersistentuserchoicesoptions.preventload.md) | boolean                                                               | _(Optional)_ Whether to prevent loading user choices from persistent storage and use <code>defaults</code> instead. |
+| [preventSave?](./react/usepersistentuserchoicesoptions.preventsave.md) | boolean                                                               | _(Optional)_ Whether to prevent saving to persistent storage.                                                       |

package/generated-docs/react/usepersistentuserchoicesoptions.preventload.md

@@ -0,0 +1,17 @@
+---
+{ "title": "UsePersistentUserChoicesOptions.preventLoad property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions.preventLoad property
+
+Whether to prevent loading user choices from persistent storage and use `defaults` instead.
+
+**Signature:**
+
+```typescript
+preventLoad?: boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usepersistentuserchoicesoptions.preventsave.md

@@ -0,0 +1,17 @@
+---
+{ "title": "UsePersistentUserChoicesOptions.preventSave property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions.preventSave property
+
+Whether to prevent saving to persistent storage.
+
+**Signature:**
+
+```typescript
+preventSave?: boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usestartaudioprops.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "UseStartAudioProps interface",
+  "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. -->
+
+# UseStartAudioProps interface
+
+**Signature:**
+
+```typescript
+export interface UseStartAudioProps
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                     | Type                                                | Description  |
+| -------------------------------------------- | --------------------------------------------------- | ------------ |
+| [props](./react/usestartaudioprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
+| [room?](./react/usestartaudioprops.room.md)  | Room                                                | _(Optional)_ |

package/generated-docs/react/usestartaudioprops.props.md

@@ -0,0 +1,13 @@
+---
+{ "title": "UseStartAudioProps.props property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartAudioProps.props property
+
+**Signature:**
+
+```typescript
+props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+```

package/generated-docs/react/usestartaudioprops.room.md

@@ -0,0 +1,13 @@
+---
+{ "title": "UseStartAudioProps.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartAudioProps.room property
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/useswipeoptions.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseSwipeOptions type",
+  "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. -->
+
+# UseSwipeOptions type
+
+**Signature:**
+
+```typescript
+export type UseSwipeOptions = {
+  minSwipeDistance?: number;
+  onLeftSwipe?: () => void;
+  onRightSwipe?: () => void;
+};
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/videotrackprops.md

@@ -12,10 +12,10 @@
 **Signature:**
 
 ```typescript
-export interface VideoTrackProps extends React.HTMLAttributes<HTMLVideoElement>
+export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElement>
 ```
 
-**Extends:** React.HTMLAttributes&lt;HTMLVideoElement&gt;
+**Extends:** React.VideoHTMLAttributes&lt;HTMLVideoElement&gt;
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 

package/package.json

@@ -1,16 +1,15 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
-  "scripts": {
-    "yalc:publish": "yalc publish --private --push --replace",
-    "yalc:publish:watch": "nodemon --delay 1 --watch \"generated-docs/**/*\" -e md -x \"yarn yalc:publish\""
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/livekit/components-js.git",
     "directory": "/docs/beta-docs"
   },
+  "dependencies": {
+    "@livekit/components-react": "1.4.0"
+  },
   "author": "",
   "license": "Apache-2.0",
   "bugs": {
@@ -24,4 +23,4 @@
   "publishConfig": {
     "access": "restricted"
   }
-}
+}