@livekit/components-js-docs 0.0.5 → 0.1.1

package/generated-docs/core/updatepages.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "updatePages",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/tile-array-update.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # updatePages
@@ -10,7 +17,7 @@ Divide the list of elements into pages and and check if pages need updating.
 export declare function updatePages<T extends UpdatableItem>(
   currentList: T[],
   nextList: T[],
-  maxItemsOnPage: number,
+  maxItemsOnPage: number
 ): T[];
 ```
 

package/generated-docs/core/videosource.md

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

package/generated-docs/core/wasclickoutside.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "wasClickOutside",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/floating-menu.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # wasClickOutside

package/generated-docs/core/widget_default_state.md

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

package/generated-docs/core/widgetstate.md

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

package/generated-docs/index.md

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

package/generated-docs/react/allowaudioplaybackprops.label.md

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

package/generated-docs/react/allowaudioplaybackprops.md

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

package/generated-docs/react/audioconferenceprops.md

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

package/generated-docs/react/audiotrackprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "AudioTrackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioTrack.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioTrackProps interface
+# AudioTrackProps interface
 
 **Signature:**
 
@@ -14,11 +21,12 @@ export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement>
 
 ## Properties
 
-| Property                                                                               | Type                             | Description                                              |
-| -------------------------------------------------------------------------------------- | -------------------------------- | -------------------------------------------------------- |
-| [name?](./react/audiotrackprops.name.md)                                               | string                           | _(Optional)_                                             |
-| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_                                             |
-| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                      | _(Optional)_                                             |
-| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                 | _(Optional)_                                             |
-| [source](./react/audiotrackprops.source.md)                                            | Track.Source                     |                                                          |
-| [volume?](./react/audiotrackprops.volume.md)                                           | number                           | _(Optional)_ by the default the range is between 0 and 1 |
+| Property                                                                               | Type                                       | Description                                                                           |
+| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- |
+| [name?](./react/audiotrackprops.name.md)                                               | string                                     | _(Optional)_                                                                          |
+| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void           | _(Optional)_                                                                          |
+| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                                | _(Optional)_                                                                          |
+| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                           | _(Optional)_                                                                          |
+| [source?](./react/audiotrackprops.source.md)                                           | Track.Source                               | _(Optional)_                                                                          |
+| [trackRef?](./react/audiotrackprops.trackref.md)                                       | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
+| [volume?](./react/audiotrackprops.volume.md)                                           | number                                     | _(Optional)_ by the default the range is between 0 and 1                              |

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

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

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

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

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

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

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "AudioTrackProps.volume property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioTrackProps.volume property
+# AudioTrackProps.volume property
 
 by the default the range is between 0 and 1
 

package/generated-docs/react/audiovisualizerprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "AudioVisualizerProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioVisualizer.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## AudioVisualizerProps interface
+# AudioVisualizerProps interface
 
 **Signature:**
 
@@ -14,6 +21,7 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
 
 ## Properties
 
-| Property                                                    | Type        | Description  |
-| ----------------------------------------------------------- | ----------- | ------------ |
-| [participant?](./react/audiovisualizerprops.participant.md) | Participant | _(Optional)_ |
+| Property                                                    | Type                                                                 | Description  |
+| ----------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
+| [participant?](./react/audiovisualizerprops.participant.md) | Participant                                                          | _(Optional)_ |
+| [trackRef?](./react/audiovisualizerprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |

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

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

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

package/generated-docs/react/{carouselviewprops.children.md → carousellayoutprops.children.md}

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

package/generated-docs/react/carousellayoutprops.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "CarouselLayoutProps interface",
+  "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. -->
+
+# CarouselLayoutProps 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/carousellayoutprops.children.md)        | React.ReactNode                                                                  |                                                                                                                                                     |
+| [orientation?](./react/carousellayoutprops.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/carousellayoutprops.tracks.md)            | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |

package/generated-docs/react/{carouselviewprops.orientation.md → carousellayoutprops.orientation.md}

@@ -1,6 +1,10 @@
+---
+{ "title": "CarouselLayoutProps.orientation property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## CarouselViewProps.orientation property
+# CarouselLayoutProps.orientation property
 
 Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container.
 

package/generated-docs/react/{carouselviewprops.tracks.md → carousellayoutprops.tracks.md}

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

package/generated-docs/react/carouselview.md

@@ -0,0 +1,26 @@
+---
+{
+  "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/chatentryprops.entry.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.entry property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatEntryProps.entry property
+# ChatEntryProps.entry property
 
 The chat massage object to display.
 

package/generated-docs/react/chatentryprops.hidename.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.hideName property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatEntryProps.hideName property
+# ChatEntryProps.hideName property
 
 Hide sender name. Useful when displaying multiple consecutive chat messages from the same person.
 

package/generated-docs/react/chatentryprops.hidetimestamp.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.hideTimestamp property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatEntryProps.hideTimestamp property
+# ChatEntryProps.hideTimestamp property
 
 Hide message timestamp.
 

package/generated-docs/react/chatentryprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ChatEntryProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ChatEntry.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatEntryProps interface
+# ChatEntryProps interface
 
 ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component:
 

package/generated-docs/react/chatentryprops.messageformatter.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatEntryProps.messageFormatter property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatEntryProps.messageFormatter property
+# ChatEntryProps.messageFormatter property
 
 An optional formatter for the message body.
 

package/generated-docs/react/chatprops.md

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

package/generated-docs/react/chatprops.messagedecoder.md

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

package/generated-docs/react/chatprops.messageencoder.md

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

package/generated-docs/react/chatprops.messageformatter.md

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

package/generated-docs/react/chattoggleprops.md

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

package/generated-docs/react/clearpinbuttonprops.md

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