@livekit/components-js-docs 0.1.2 → 0.1.4

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

@@ -21,13 +21,13 @@ export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElem
 
 ## 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,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "1.4.0"
+    "@livekit/components-react": "1.4.2"
   },
   "author": "",
   "license": "Apache-2.0",

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;
-```