@livekit/components-js-docs 0.0.5 → 0.1.1

package/generated-docs/react/usefocustoggleprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseFocusToggleProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useFocusToggle.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseFocusToggleProps interface
+# UseFocusToggleProps interface
 
 **Signature:**
 
@@ -12,8 +19,9 @@ export interface UseFocusToggleProps
 
 ## Properties
 
-| Property                                                   | Type                                                | Description  |
-| ---------------------------------------------------------- | --------------------------------------------------- | ------------ |
-| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                         | _(Optional)_ |
-| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
-| [trackSource](./react/usefocustoggleprops.tracksource.md)  | Track.Source                                        |              |
+| Property                                                   | Type                                                                 | Description  |
+| ---------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
+| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                                          | _(Optional)_ |
+| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;                  |              |
+| [trackRef?](./react/usefocustoggleprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
+| [trackSource?](./react/usefocustoggleprops.tracksource.md) | Track.Source                                                         | _(Optional)_ |

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

@@ -1,9 +1,23 @@
+---
+{ "title": "UseFocusToggleProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseFocusToggleProps.participant property
+# UseFocusToggleProps.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/usefocustoggleprops.props.md

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

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

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

package/generated-docs/react/usefocustoggleprops.tracksource.md

@@ -1,9 +1,23 @@
+---
+{ "title": "UseFocusToggleProps.trackSource property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseFocusToggleProps.trackSource property
+# UseFocusToggleProps.trackSource 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
-trackSource: Track.Source;
+trackSource?: Track.Source;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useismutedoptions.md

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

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

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

package/generated-docs/react/uselocalparticipantoptions.md

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

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

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

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

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

package/generated-docs/react/usemediadeviceselectprops.md

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "UseMediaDeviceSelectProps.requestPermissions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseMediaDeviceSelectProps.requestPermissions property
+# UseMediaDeviceSelectProps.requestPermissions property
 
 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.
 

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

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

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

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

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

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

package/generated-docs/react/usemediatrackoptions.md

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

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

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

package/generated-docs/react/useparticipantinfooptions.md

@@ -1,6 +1,15 @@
+---
+{
+  "title": "UseParticipantInfoOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantInfo.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantInfoOptions interface
+# UseParticipantInfoOptions interface
+
+The `useParticipantInfo` hook returns the identity, name, and metadata of a given participant. It requires a `Participant` object passed as property or via the `ParticipantContext`<!-- -->.
 
 **Signature:**
 
@@ -8,7 +17,13 @@
 export interface UseParticipantInfoOptions
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Usage
+
+```tsx
+const { identity, name, metadata } = useParticipantInfo({ participant });
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Properties
 

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

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

package/generated-docs/react/useparticipantpermissionsoptions.md

@@ -1,6 +1,15 @@
+---
+{
+  "title": "UseParticipantPermissionsOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantPermissions.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantPermissionsOptions interface
+# UseParticipantPermissionsOptions interface
+
+The `useParticipantPermissions` hook returns the permissions of a given participant.
 
 **Signature:**
 
@@ -8,7 +17,13 @@
 export interface UseParticipantPermissionsOptions
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Usage
+
+```tsx
+const permissions = useParticipantPermissions({ participant });
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Properties
 

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

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

package/generated-docs/react/useparticipantsoptions.md

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

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

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "UseParticipantsOptions.updateOnlyOn property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantsOptions.updateOnlyOn property
+# UseParticipantsOptions.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/useparticipanttileprops.disablespeakingindicator.md

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

package/generated-docs/react/useparticipanttileprops.htmlprops.md

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

package/generated-docs/react/useparticipanttileprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseParticipantTileProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantTile.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantTileProps interface
+# UseParticipantTileProps interface
 
 **Signature:**
 
@@ -14,11 +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                                                                          |              |
-| [publication?](./react/useparticipanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_ |
-| [source](./react/useparticipanttileprops.source.md)                                      | Track.Source                                                                         |              |
+| 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. |

package/generated-docs/react/useparticipanttileprops.onparticipantclick.md

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

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

@@ -1,9 +1,23 @@
+---
+{ "title": "UseParticipantTileProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantTileProps.participant property
+# UseParticipantTileProps.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;
+participant?: Participant;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -1,9 +1,23 @@
+---
+{ "title": "UseParticipantTileProps.publication property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantTileProps.publication property
+# UseParticipantTileProps.publication 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
 publication?: TrackPublication;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -1,9 +1,23 @@
+---
+{ "title": "UseParticipantTileProps.source property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseParticipantTileProps.source property
+# UseParticipantTileProps.source 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
-source: Track.Source;
+source?: Track.Source;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

package/generated-docs/react/useremoteparticipantoptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "UseRemoteParticipantOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRemoteParticipant.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseRemoteParticipantOptions interface
+# UseRemoteParticipantOptions interface
 
 **Signature:**
 
@@ -12,6 +19,6 @@ export interface UseRemoteParticipantOptions
 
 ## Properties
 
-| Property                                                             | Type                 | Description  |
-| -------------------------------------------------------------------- | -------------------- | ------------ |
-| [updateOnlyOn?](./react/useremoteparticipantoptions.updateonlyon.md) | ParticipantEvent\[\] | _(Optional)_ |
+| Property                                                             | Type                 | Description                                                                                                                                                                                                                                                      |
+| -------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [updateOnlyOn?](./react/useremoteparticipantoptions.updateonlyon.md) | ParticipantEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what <code>ParticipantEvents</code> the hook updates. By default it updates on all relevant ParticipantEvents to keep the returned participant up to date. |

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

@@ -1,9 +1,17 @@
+---
+{ "title": "UseRemoteParticipantOptions.updateOnlyOn property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## UseRemoteParticipantOptions.updateOnlyOn property
+# UseRemoteParticipantOptions.updateOnlyOn property
+
+To optimize performance, you can use the `updateOnlyOn` property to decide on what `ParticipantEvents` the hook updates. By default it updates on all relevant ParticipantEvents to keep the returned participant up to date.
 
 **Signature:**
 
 ```typescript
 updateOnlyOn?: ParticipantEvent[];
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useremoteparticipantsoptions.md

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