@livekit/components-js-docs 0.0.5 → 0.1.1

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

@@ -1,6 +1,10 @@
+---
+{ "title": "UseRemoteParticipantsOptions.room property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseRemoteParticipantsOptions.room property
+# UseRemoteParticipantsOptions.room property
 
 The room to use. If not provided, the hook will use the room from the context.
 

package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md

@@ -1,6 +1,10 @@
+---
+{ "title": "UseRemoteParticipantsOptions.updateOnlyOn property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseRemoteParticipantsOptions.updateOnlyOn property
+# UseRemoteParticipantsOptions.updateOnlyOn property
 
 To optimize performance, you can use the `updateOnlyOn` property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable `RoomEvents` is: `[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]`
 

package/generated-docs/react/userinfo.identity.md

@@ -1,6 +1,10 @@
+---
+{ "title": "UserInfo.identity property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UserInfo.identity property
+# UserInfo.identity property
 
 **Signature:**
 

package/generated-docs/react/userinfo.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UserInfo interface",
+  "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. -->
 
-## UserInfo interface
+# UserInfo interface
 
 **Signature:**
 

package/generated-docs/react/userinfo.metadata.md

@@ -1,6 +1,10 @@
+---
+{ "title": "UserInfo.metadata property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UserInfo.metadata property
+# UserInfo.metadata property
 
 **Signature:**
 

package/generated-docs/react/userinfo.name.md

@@ -1,6 +1,10 @@
+---
+{ "title": "UserInfo.name property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UserInfo.name property
+# UserInfo.name property
 
 **Signature:**
 

package/generated-docs/react/useroominfooptions.md

@@ -1,6 +1,15 @@
+---
+{
+  "title": "UseRoomInfoOptions interface",
+  "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. -->
 
-## UseRoomInfoOptions interface
+# UseRoomInfoOptions interface
+
+The `useRoomInfo` hook returns the name and metadata of the given `Room`<!-- -->.
 
 **Signature:**
 
@@ -8,7 +17,17 @@
 export interface UseRoomInfoOptions
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Remarks
+
+Needs to be called inside a `RoomContext` or by passing a `Room` instance.
+
+## Usage
+
+```tsx
+const { name, metadata } = useRoomInfo();
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Properties
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "UseRoomInfoOptions.room property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseRoomInfoOptions.room property
+# UseRoomInfoOptions.room property
 
 **Signature:**
 

package/generated-docs/react/usetokenoptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseTokenOptions interface",
+  "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. -->
 
-## UseTokenOptions interface
+# UseTokenOptions interface
 
 **Signature:**
 

package/generated-docs/react/usetokenoptions.userinfo.md

@@ -1,6 +1,10 @@
+---
+{ "title": "UseTokenOptions.userInfo property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseTokenOptions.userInfo property
+# UseTokenOptions.userInfo property
 
 **Signature:**
 

package/generated-docs/react/usetrackmutedindicatoroptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseTrackMutedIndicatorOptions interface",
+  "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. -->
 
-## UseTrackMutedIndicatorOptions interface
+# UseTrackMutedIndicatorOptions interface
 
 **Signature:**
 

package/generated-docs/react/usetrackmutedindicatoroptions.participant.md

@@ -1,9 +1,23 @@
+---
+{ "title": "UseTrackMutedIndicatorOptions.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseTrackMutedIndicatorOptions.participant property
+# UseTrackMutedIndicatorOptions.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 
 **Signature:**
 
 ```typescript
 participant?: Participant;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usetrackoptions.element.md

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

package/generated-docs/react/usetrackoptions.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "UseTrackOptions interface",
+  "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. -->
+
+# UseTrackOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseTrackOptions
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                       | Type                                                             | Description  |
+| ---------------------------------------------- | ---------------------------------------------------------------- | ------------ |
+| [element?](./react/usetrackoptions.element.md) | React.RefObject&lt;HTMLMediaElement&gt;                          | _(Optional)_ |
+| [props?](./react/usetrackoptions.props.md)     | React.HTMLAttributes&lt;HTMLVideoElement \| HTMLAudioElement&gt; | _(Optional)_ |

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

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

package/generated-docs/react/usetrackshookreturntype.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseTracksHookReturnType type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTracks.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseTracksHookReturnType type
+# UseTracksHookReturnType type
 
 **Signature:**
 

package/generated-docs/react/usetracksoptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseTracksOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTracks.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseTracksOptions type
+# UseTracksOptions type
 
 **Signature:**
 

package/generated-docs/react/usetracktoggleprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseTrackToggleProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackToggle.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseTrackToggleProps interface
+# UseTrackToggleProps interface
 
 **Signature:**
 

package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md

@@ -1,6 +1,10 @@
+---
+{ "title": "UseVisualStableUpdateOptions.customSortFunction property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseVisualStableUpdateOptions.customSortFunction property
+# UseVisualStableUpdateOptions.customSortFunction property
 
 Overwrites the default sort function.
 

package/generated-docs/react/usevisualstableupdateoptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseVisualStableUpdateOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useVisualStableUpdate.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseVisualStableUpdateOptions interface
+# UseVisualStableUpdateOptions interface
 
 **Signature:**
 

package/generated-docs/react/videoconferenceprops.chatmessagedecoder.md

@@ -1,6 +1,10 @@
+---
+{ "title": "VideoConferenceProps.chatMessageDecoder property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoConferenceProps.chatMessageDecoder property
+# VideoConferenceProps.chatMessageDecoder property
 
 **Signature:**
 

package/generated-docs/react/videoconferenceprops.chatmessageencoder.md

@@ -1,6 +1,10 @@
+---
+{ "title": "VideoConferenceProps.chatMessageEncoder property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoConferenceProps.chatMessageEncoder property
+# VideoConferenceProps.chatMessageEncoder property
 
 **Signature:**
 

package/generated-docs/react/videoconferenceprops.chatmessageformatter.md

@@ -1,6 +1,10 @@
+---
+{ "title": "VideoConferenceProps.chatMessageFormatter property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoConferenceProps.chatMessageFormatter property
+# VideoConferenceProps.chatMessageFormatter property
 
 **Signature:**
 

package/generated-docs/react/videoconferenceprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "VideoConferenceProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/VideoConference.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoConferenceProps interface
+# VideoConferenceProps interface
 
 **Signature:**
 
@@ -16,6 +23,6 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
 
 | Property                                                                      | Type                                            | Description  |
 | ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
-| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./react/messagedecoder.md)     | _(Optional)_ |
-| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./react/messageencoder.md)     | _(Optional)_ |
+| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./core/messagedecoder.md)      | _(Optional)_ |
+| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./core/messageencoder.md)      | _(Optional)_ |
 | [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |

package/generated-docs/react/videotrackprops.managesubscription.md

@@ -1,6 +1,10 @@
+---
+{ "title": "VideoTrackProps.manageSubscription property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.manageSubscription property
+# VideoTrackProps.manageSubscription property
 
 **Signature:**
 

package/generated-docs/react/videotrackprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "VideoTrackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/VideoTrack.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps interface
+# VideoTrackProps interface
 
 **Signature:**
 
@@ -14,12 +21,13 @@ export interface VideoTrackProps extends React.HTMLAttributes<HTMLVideoElement>
 
 ## 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                                                                       |              |
+| 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. |

package/generated-docs/react/videotrackprops.name.md

@@ -1,9 +1,23 @@
+---
+{ "title": "VideoTrackProps.name property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.name property
+# VideoTrackProps.name property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 
 **Signature:**
 
 ```typescript
 name?: string;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/videotrackprops.onsubscriptionstatuschanged.md

@@ -1,6 +1,10 @@
+---
+{ "title": "VideoTrackProps.onSubscriptionStatusChanged property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.onSubscriptionStatusChanged property
+# VideoTrackProps.onSubscriptionStatusChanged property
 
 **Signature:**
 

package/generated-docs/react/videotrackprops.ontrackclick.md

@@ -1,6 +1,10 @@
+---
+{ "title": "VideoTrackProps.onTrackClick property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.onTrackClick property
+# VideoTrackProps.onTrackClick property
 
 **Signature:**
 

package/generated-docs/react/videotrackprops.participant.md

@@ -1,9 +1,23 @@
+---
+{ "title": "VideoTrackProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.participant property
+# VideoTrackProps.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 
 **Signature:**
 
 ```typescript
 participant?: Participant;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/videotrackprops.publication.md

@@ -1,9 +1,23 @@
+---
+{ "title": "VideoTrackProps.publication property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.publication property
+# VideoTrackProps.publication property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 
 **Signature:**
 
 ```typescript
 publication?: TrackPublication;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/videotrackprops.source.md

@@ -1,9 +1,23 @@
+---
+{ "title": "VideoTrackProps.source property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## VideoTrackProps.source property
+# VideoTrackProps.source property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This property will be removed in a future version use `trackRef` instead.
+
+{% /callout %}
 
 **Signature:**
 
 ```typescript
-source: Track.Source;
+source?: Track.Source;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/videotrackprops.trackref.md

@@ -0,0 +1,17 @@
+---
+{ "title": "VideoTrackProps.trackRef property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VideoTrackProps.trackRef property
+
+The track reference of the track to render.
+
+**Signature:**
+
+```typescript
+trackRef?: TrackReference;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.0.5",
+  "version": "0.1.1",
   "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",

package/generated-docs/react/carouselviewprops.md

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-## CarouselViewProps interface
-
-**Signature:**
-
-```typescript
-export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaElement>
-```
-
-**Extends:** React.HTMLAttributes&lt;HTMLMediaElement&gt;
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-| Property                                                 | Type                                                                             | Description                                                                                                                                         |
-| -------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [children](./react/carouselviewprops.children.md)        | React.ReactNode                                                                  |                                                                                                                                                     |
-| [orientation?](./react/carouselviewprops.orientation.md) | 'vertical' \| 'horizontal'                                                       | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
-| [tracks](./react/carouselviewprops.tracks.md)            | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |