@livekit/components-js-docs 0.0.3 → 0.0.4

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
 

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
 

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
 

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
 

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
 

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

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

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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

@@ -10,7 +10,7 @@ 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
 

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
 

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
 

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

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

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

@@ -10,7 +10,7 @@ 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
 

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

@@ -10,7 +10,7 @@ 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
 

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

@@ -10,7 +10,7 @@ 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
 

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

@@ -10,7 +10,7 @@ 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
 

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
 

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
 

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

@@ -8,7 +8,7 @@
 import { useMediaTrack } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { useMediaTrackByName } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ Ensures that a participant is provided via context. If not inside a `Participant
 import { useParticipantContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 

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

@@ -8,7 +8,7 @@
 import { useParticipantInfo } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { useParticipantPermissions } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ The useParticipants hook returns all participants (local and remote) of the curr
 import { useParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { useParticipantTile } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { usePinnedTracks } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { usePreviewDevice } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { useRemoteParticipant } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ The useRemoteParticipants
 import { useRemoteParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ Ensures that a room is provided via context. If no room is provided, an error is
 import { useRoomContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 

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

@@ -8,7 +8,7 @@
 import { useRoomInfo } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ The useSortedParticipants hook returns the only the active speakers of all parti
 import { useSortedParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ The useSpeakingParticipants hook returns the only the active speakers of all par
 import { useSpeakingParticipants } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 

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

@@ -8,7 +8,7 @@
 import { useToken } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -10,7 +10,7 @@ Ensures that a track reference is provided via context. If not inside a `TrackCo
 import { useTrackContext } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Returns
 

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

@@ -8,7 +8,7 @@
 import { useTrackMutedIndicator } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -27,7 +27,7 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
 ]);
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 2} /%}
 
 ## Parameters
 

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

@@ -8,7 +8,7 @@
 import { useTrackToggle } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

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

@@ -14,7 +14,7 @@ Updating works with pagination. For example, if a participant starts speaking on
 import { useVisualStableUpdate } from '@livekit/components-react';
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Parameters
 

package/generated-docs/react/index.md

@@ -19,7 +19,6 @@
 | [FocusLayout({ track, ...htmlProps })](./react/component/focuslayout.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [FocusLayoutContainer(props)](./react/component/focuslayoutcontainer.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [FocusToggle({ trackSource, participant, ...props })](./react/component/focustoggle.md)                                                                                                                 | The FocusToggle puts the ParticipantTile in focus or removes it from focus.                                                                                                                                                                                                                                                                                                                                                    |
-| [formatChatMessageLinks(message)](./react/component/formatchatmessagelinks.md)                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | [GridLayout({ tracks, ...props })](./react/component/gridlayout.md)                                                                                                                                     | The GridLayout component displays the nested participants in a grid where every participants has the same size.                                                                                                                                                                                                                                                                                                                |
 | [LiveKitRoom(props)](./react/component/livekitroom.md)                                                                                                                                                  | The LiveKitRoom component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself.                                                                                                                              |
 | [MediaDeviceSelect({ kind, initialSelection, onActiveDeviceChange, onDeviceListChange, onDeviceSelectError, exactMatch, track, requestPermissions, ...props })](./react/component/mediadeviceselect.md) | The MediaDeviceSelect list all media devices of one kind. Clicking on one of the listed devices make it the active media device.                                                                                                                                                                                                                                                                                               |
@@ -125,6 +124,7 @@
 | [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md)                 |                                                                                                                                                 |
 | [FocusLayoutProps](./react/focuslayoutprops.md)                                   |                                                                                                                                                 |
 | [FocusToggleProps](./react/focustoggleprops.md)                                   |                                                                                                                                                 |
+| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md)              |                                                                                                                                                 |
 | [GridLayoutProps](./react/gridlayoutprops.md)                                     |                                                                                                                                                 |
 | [LayoutContext](./react/layoutcontext.md)                                         |                                                                                                                                                 |
 | [LayoutContextType](./react/layoutcontexttype.md)                                 |                                                                                                                                                 |

package/generated-docs/react/layoutcontext.md

@@ -8,4 +8,4 @@
 LayoutContext: React.Context<LayoutContextType | undefined>;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/layoutcontexttype.md

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

package/generated-docs/react/livekitroomprops.audio.md

@@ -10,4 +10,4 @@ Publish audio immediately after connecting to your LiveKit room.
 audio?: AudioCaptureOptions | boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.connect.md

@@ -10,4 +10,4 @@ If set to true a connection to LiveKit room is initiated.
 connect?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.connectoptions.md

@@ -10,4 +10,4 @@ Define options how to connect to the LiveKit server.
 connectOptions?: RoomConnectOptions;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.md

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

package/generated-docs/react/livekitroomprops.options.md

@@ -10,4 +10,4 @@ Options for when creating a new room. When you pass your own room instance to th
 options?: RoomOptions;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}