@livekit/components-js-docs 0.0.4 → 0.0.5

package/generated-docs/core/encryptionstatusobservable.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# encryptionStatusObservable
+
+**Signature:**
+
+```typescript
+export declare function encryptionStatusObservable(
+  room: Room,
+  participant: Participant,
+): Observable<boolean>;
+```

package/generated-docs/core/index.md

@@ -32,6 +32,7 @@
 | [cssPrefix](./core/cssprefix.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [DataSendOptions](./core/datasendoptions.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [DataTopic](./core/datatopic.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [getTrackReferenceId(trackReference)](./core/gettrackreferenceid.md)                            | Returns a id to identify the <code>TrackReference</code> based on participant and source.                                                                                                                                                                                                                                                                                                                   |
 | [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md)                    | Returns the Source of the TrackReference.                                                                                                                                                                                                                                                                                                                                                                   |

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

@@ -20,4 +20,10 @@ import { useChat } from '@livekit/components-react';
 
 ## Returns
 
-`{     send: ((message: string) => Promise<void>) | undefined;     chatMessages: ReceivedChatMessage[];     isSending: boolean; }`
+```typescript
+{
+    send: ((message: string) => Promise<void>) | undefined;
+    chatMessages: ReceivedChatMessage[];
+    isSending: boolean;
+}
+```

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

@@ -17,4 +17,13 @@ import { useChatToggle } from '@livekit/components-react';
 
 ## Returns
 
-`{     mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {         className: string;         onClick: () => void;         'aria-pressed': string;         'data-lk-unread-msgs': string;     }; }`
+```typescript
+{
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: () => void;
+        'aria-pressed': string;
+        'data-lk-unread-msgs': string;
+    };
+}
+```

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

@@ -17,4 +17,12 @@ import { useClearPinButton } from '@livekit/components-react';
 
 ## Returns
 
-`{     buttonProps: ClearPinButtonProps & {         className: string;         disabled: boolean;         onClick: () => void;     }; }`
+```typescript
+{
+    buttonProps: ClearPinButtonProps & {
+        className: string;
+        disabled: boolean;
+        onClick: () => void;
+    };
+}
+```

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

@@ -17,4 +17,66 @@ import { useConnectionQualityIndicator } from '@livekit/components-react';
 
 ## Returns
 
-`{     className: "lk-rotate" | "lk-audio-conference" | "lk-audio-conference-stage" | "lk-audio-container" | "lk-button" | "lk-button-group" | "lk-button-group-container" | "lk-camera-off-note" | "lk-chat" | "lk-chat-entry" | "lk-chat-form" | "lk-chat-form-input" | "lk-chat-messages" | "lk-control-bar" | "lk-focus-layout-wrapper" | "lk-form-control" | "lk-grid-layout-wrapper" | "lk-join-button" | "lk-list" | "lk-message-body" | "lk-meta-data" | "lk-participant-name" | "lk-prejoin" | "lk-timestamp" | "lk-username-container" | "lk-video-conference" | "lk-video-conference-inner" | "lk-video-container" | "lk-audio-visualizer" | "lk-button-group-menu" | "lk-button-menu" | "lk-carousel" | "lk-chat-toggle" | "lk-connection-quality" | "lk-device-menu" | "lk-device-menu-heading" | "lk-disconnect-button" | "lk-focus-layout" | "lk-focus-toggle-button" | "lk-focused-participant" | "lk-grid-layout" | "lk-media-device-select" | "lk-pagination-control" | "lk-pagination-count" | "lk-pagination-indicator" | "lk-participant-media-audio" | "lk-participant-media-video" | "lk-participant-metadata" | "lk-participant-metadata-item" | "lk-participant-placeholder" | "lk-participant-tile" | "lk-pip-track" | "lk-room-container" | "lk-spinner" | "lk-start-audio-button" | "lk-toast" | "lk-track-muted-indicator-camera" | "lk-track-muted-indicator-microphone";     quality: ConnectionQuality; }`
+```typescript
+{
+  className: 'lk-rotate' |
+    'lk-audio-conference' |
+    'lk-audio-conference-stage' |
+    'lk-audio-container' |
+    'lk-button' |
+    'lk-button-group' |
+    'lk-button-group-container' |
+    'lk-camera-off-note' |
+    'lk-chat' |
+    'lk-chat-entry' |
+    'lk-chat-form' |
+    'lk-chat-form-input' |
+    'lk-chat-messages' |
+    'lk-control-bar' |
+    'lk-focus-layout-wrapper' |
+    'lk-form-control' |
+    'lk-grid-layout-wrapper' |
+    'lk-join-button' |
+    'lk-list' |
+    'lk-message-body' |
+    'lk-meta-data' |
+    'lk-participant-name' |
+    'lk-prejoin' |
+    'lk-timestamp' |
+    'lk-username-container' |
+    'lk-video-conference' |
+    'lk-video-conference-inner' |
+    'lk-video-container' |
+    'lk-audio-visualizer' |
+    'lk-button-group-menu' |
+    'lk-button-menu' |
+    'lk-carousel' |
+    'lk-chat-toggle' |
+    'lk-connection-quality' |
+    'lk-device-menu' |
+    'lk-device-menu-heading' |
+    'lk-disconnect-button' |
+    'lk-focus-layout' |
+    'lk-focus-toggle-button' |
+    'lk-focused-participant' |
+    'lk-grid-layout' |
+    'lk-media-device-select' |
+    'lk-pagination-control' |
+    'lk-pagination-count' |
+    'lk-pagination-indicator' |
+    'lk-participant-media-audio' |
+    'lk-participant-media-video' |
+    'lk-participant-metadata' |
+    'lk-participant-metadata-item' |
+    'lk-participant-placeholder' |
+    'lk-participant-tile' |
+    'lk-pip-track' |
+    'lk-room-container' |
+    'lk-spinner' |
+    'lk-start-audio-button' |
+    'lk-toast' |
+    'lk-track-muted-indicator-camera' |
+    'lk-track-muted-indicator-microphone';
+  quality: ConnectionQuality;
+}
+```

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

@@ -25,4 +25,6 @@ const connectionState = useConnectionState(room);
 
 ## Returns
 
-`import("livekit-client").ConnectionState`
+```typescript
+import('livekit-client').ConnectionState;
+```

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

@@ -12,4 +12,6 @@ import { useCreateLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -20,4 +20,6 @@ import { useDataChannel } from '@livekit/components-react';
 
 ## Returns
 
-`UseDataChannelReturnType<T>`
+```typescript
+UseDataChannelReturnType<T>;
+```

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

@@ -17,4 +17,6 @@ import { useDataChannel } from '@livekit/components-react';
 
 ## Returns
 
-`UseDataChannelReturnType`
+```typescript
+UseDataChannelReturnType;
+```

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

@@ -17,4 +17,12 @@ import { useDisconnectButton } from '@livekit/components-react';
 
 ## Returns
 
-`{     buttonProps: DisconnectButtonProps & {         className: string;         onClick: () => void;         disabled: boolean;     }; }`
+```typescript
+{
+    buttonProps: DisconnectButtonProps & {
+        className: string;
+        onClick: () => void;
+        disabled: boolean;
+    };
+}
+```

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

@@ -17,4 +17,6 @@ import { useEnsureCreateLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -19,4 +19,6 @@ import { useEnsureLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -19,4 +19,6 @@ import { useEnsureParticipant } from '@livekit/components-react';
 
 ## Returns
 
-`Participant`
+```typescript
+Participant;
+```

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

@@ -19,4 +19,6 @@ import { useEnsureRoom } from '@livekit/components-react';
 
 ## Returns
 
-`Room`
+```typescript
+Room;
+```

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

@@ -19,4 +19,6 @@ import { useEnsureTrackReference } from '@livekit/components-react';
 
 ## Returns
 
-`TrackReferenceOrPlaceholder`
+```typescript
+TrackReferenceOrPlaceholder;
+```

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

@@ -17,4 +17,12 @@ import { useFocusToggle } from '@livekit/components-react';
 
 ## Returns
 
-`{     mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {         className: string;         onClick: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;     };     inFocus: boolean; }`
+```typescript
+{
+    mergedProps: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+        className: string;
+        onClick: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
+    };
+    inFocus: boolean;
+}
+```

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

@@ -22,4 +22,8 @@ import { useGridLayout } from '@livekit/components-react';
 
 ## Returns
 
-`{     layout: GridLayoutDefinition; }`
+```typescript
+{
+  layout: GridLayoutDefinition;
+}
+```

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

@@ -20,4 +20,6 @@ import { useIsMuted } from '@livekit/components-react';
 
 ## Returns
 
-`boolean`
+```typescript
+boolean;
+```

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

@@ -17,4 +17,6 @@ import { useIsSpeaking } from '@livekit/components-react';
 
 ## Returns
 
-`boolean`
+```typescript
+boolean;
+```

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

@@ -14,4 +14,6 @@ import { useLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -17,4 +17,9 @@ import { useLiveKitRoom } from '@livekit/components-react';
 
 ## Returns
 
-`{     room: Room | undefined;     htmlProps: HTMLAttributes<T>; }`
+```typescript
+{
+  room: Room | undefined;
+  htmlProps: HTMLAttributes<T>;
+}
+```

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

@@ -19,4 +19,15 @@ import { useLocalParticipant } from '@livekit/components-react';
 
 ## Returns
 
-`{     isMicrophoneEnabled: boolean;     isScreenShareEnabled: boolean;     isCameraEnabled: boolean;     microphoneTrack: TrackPublication | undefined;     cameraTrack: TrackPublication | undefined;     lastMicrophoneError: Error | undefined;     lastCameraError: Error | undefined;     localParticipant: LocalParticipant; }`
+```typescript
+{
+  isMicrophoneEnabled: boolean;
+  isScreenShareEnabled: boolean;
+  isCameraEnabled: boolean;
+  microphoneTrack: TrackPublication | undefined;
+  cameraTrack: TrackPublication | undefined;
+  lastMicrophoneError: Error | undefined;
+  lastCameraError: Error | undefined;
+  localParticipant: LocalParticipant;
+}
+```

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

@@ -12,4 +12,6 @@ import { useLocalParticipantPermissions } from '@livekit/components-react';
 
 ## Returns
 
-`import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`
+```typescript
+import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined;
+```

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

@@ -14,4 +14,6 @@ import { useMaybeLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType | undefined`
+```typescript
+LayoutContextType | undefined;
+```

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

@@ -14,4 +14,6 @@ import { useMaybeParticipantContext } from '@livekit/components-react';
 
 ## Returns
 
-`Participant | undefined`
+```typescript
+Participant | undefined;
+```

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

@@ -14,4 +14,6 @@ import { useMaybeRoomContext } from '@livekit/components-react';
 
 ## Returns
 
-`Room | undefined`
+```typescript
+Room | undefined;
+```

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

@@ -14,4 +14,6 @@ import { useMaybeTrackContext } from '@livekit/components-react';
 
 ## Returns
 
-`TrackReferenceOrPlaceholder | undefined`
+```typescript
+TrackReferenceOrPlaceholder | undefined;
+```

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

@@ -19,4 +19,6 @@ import { useMediaDevices } from '@livekit/components-react';
 
 ## Returns
 
-`MediaDeviceInfo[]`
+```typescript
+MediaDeviceInfo[]
+```

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

@@ -17,4 +17,11 @@ import { useMediaDeviceSelect } from '@livekit/components-react';
 
 ## Returns
 
-`{     devices: MediaDeviceInfo[];     className: string;     activeDeviceId: string;     setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").SetMediaDeviceOptions | undefined) => Promise<void>; }`
+```typescript
+{
+    devices: MediaDeviceInfo[];
+    className: string;
+    activeDeviceId: string;
+    setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").SetMediaDeviceOptions | undefined) => Promise<void>;
+}
+```

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

@@ -23,4 +23,12 @@ import { useMediaTrack } from '@livekit/components-react';
 
 ## Returns
 
-`{     publication: import("livekit-client").TrackPublication | undefined;     isMuted: boolean | undefined;     isSubscribed: boolean | undefined;     track: import("livekit-client").Track | undefined;     elementProps: React.HTMLAttributes<HTMLElement>; }`
+```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

@@ -23,4 +23,12 @@ import { useMediaTrackByName } from '@livekit/components-react';
 
 ## Returns
 
-`{     publication: import("livekit-client").TrackPublication | undefined;     isMuted: boolean | undefined;     isSubscribed: boolean | undefined;     track: import("livekit-client").Track | undefined;     elementProps: import("react").HTMLAttributes<HTMLElement>; }`
+```typescript
+{
+  publication: import('livekit-client').TrackPublication | undefined;
+  isMuted: boolean | undefined;
+  isSubscribed: boolean | undefined;
+  track: import('livekit-client').Track | undefined;
+  elementProps: import('react').HTMLAttributes<HTMLElement>;
+}
+```

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

@@ -14,4 +14,6 @@ import { useParticipantContext } from '@livekit/components-react';
 
 ## Returns
 
-`Participant`
+```typescript
+Participant;
+```

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

@@ -17,4 +17,10 @@ import { useParticipantInfo } from '@livekit/components-react';
 
 ## Returns
 
-`{     identity: string;     name: string | undefined;     metadata: string | undefined; }`
+```typescript
+{
+  identity: string;
+  name: string | undefined;
+  metadata: string | undefined;
+}
+```

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

@@ -17,4 +17,6 @@ import { useParticipantPermissions } from '@livekit/components-react';
 
 ## Returns
 
-`import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`
+```typescript
+import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined;
+```

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

@@ -19,4 +19,6 @@ import { useParticipants } from '@livekit/components-react';
 
 ## Returns
 
-`(import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]`
+```typescript
+(import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]
+```

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

@@ -17,4 +17,8 @@ import { useParticipantTile } from '@livekit/components-react';
 
 ## Returns
 
-`{     elementProps: React.HTMLAttributes<T>; }`
+```typescript
+{
+  elementProps: React.HTMLAttributes<T>;
+}
+```

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

@@ -17,4 +17,6 @@ import { usePinnedTracks } from '@livekit/components-react';
 
 ## Returns
 
-`TrackReferenceOrPlaceholder[]`
+```typescript
+TrackReferenceOrPlaceholder[]
+```

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

@@ -23,4 +23,10 @@ import { usePreviewDevice } from '@livekit/components-react';
 
 ## Returns
 
-`{     selectedDevice: MediaDeviceInfo | undefined;     localTrack: T | undefined;     deviceError: Error | null; }`
+```typescript
+{
+  selectedDevice: MediaDeviceInfo | undefined;
+  localTrack: T | undefined;
+  deviceError: Error | null;
+}
+```

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

@@ -20,4 +20,6 @@ import { useRemoteParticipant } from '@livekit/components-react';
 
 ## Returns
 
-`RemoteParticipant | undefined`
+```typescript
+RemoteParticipant | undefined;
+```

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

@@ -19,4 +19,6 @@ import { useRemoteParticipants } from '@livekit/components-react';
 
 ## Returns
 
-`RemoteParticipant[]`
+```typescript
+RemoteParticipant[]
+```

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

@@ -14,4 +14,6 @@ import { useRoomContext } from '@livekit/components-react';
 
 ## Returns
 
-`Room`
+```typescript
+Room;
+```

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

@@ -17,4 +17,9 @@ import { useRoomInfo } from '@livekit/components-react';
 
 ## Returns
 
-`{     name: string;     metadata: string | undefined; }`
+```typescript
+{
+  name: string;
+  metadata: string | undefined;
+}
+```

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

@@ -19,4 +19,6 @@ import { useSortedParticipants } from '@livekit/components-react';
 
 ## Returns
 
-`Participant[]`
+```typescript
+Participant[]
+```

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

@@ -14,4 +14,6 @@ import { useSpeakingParticipants } from '@livekit/components-react';
 
 ## Returns
 
-`import("livekit-client").Participant[]`
+```typescript
+import("livekit-client").Participant[]
+```

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

@@ -23,4 +23,6 @@ import { useToken } from '@livekit/components-react';
 
 ## Returns
 
-`string | undefined`
+```typescript
+string | undefined;
+```

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

@@ -14,4 +14,6 @@ import { useTrackContext } from '@livekit/components-react';
 
 ## Returns
 
-`TrackReferenceOrPlaceholder`
+```typescript
+TrackReferenceOrPlaceholder;
+```

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

@@ -20,4 +20,9 @@ import { useTrackMutedIndicator } from '@livekit/components-react';
 
 ## Returns
 
-`{     isMuted: boolean;     className: string; }`
+```typescript
+{
+  isMuted: boolean;
+  className: string;
+}
+```

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

@@ -39,4 +39,6 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
 
 ## Returns
 
-`UseTracksHookReturnType<T>`
+```typescript
+UseTracksHookReturnType<T>;
+```

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

@@ -17,4 +17,12 @@ import { useTrackToggle } from '@livekit/components-react';
 
 ## Returns
 
-`{     toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>);     enabled: boolean;     pending: boolean;     track: import("livekit-client").LocalTrackPublication | undefined;     buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>; }`
+```typescript
+{
+    toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>);
+    enabled: boolean;
+    pending: boolean;
+    track: import("livekit-client").LocalTrackPublication | undefined;
+    buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
+}
+```

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

@@ -29,4 +29,6 @@ import { useVisualStableUpdate } from '@livekit/components-react';
 
 ## Returns
 
-`TrackReferenceOrPlaceholder[]`
+```typescript
+TrackReferenceOrPlaceholder[]
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "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",