@livekit/components-js-docs 0.0.2

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UserInfo.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```

package/generated-docs/react/useroominfooptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseRoomInfoOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseRoomInfoOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                    | Type | Description  |
+| ------------------------------------------- | ---- | ------------ |
+| [room?](./react/useroominfooptions.room.md) | Room | _(Optional)_ |

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseRoomInfoOptions.room property
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/usetokenoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTokenOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseTokenOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                              | Type                            | Description  |
+| ----------------------------------------------------- | ------------------------------- | ------------ |
+| [userInfo?](./react/hook/usetokenoptions.userinfo.md) | [UserInfo](./react/userinfo.md) | _(Optional)_ |

package/generated-docs/react/usetrackmutedindicatoroptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTrackMutedIndicatorOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseTrackMutedIndicatorOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                             | Type        | Description  |
+| -------------------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/usetrackmutedindicatoroptions.participant.md) | Participant | _(Optional)_ |

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTrackMutedIndicatorOptions.participant property
+
+**Signature:**
+
+```typescript
+participant?: Participant;
+```

package/generated-docs/react/usetrackshookreturntype.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTracksHookReturnType type
+
+**Signature:**
+
+```typescript
+export type UseTracksHookReturnType<T> = T extends Track.Source[]
+  ? TrackReference[]
+  : T extends TrackSourceWithOptions[]
+  ? TrackReferenceOrPlaceholder[]
+  : never;
+```
+
+**References:** [TrackReference](./core/trackreference.md)<!-- -->, [TrackSourceWithOptions](./core/tracksourcewithoptions.md)<!-- -->, [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/usetracksoptions.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTracksOptions type
+
+**Signature:**
+
+```typescript
+export type UseTracksOptions = {
+  updateOnlyOn?: RoomEvent[];
+  onlySubscribed?: boolean;
+  room?: Room;
+};
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/usetracktoggleprops.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTrackToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackToggleProps<T>, 'showIcon'>
+```
+
+**Extends:** Omit&lt;[TrackToggleProps](./react/tracktoggleprops.md)<!-- -->&lt;T&gt;, 'showIcon'&gt;
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseVisualStableUpdateOptions.customSortFunction property
+
+Overwrites the default sort function.
+
+**Signature:**
+
+```typescript
+customSortFunction?: (trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/usevisualstableupdateoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseVisualStableUpdateOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseVisualStableUpdateOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                          | Type                                                                                                                                                                                       | Description                                        |
+| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
+| [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]) =&gt; [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | _(Optional)_ Overwrites the default sort function. |

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoConferenceProps.chatMessageFormatter property
+
+**Signature:**
+
+```typescript
+chatMessageFormatter?: MessageFormatter;
+```

package/generated-docs/react/videoconferenceprops.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoConferenceProps interface
+
+**Signature:**
+
+```typescript
+export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                      | Type                                            | Description  |
+| ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
+| [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |

package/generated-docs/react/videotrackprops.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps interface
+
+**Signature:**
+
+```typescript
+export interface VideoTrackProps extends React.HTMLAttributes<HTMLVideoElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLVideoElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                               | Type                                                                               | Description  |
+| -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ------------ |
+| [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                                                                       |              |

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps.onSubscriptionStatusChanged property
+
+**Signature:**
+
+```typescript
+onSubscriptionStatusChanged?: (subscribed: boolean) => void;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps.onTrackClick property
+
+**Signature:**
+
+```typescript
+onTrackClick?: (evt: ParticipantClickEvent) => void;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps.participant property
+
+**Signature:**
+
+```typescript
+participant?: Participant;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps.publication property
+
+**Signature:**
+
+```typescript
+publication?: TrackPublication;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoTrackProps.source property
+
+**Signature:**
+
+```typescript
+source: Track.Source;
+```

package/meta-data.json

@@ -0,0 +1,78 @@
+{
+  "react": {
+    "allComponents": [
+      "AudioConference",
+      "AudioTrack",
+      "AudioVisualizer",
+      "CarouselView",
+      "Chat",
+      "ChatEntry",
+      "ChatToggle",
+      "ClearPinButton",
+      "ConnectionStateToast",
+      "Controlbar",
+      "DisconnectButton",
+      "FocusLayout",
+      "FocusLayoutContainer",
+      "FocusToggle",
+      "GridLayout",
+      "LiveKitRoom",
+      "MediaDeviceSelect",
+      "ParticipantContextIfNeeded",
+      "ParticipantName",
+      "StartAudio",
+      "Toast",
+      "TrackToggle",
+      "VideoConference",
+      "VideoTrack"
+    ],
+    "allHooks": [
+      "useChat",
+      "useClearPinButton",
+      "useConnectionQualityIndicator",
+      "useConnectionState",
+      "useCreateLayoutContext",
+      "useDataChannel",
+      "useDisconnectButton",
+      "useEnsureCreateLayoutContext",
+      "useEnsureLayoutContext",
+      "useEnsureParticipant",
+      "useEnsureRoom",
+      "useEnsureTrackReference",
+      "useGridLayout",
+      "useIsMuted",
+      "useIsSpeaking",
+      "useLayoutContext",
+      "useLivekitRoom",
+      "useLocalParticipant",
+      "useLocalParticipantPermissions",
+      "useMaybeLayoutContext",
+      "useMaybeParticipantContext",
+      "useMaybeRoomContext",
+      "useMaybeTrackContext",
+      "useMediaDevices",
+      "useMediaDeviceSelect",
+      "useMediaTrack",
+      "useMediaTrackByName",
+      "useParticipantContext",
+      "useParticipantInfo",
+      "useParticipantPermissions",
+      "useParticipants",
+      "useParticipantTile",
+      "usePinnedTracks",
+      "usePreviewDevice",
+      "useRemoteParticipant",
+      "useRemoteParticipants",
+      "useRoomContext",
+      "useRoomInfo",
+      "useSortedParticipants",
+      "useSpeakingParticipants",
+      "useToken",
+      "useTrackContext",
+      "useTrackMutedIndicator",
+      "useTracks",
+      "useTrackToggle",
+      "useVisualStableUpdate"
+    ]
+  }
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@livekit/components-js-docs",
+  "version": "0.0.2",
+  "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",
+    "yalc:publish:watch": "nodemon --delay 1 --watch \"generated-docs/**/*\" -e md -x \"yarn yalc:publish\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/livekit/components-js.git",
+    "directory": "/docs/beta-docs"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/livekit/components-js/issues"
+  },
+  "homepage": "https://github.com/livekit/components-js#readme",
+  "files": [
+    "generated-docs",
+    "meta-data.json"
+  ],
+  "publishConfig": {
+    "access": "restricted"
+  }
+}