@livekit/components-js-docs 0.1.1 → 0.1.3

package/generated-docs/react/usefocustoggleprops.md

@@ -19,9 +19,9 @@ export interface UseFocusToggleProps
 
 ## Properties
 
-| Property                                                   | Type                                                                 | Description  |
-| ---------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
-| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                                          | _(Optional)_ |
-| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes<HTMLButtonElement>                  |              |
-| [trackRef?](./react/usefocustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
-| [trackSource?](./react/usefocustoggleprops.tracksource.md) | Track.Source                                                         | _(Optional)_ |
+| Property                                                   | Type                                                                  | Description  |
+| ---------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                                           | _(Optional)_ |
+| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes<HTMLButtonElement>                   |              |
+| [trackRef?](./react/usefocustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
+| [trackSource?](./react/usefocustoggleprops.tracksource.md) | Track.Source                                                          | _(Optional)_ |

package/generated-docs/react/usemediadeviceselectprops.md

@@ -22,6 +22,7 @@ export interface UseMediaDeviceSelectProps
 | Property                                                                       | Type                               | Description                                                                                                                                                                                                                                                                                                                                              |
 | ------------------------------------------------------------------------------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [kind](./react/usemediadeviceselectprops.kind.md)                              | MediaDeviceKind                    |                                                                                                                                                                                                                                                                                                                                                          |
+| [onError?](./react/usemediadeviceselectprops.onerror.md)                       | (e: Error) =&gt; void              | _(Optional)_ this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the <code>requestPermissions</code> option is set to <code>true</code>. Most commonly this will emit a MediaDeviceError                                                                                   |
 | [requestPermissions?](./react/usemediadeviceselectprops.requestpermissions.md) | boolean                            | _(Optional)_ this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions. |
 | [room?](./react/usemediadeviceselectprops.room.md)                             | Room                               | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
 | [track?](./react/usemediadeviceselectprops.track.md)                           | LocalAudioTrack \| LocalVideoTrack | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

package/generated-docs/react/usemediadeviceselectprops.onerror.md

@@ -0,0 +1,17 @@
+---
+{ "title": "UseMediaDeviceSelectProps.onError property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseMediaDeviceSelectProps.onError property
+
+this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the `requestPermissions` option is set to `true`<!-- -->. Most commonly this will emit a MediaDeviceError
+
+**Signature:**
+
+```typescript
+onError?: (e: Error) => void;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.md

@@ -21,12 +21,12 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React.HT
 
 ## Properties
 
-| Property                                                                                 | Type                                                                                 | Description                                  |
-| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------- |
-| [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_                                 |
-| [htmlProps](./react/useparticipanttileprops.htmlprops.md)                                | React.HTMLAttributes&lt;T&gt;                                                        |                                              |
-| [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                 |
-| [participant?](./react/useparticipanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_                                 |
-| [publication?](./react/useparticipanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_                                 |
-| [source?](./react/useparticipanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_                                 |
-| [trackRef?](./react/useparticipanttileprops.trackref.md)                                 | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)                 | _(Optional)_ The track reference to display. |
+| Property                                                                                 | Type                                                                  | Description                                  |
+| ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------- |
+| [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean                                                               | _(Optional)_                                 |
+| [htmlProps](./react/useparticipanttileprops.htmlprops.md)                                | React.HTMLAttributes&lt;T&gt;                                         |                                              |
+| [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md)             | (event: ParticipantClickEvent) =&gt; void                             | _(Optional)_                                 |
+| [participant?](./react/useparticipanttileprops.participant.md)                           | Participant                                                           | _(Optional)_                                 |
+| [publication?](./react/useparticipanttileprops.publication.md)                           | TrackPublication                                                      | _(Optional)_                                 |
+| [source?](./react/useparticipanttileprops.source.md)                                     | Track.Source                                                          | _(Optional)_                                 |
+| [trackRef?](./react/useparticipanttileprops.trackref.md)                                 | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |

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](./react/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/usestartvideoprops.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "UseStartVideoProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartVideo.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartVideoProps interface
+
+**Signature:**
+
+```typescript
+export interface UseStartVideoProps
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                     | Type                                                | Description  |
+| -------------------------------------------- | --------------------------------------------------- | ------------ |
+| [props](./react/usestartvideoprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
+| [room?](./react/usestartvideoprops.room.md)  | Room                                                | _(Optional)_ |

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

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

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

@@ -0,0 +1,13 @@
+---
+{ "title": "UseStartVideoProps.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartVideoProps.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/usetrackshookreturntype.md

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

package/generated-docs/react/usevisualstableupdateoptions.md

@@ -19,6 +19,6 @@ export interface UseVisualStableUpdateOptions
 
 ## Properties
 
-| Property                                                                          | Type                                                                                                                                                                                       | Description                                        |
-| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
-| [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]) =&gt; [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | _(Optional)_ Overwrites the default sort function. |
+| Property                                                                          | Type                                                                                                                                                                                         | Description                                        |
+| --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\]) =&gt; [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] | _(Optional)_ Overwrites the default sort function. |

package/generated-docs/react/videoconferenceprops.md

@@ -23,6 +23,6 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
 
 | Property                                                                      | Type                                            | Description  |
 | ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./core/messagedecoder.md)      | _(Optional)_ |
-| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./core/messageencoder.md)      | _(Optional)_ |
+| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./react/messagedecoder.md)     | _(Optional)_ |
+| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./react/messageencoder.md)     | _(Optional)_ |
 | [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |

package/generated-docs/react/videotrackprops.md

@@ -12,22 +12,22 @@
 **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} /%}
 
 ## Properties
 
-| Property                                                                               | Type                                                                               | Description                                              |
-| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------- |
-| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                                                            | _(Optional)_                                             |
-| [name?](./react/videotrackprops.name.md)                                               | string                                                                             | _(Optional)_                                             |
-| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void                                                   | _(Optional)_                                             |
-| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                             |
-| [participant?](./react/videotrackprops.participant.md)                                 | Participant                                                                        | _(Optional)_                                             |
-| [publication?](./react/videotrackprops.publication.md)                                 | TrackPublication                                                                   | _(Optional)_                                             |
-| [source?](./react/videotrackprops.source.md)                                           | Track.Source                                                                       | _(Optional)_                                             |
-| [trackRef?](./react/videotrackprops.trackref.md)                                       | [TrackReference](./core/trackreference.md)                                         | _(Optional)_ The track reference of the track to render. |
+| Property                                                                               | Type                                        | Description                                              |
+| -------------------------------------------------------------------------------------- | ------------------------------------------- | -------------------------------------------------------- |
+| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                     | _(Optional)_                                             |
+| [name?](./react/videotrackprops.name.md)                                               | string                                      | _(Optional)_                                             |
+| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void            | _(Optional)_                                             |
+| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: ParticipantClickEvent) =&gt; void     | _(Optional)_                                             |
+| [participant?](./react/videotrackprops.participant.md)                                 | Participant                                 | _(Optional)_                                             |
+| [publication?](./react/videotrackprops.publication.md)                                 | TrackPublication                            | _(Optional)_                                             |
+| [source?](./react/videotrackprops.source.md)                                           | Track.Source                                | _(Optional)_                                             |
+| [trackRef?](./react/videotrackprops.trackref.md)                                       | [TrackReference](./react/trackreference.md) | _(Optional)_ The track reference of the track to render. |

package/generated-docs/react/widgetstate.md

@@ -0,0 +1,21 @@
+---
+{
+  "title": "WidgetState type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/types.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# WidgetState type
+
+**Signature:**
+
+```typescript
+export type WidgetState = {
+  showChat: boolean;
+  unreadMessages: number;
+};
+```
+
+{% 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.3",
   "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.1"
+  },
   "author": "",
   "license": "Apache-2.0",
   "bugs": {
@@ -24,4 +23,4 @@
   "publishConfig": {
     "access": "restricted"
   }
-}
+}

package/generated-docs/core/istrackreference.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "isTrackReference",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# isTrackReference
-
-**Signature:**
-
-```typescript
-export declare function isTrackReference(trackReference: unknown): trackReference is TrackReference;
-```

package/generated-docs/core/participantclickevent.md

@@ -1,23 +0,0 @@
----
-{
-  "title": "ParticipantClickEvent interface",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ParticipantClickEvent interface
-
-**Signature:**
-
-```typescript
-export interface ParticipantClickEvent
-```
-
-## Properties
-
-| Property                                                   | Type             | Description  |
-| ---------------------------------------------------------- | ---------------- | ------------ |
-| [participant](./core/participantclickevent.participant.md) | Participant      |              |
-| [track?](./core/participantclickevent.track.md)            | TrackPublication | _(Optional)_ |

package/generated-docs/core/participantclickevent.participant.md

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