@livekit/components-js-docs 0.0.5 → 0.1.0

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

@@ -2,8 +2,14 @@
 
 ## VideoTrackProps.name property
 
+> Warning: This API is now obsolete.
+>
+> This property will be removed in a future version use `trackRef` instead.
+
 **Signature:**
 
 ```typescript
 name?: string;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -2,8 +2,14 @@
 
 ## VideoTrackProps.participant property
 
+> Warning: This API is now obsolete.
+>
+> This property will be removed in a future version use `trackRef` instead.
+
 **Signature:**
 
 ```typescript
 participant?: Participant;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -2,8 +2,14 @@
 
 ## VideoTrackProps.publication property
 
+> Warning: This API is now obsolete.
+>
+> This property will be removed in a future version use `trackRef` instead.
+
 **Signature:**
 
 ```typescript
 publication?: TrackPublication;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -2,8 +2,14 @@
 
 ## VideoTrackProps.source property
 
+> Warning: This API is now obsolete.
+>
+> This property will be removed in a future version use `trackRef` instead.
+
 **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,13 @@
+<!-- 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.0",
   "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)<!-- -->\[\] |                                                                                                                                                     |