@livekit/components-js-docs 0.0.3 → 0.0.5

package/generated-docs/react/controlbarcontrols.md

@@ -14,4 +14,4 @@ export type ControlBarControls = {
 };
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/controlbarprops.md

@@ -10,7 +10,7 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
 
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/disconnectbuttonprops.md

@@ -10,7 +10,7 @@ export interface DisconnectButtonProps extends React.ButtonHTMLAttributes<HTMLBu
 
 **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/focuslayoutcontainerprops.md

@@ -10,7 +10,7 @@ export interface FocusLayoutContainerProps extends React.HTMLAttributes<HTMLDivE
 
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/focuslayoutprops.md

@@ -10,7 +10,7 @@ export interface FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
 
 **Extends:** React.HTMLAttributes&lt;HTMLElement&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/focustoggleprops.md

@@ -10,7 +10,7 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
 
 **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/formatchatmessagelinks.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# formatChatMessageLinks
+
+**Signature:**
+
+```typescript
+export declare function formatChatMessageLinks(message: string): React.ReactNode;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/gridlayoutprops.md

@@ -10,7 +10,7 @@ export interface GridLayoutProps extends React.HTMLAttributes<HTMLDivElement>, P
 
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, Pick&lt;[UseParticipantsOptions](./react/useparticipantsoptions.md)<!-- -->, 'updateOnlyOn'&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

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

@@ -8,7 +8,7 @@
 import { useChat } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -8,7 +8,7 @@
 import { useChatToggle } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -8,7 +8,7 @@
 import { useClearPinButton } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -8,7 +8,7 @@
 import { useConnectionQualityIndicator } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -16,7 +16,7 @@ import { useConnectionState } from '@livekit/components-react';
 const connectionState = useConnectionState(room);
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Parameters
 
@@ -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

@@ -8,8 +8,10 @@
 import { useCreateLayoutContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -8,7 +8,7 @@
 import { useDataChannel } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -20,4 +20,6 @@ import { useDataChannel } from '@livekit/components-react';
 
 ## Returns
 
-`UseDataChannelReturnType<T>`
+```typescript
+UseDataChannelReturnType<T>;
+```

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

@@ -8,7 +8,7 @@
 import { useDataChannel } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -17,4 +17,6 @@ import { useDataChannel } from '@livekit/components-react';
 
 ## Returns
 
-`UseDataChannelReturnType`
+```typescript
+UseDataChannelReturnType;
+```

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

@@ -8,7 +8,7 @@
 import { useDisconnectButton } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -8,7 +8,7 @@
 import { useEnsureCreateLayoutContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -17,4 +17,6 @@ import { useEnsureCreateLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -10,7 +10,7 @@ Ensures that a layout context is provided, either via context or explicitly as a
 import { useEnsureLayoutContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -19,4 +19,6 @@ import { useEnsureLayoutContext } from '@livekit/components-react';
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -10,7 +10,7 @@ Ensures that a participant is provided, either via context or explicitly as a pa
 import { useEnsureParticipant } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -19,4 +19,6 @@ import { useEnsureParticipant } from '@livekit/components-react';
 
 ## Returns
 
-`Participant`
+```typescript
+Participant;
+```

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

@@ -10,7 +10,7 @@ Ensures that a room is provided, either via context or explicitly as a parameter
 import { useEnsureRoom } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -19,4 +19,6 @@ import { useEnsureRoom } from '@livekit/components-react';
 
 ## Returns
 
-`Room`
+```typescript
+Room;
+```

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

@@ -10,7 +10,7 @@ Ensures that a track reference is provided, either via context or explicitly as
 import { useEnsureTrackReference } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -19,4 +19,6 @@ import { useEnsureTrackReference } from '@livekit/components-react';
 
 ## Returns
 
-`TrackReferenceOrPlaceholder`
+```typescript
+TrackReferenceOrPlaceholder;
+```

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

@@ -8,7 +8,7 @@
 import { useFocusToggle } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -10,7 +10,7 @@ The useGridLayout hook tries to select the best layout to fit all tiles. If the
 import { useGridLayout } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -22,4 +22,8 @@ import { useGridLayout } from '@livekit/components-react';
 
 ## Returns
 
-`{     layout: GridLayoutDefinition; }`
+```typescript
+{
+  layout: GridLayoutDefinition;
+}
+```

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

@@ -8,7 +8,7 @@
 import { useIsMuted } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -20,4 +20,6 @@ import { useIsMuted } from '@livekit/components-react';
 
 ## Returns
 
-`boolean`
+```typescript
+boolean;
+```

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

@@ -8,7 +8,7 @@
 import { useIsSpeaking } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -17,4 +17,6 @@ import { useIsSpeaking } from '@livekit/components-react';
 
 ## Returns
 
-`boolean`
+```typescript
+boolean;
+```

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

@@ -10,8 +10,10 @@ Ensures that a layout context is provided via context. If no layout context is p
 import { useLayoutContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 
-`LayoutContextType`
+```typescript
+LayoutContextType;
+```

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

@@ -8,7 +8,7 @@
 import { useLiveKitRoom } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -10,7 +10,7 @@ The useLocalParticipant hook the state of the local participant.
 import { useLocalParticipant } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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

@@ -8,8 +8,10 @@
 import { useLocalParticipantPermissions } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## 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

@@ -10,8 +10,10 @@ Returns a layout context from the `LayoutContext` if it exists, otherwise `undef
 import { useMaybeLayoutContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 
-`LayoutContextType | undefined`
+```typescript
+LayoutContextType | undefined;
+```

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

@@ -10,8 +10,10 @@ Returns a participant from the `ParticipantContext` if it exists, otherwise `und
 import { useMaybeParticipantContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 
-`Participant | undefined`
+```typescript
+Participant | undefined;
+```

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

@@ -10,8 +10,10 @@ Returns the room context if it exists, otherwise undefined.
 import { useMaybeRoomContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 
-`Room | undefined`
+```typescript
+Room | undefined;
+```

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

@@ -10,8 +10,10 @@ Returns a track reference from the `TrackContext` if it exists, otherwise `undef
 import { useMaybeTrackContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 
-`TrackReferenceOrPlaceholder | undefined`
+```typescript
+TrackReferenceOrPlaceholder | undefined;
+```

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

@@ -8,7 +8,7 @@
 import { useMediaDevices } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -19,4 +19,6 @@ import { useMediaDevices } from '@livekit/components-react';
 
 ## Returns
 
-`MediaDeviceInfo[]`
+```typescript
+MediaDeviceInfo[]
+```

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

@@ -8,7 +8,7 @@
 import { useMediaDeviceSelect } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 
@@ -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>;
+}
+```