@livekit/components-js-docs 0.1.7 → 0.1.9

package/generated-docs/react/trackmutedindicatorprops.md

@@ -21,9 +21,7 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
 
 ## Properties
 
-| Property                                                        | Type                                                                  | Description  |
-| --------------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
-| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                                                           | _(Optional)_ |
-| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted'                                      | _(Optional)_ |
-| [source?](./react/trackmutedindicatorprops.source.md)           | Track.Source                                                          | _(Optional)_ |
-| [trackRef?](./react/trackmutedindicatorprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
+| Property                                                 | Type                                                                  | Description  |
+| -------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [show?](./react/trackmutedindicatorprops.show.md)        | 'always' \| 'muted' \| 'unmuted'                                      | _(Optional)_ |
+| [trackRef](./react/trackmutedindicatorprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) |              |

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

@@ -9,5 +9,5 @@
 **Signature:**
 
 ```typescript
-trackRef?: TrackReferenceOrPlaceholder;
+trackRef: TrackReferenceOrPlaceholder;
 ```

package/generated-docs/react/usefocustoggleprops.md

@@ -19,9 +19,7 @@ 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](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
-| [trackSource?](./react/usefocustoggleprops.tracksource.md) | Track.Source                                                          | _(Optional)_ |
+| Property                                             | Type                                                                  | Description  |
+| ---------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [props](./react/usefocustoggleprops.props.md)        | React.ButtonHTMLAttributes<HTMLButtonElement>                   |              |
+| [trackRef?](./react/usefocustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |

package/generated-docs/react/useparticipanttileprops.md

@@ -26,7 +26,4 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React.HT
 | [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/usetrackshookreturntype.md

@@ -15,8 +15,8 @@
 export type UseTracksHookReturnType<T> = T extends Track.Source[]
   ? TrackReference[]
   : T extends TrackSourceWithOptions[]
-  ? TrackReferenceOrPlaceholder[]
-  : never;
+    ? TrackReferenceOrPlaceholder[]
+    : never;
 ```
 
 **References:** [TrackReference](./react/trackreference.md)<!-- -->, [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)

package/generated-docs/react/videotrackprops.md

@@ -24,10 +24,6 @@ export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElem
 | 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "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.5.2"
+    "@livekit/components-react": "2.0.0"
   },
   "author": "",
   "license": "Apache-2.0",

package/generated-docs/core/datasendoptions.md

@@ -1,19 +0,0 @@
----
-{
-  "title": "DataSendOptions type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# DataSendOptions type
-
-**Signature:**
-
-```typescript
-export type DataSendOptions = {
-  kind?: DataPacket_Kind;
-  destination?: string[];
-};
-```

package/generated-docs/core/isparticipantsourcepinned.md

@@ -1,32 +0,0 @@
----
-{
-  "title": "isParticipantSourcePinned",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/utils.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# isParticipantSourcePinned
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-Use [isParticipantTrackReferencePinned()](./core/isparticipanttrackreferencepinned.md) instead.
-
-{% /callout %}
-
-Check if the participant track source is pinned.
-
-**Signature:**
-
-```typescript
-export declare function isParticipantSourcePinned(
-  participant: Participant,
-  source: Track.Source,
-  pinState: PinState | undefined
-): boolean;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/trackidentifier.md

@@ -1,24 +0,0 @@
----
-{
-  "title": "TrackIdentifier type",
-  "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. -->
-
-# TrackIdentifier type
-
-The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. `{source: Track.Source.Camera}` or `{name: "my-track"}` - TrackReference (participant and publication)
-
-**Signature:**
-
-```typescript
-export type TrackIdentifier<T extends Track.Source = Track.Source> =
-  | TrackSource<T>
-  | TrackReference;
-```
-
-**References:** [TrackSource](./core/tracksource.md)<!-- -->, [TrackReference](./core/trackreference.md)
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

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

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

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

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

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

@@ -1,26 +0,0 @@
----
-{
-  "title": "CarouselView variable",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/layout/CarouselLayout.tsx"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# CarouselView variable
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-Renamed to \[\[CarouselLayout\]\]
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-CarouselView: typeof CarouselLayout;
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/focuslayoutcontainerprops.focustrack.md

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

package/generated-docs/react/focuslayoutcontainerprops.participants.md

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

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

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

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

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

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

package/generated-docs/react/hook/useensuretrackreference.md

@@ -1,39 +0,0 @@
----
-{
-  "title": "useEnsureTrackReference",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useEnsureTrackReference
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-`useEnsureTrackReference` has been renamed to `useEnsureTrackRef`<!-- -->, use this as a drop in replacement.
-
-{% /callout %}
-
-Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a `TrackContext` and no track reference is provided, an error is thrown.
-
-## Import
-
-```typescript
-import { useEnsureTrackReference } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="track" type="TrackReferenceOrPlaceholder" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-TrackReferenceOrPlaceholder;
-```

package/generated-docs/react/hook/useismuted_1.md

@@ -1,40 +0,0 @@
----
-{
-  "title": "useIsMuted",
-  "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. -->
-
-# useIsMuted
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This overload will be removed in a future version, pass in trackRef instead.
-
-{% /callout %}
-
-## Import
-
-```typescript
-import { useIsMuted } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="source" type="Track.Source" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseIsMutedOptions" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-boolean;
-```

package/generated-docs/react/hook/usemaybetrackcontext.md

@@ -1,34 +0,0 @@
----
-{
-  "title": "useMaybeTrackContext",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useMaybeTrackContext
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-`useMaybeTrackContext` has been renamed to `useMaybeTrackRefContext`<!-- -->, use this as a drop in replacement.
-
-{% /callout %}
-
-Returns a track reference from the `TrackContext` if it exists, otherwise `undefined`<!-- -->.
-
-## Import
-
-```typescript
-import { useMaybeTrackContext } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Returns
-
-```typescript
-TrackReferenceOrPlaceholder | undefined;
-```

package/generated-docs/react/hook/usemediatrack.md

@@ -1,49 +0,0 @@
----
-{
-  "title": "useMediaTrack",
-  "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. -->
-
-# useMediaTrack
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-use `useTrack` instead
-
-{% /callout %}
-
-## Import
-
-```typescript
-import { useMediaTrack } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="source" type="VideoSource | AudioSource" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
-{% /parameter %}
-
-{% parameter name="participant" type="Participant" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-{
-  publication: import("livekit-client").TrackPublication | undefined;
-  isMuted: boolean | undefined;
-  isSubscribed: boolean | undefined;
-  track: import("livekit-client").Track | undefined;
-  elementProps: React.HTMLAttributes<HTMLElement>;
-}
-```

package/generated-docs/react/hook/usemediatrackbyname.md

@@ -1,49 +0,0 @@
----
-{
-  "title": "useMediaTrackByName",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useMediaTrackByName.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# useMediaTrackByName
-
-{% callout type="caution" variation="normal" %}
-
-This API is deprecated:
-
-This function will be removed in a future version, use `useTrackByName` instead.
-
-{% /callout %}
-
-## Import
-
-```typescript
-import { useMediaTrackByName } from "@livekit/components-react";
-```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
-## Properties
-
-{% parameter name="name" type="string" optional=false %}
-{% /parameter %}
-
-{% parameter name="options" type="UseMediaTrackOptions" optional=true %}
-{% /parameter %}
-
-{% parameter name="participant" type="Participant" optional=true %}
-{% /parameter %}
-
-## Returns
-
-```typescript
-{
-  publication: import("livekit-client").TrackPublication | undefined;
-  isMuted: boolean | undefined;
-  isSubscribed: boolean | undefined;
-  track: import("livekit-client").Track | undefined;
-  elementProps: import("react").HTMLAttributes<HTMLElement>;
-}
-```