@livekit/components-js-docs 0.0.2 → 0.0.4

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

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

package/generated-docs/react/localuserchoices.md

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

package/generated-docs/react/mediadevicemenuprops.md

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

package/generated-docs/react/mediadevicemenuprops.requestpermissions.md

@@ -10,4 +10,4 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
 requestPermissions?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/mediadeviceselectprops.exactmatch.md

@@ -10,4 +10,4 @@ will force the browser to only return the specified device will call `onDeviceSe
 exactMatch?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/mediadeviceselectprops.md

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

package/generated-docs/react/mediadeviceselectprops.requestpermissions.md

@@ -10,4 +10,4 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
 requestPermissions?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messagedecoder.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MessageDecoder type
+
+**Signature:**
+
+```typescript
+export type MessageDecoder = (message: Uint8Array) => ReceivedChatMessage;
+```
+
+**References:** [ReceivedChatMessage](./core/receivedchatmessage.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messageencoder.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MessageEncoder type
+
+**Signature:**
+
+```typescript
+export type MessageEncoder = (message: ChatMessage) => Uint8Array;
+```
+
+**References:** [ChatMessage](./core/chatmessage.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messageformatter.md

@@ -8,4 +8,4 @@
 export type MessageFormatter = (message: string) => React.ReactNode;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/meta-data.json

@@ -0,0 +1 @@
+{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"carouselview.md","title":"CarouselView"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}

package/generated-docs/react/participantcontext.md

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

package/generated-docs/react/participantloopprops.children.md

@@ -10,4 +10,4 @@ The template component to be used in the loop.
 children: React.ReactNode;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participantloopprops.md

@@ -8,11 +8,11 @@
 export interface ParticipantLoopProps
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                                     | Type            | Description                                                                                              |
-| ------------------------------------------------------------ | --------------- | -------------------------------------------------------------------------------------------------------- |
-| [children](./react/participantloopprops.children.md)         | React.ReactNode | The template component to be used in the loop.                                                           |
-| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over. If not provided, the participants from the current room context are used. |
+| Property                                                     | Type            | Description                                                                                 |
+| ------------------------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------- |
+| [children](./react/participantloopprops.children.md)         | React.ReactNode | The template component to be used in the loop.                                              |
+| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over. Use <code>useParticipants()</code> hook to get participants. |

package/generated-docs/react/participantloopprops.participants.md

@@ -2,7 +2,7 @@
 
 ## ParticipantLoopProps.participants property
 
-The participants to loop over. If not provided, the participants from the current room context are used.
+The participants to loop over. Use `useParticipants()` hook to get participants.
 
 **Signature:**
 
@@ -10,4 +10,4 @@ The participants to loop over. If not provided, the participants from the curren
 participants: Participant[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participantnameprops.md

@@ -10,4 +10,4 @@ export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanEleme
 
 **Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.md

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

package/generated-docs/react/prejoinprops.debug.md

@@ -10,4 +10,4 @@ Display a debug window for your convenience.
 debug?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.defaults.md

@@ -10,4 +10,4 @@ Prefill the input form with initial values.
 defaults?: Partial<LocalUserChoices>;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.md

@@ -10,18 +10,18 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 
 **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onSubmit' \| 'onError'&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                             | Type                                                                            | Description                                                                                                                                |
-| ---------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [camLabel?](./react/prejoinprops.camlabel.md)        | string                                                                          | _(Optional)_                                                                                                                               |
-| [debug?](./react/prejoinprops.debug.md)              | boolean                                                                         | _(Optional)_ Display a debug window for your convenience.                                                                                  |
-| [defaults?](./react/prejoinprops.defaults.md)        | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
-| [joinLabel?](./react/prejoinprops.joinlabel.md)      | string                                                                          | _(Optional)_                                                                                                                               |
-| [micLabel?](./react/prejoinprops.miclabel.md)        | string                                                                          | _(Optional)_                                                                                                                               |
-| [onError?](./react/prejoinprops.onerror.md)          | (error: Error) =&gt; void                                                       | _(Optional)_                                                                                                                               |
-| [onSubmit?](./react/prejoinprops.onsubmit.md)        | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
-| [onValidate?](./react/prejoinprops.onvalidate.md)    | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
-| [userLabel?](./react/hook/prejoinprops.userlabel.md) | string                                                                          | _(Optional)_                                                                                                                               |
+| Property                                          | Type                                                                            | Description                                                                                                                                |
+| ------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [camLabel?](./react/prejoinprops.camlabel.md)     | string                                                                          | _(Optional)_                                                                                                                               |
+| [debug?](./react/prejoinprops.debug.md)           | boolean                                                                         | _(Optional)_ Display a debug window for your convenience.                                                                                  |
+| [defaults?](./react/prejoinprops.defaults.md)     | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
+| [joinLabel?](./react/prejoinprops.joinlabel.md)   | string                                                                          | _(Optional)_                                                                                                                               |
+| [micLabel?](./react/prejoinprops.miclabel.md)     | string                                                                          | _(Optional)_                                                                                                                               |
+| [onError?](./react/prejoinprops.onerror.md)       | (error: Error) =&gt; void                                                       | _(Optional)_                                                                                                                               |
+| [onSubmit?](./react/prejoinprops.onsubmit.md)     | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
+| [onValidate?](./react/prejoinprops.onvalidate.md) | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
+| [userLabel?](./react/prejoinprops.userlabel.md)   | string                                                                          | _(Optional)_                                                                                                                               |

package/generated-docs/react/prejoinprops.onsubmit.md

@@ -10,4 +10,4 @@ This function is called with the `LocalUserChoices` if validation is passed.
 onSubmit?: (values: LocalUserChoices) => void;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.onvalidate.md

@@ -10,4 +10,4 @@ Provide your custom validation function. Only if validation is successful the us
 onValidate?: (values: LocalUserChoices) => boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/{hook/prejoinprops.userlabel.md → prejoinprops.userlabel.md}

@@ -2,8 +2,8 @@
 
 ## PreJoinProps.userLabel property
 
-## Import
+**Signature:**
 
 ```typescript
-import { userLabel } from '@livekit/components-react';
+userLabel?: string;
 ```

package/generated-docs/react/roomcontext.md

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

package/generated-docs/react/roomnameprops.md

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

package/generated-docs/react/trackcontext.md

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

package/generated-docs/react/trackloopprops.children.md

@@ -10,4 +10,4 @@ The template component to be used in the loop.
 children: React.ReactNode;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackloopprops.md

@@ -8,11 +8,11 @@
 export interface TrackLoopProps
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                       | Type                                                                                                                                       | Description                                    |
-| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
-| [children](./react/trackloopprops.children.md) | React.ReactNode                                                                                                                            | The template component to be used in the loop. |
-| [tracks](./react/trackloopprops.tracks.md)     | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over.                 |
+| Property                                       | Type                                                                                                                                       | Description                                                                                          |
+| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
+| [children](./react/trackloopprops.children.md) | React.ReactNode                                                                                                                            | The template component to be used in the loop.                                                       |
+| [tracks](./react/trackloopprops.tracks.md)     | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |

package/generated-docs/react/trackloopprops.tracks.md

@@ -2,7 +2,7 @@
 
 ## TrackLoopProps.tracks property
 
-Track references to loop over.
+Track references to loop over. You can the use `useTracks()` hook to get TrackReferences.
 
 **Signature:**
 
@@ -10,4 +10,4 @@ Track references to loop over.
 tracks: TrackReference[] | TrackReferenceOrPlaceholder[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackmutedindicatorprops.md

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

package/generated-docs/react/tracktoggleprops.md

@@ -10,7 +10,7 @@ export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.But
 
 **Extends:** Omit&lt;React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;, 'onChange'&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/usechattoggleprops.md

@@ -8,7 +8,7 @@
 export interface UseChatToggleProps
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/usefocustoggleprops.md

@@ -8,7 +8,7 @@
 export interface UseFocusToggleProps
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/useismutedoptions.md

@@ -8,7 +8,7 @@
 export interface UseIsMutedOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/uselocalparticipantoptions.md

@@ -8,7 +8,7 @@
 export interface UseLocalParticipantOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

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

@@ -10,4 +10,4 @@ The room to use. If not provided, the hook will use the room from the context.
 room?: Room;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usemediadeviceselectprops.md

@@ -8,7 +8,7 @@
 export interface UseMediaDeviceSelectProps
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md

@@ -10,4 +10,4 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
 requestPermissions?: boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usemediatrackoptions.md

@@ -8,7 +8,7 @@
 export interface UseMediaTrackOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/useparticipantinfooptions.md

@@ -8,7 +8,7 @@
 export interface UseParticipantInfoOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/useparticipantpermissionsoptions.md

@@ -8,7 +8,7 @@
 export interface UseParticipantPermissionsOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/useparticipantsoptions.md

@@ -8,7 +8,7 @@
 export interface UseParticipantsOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

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

@@ -10,4 +10,4 @@ The room to use. If not provided, the hook will use the room from the context.
 room?: Room;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipantsoptions.updateonlyon.md

@@ -10,4 +10,4 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
 updateOnlyOn?: RoomEvent[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.md

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

package/generated-docs/react/useremoteparticipantoptions.md

@@ -8,7 +8,7 @@
 export interface UseRemoteParticipantOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/useremoteparticipantsoptions.md

@@ -8,7 +8,7 @@
 export interface UseRemoteParticipantsOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

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

@@ -10,4 +10,4 @@ The room to use. If not provided, the hook will use the room from the context.
 room?: Room;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md

@@ -10,4 +10,4 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
 updateOnlyOn?: RoomEvent[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/userinfo.md

@@ -8,7 +8,7 @@
 export interface UserInfo
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/useroominfooptions.md

@@ -8,7 +8,7 @@
 export interface UseRoomInfoOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/usetokenoptions.md

@@ -8,10 +8,10 @@
 export interface UseTokenOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                              | Type                            | Description  |
-| ----------------------------------------------------- | ------------------------------- | ------------ |
-| [userInfo?](./react/hook/usetokenoptions.userinfo.md) | [UserInfo](./react/userinfo.md) | _(Optional)_ |
+| Property                                         | Type                            | Description  |
+| ------------------------------------------------ | ------------------------------- | ------------ |
+| [userInfo?](./react/usetokenoptions.userinfo.md) | [UserInfo](./react/userinfo.md) | _(Optional)_ |

package/generated-docs/react/{hook/usetokenoptions.userinfo.md → usetokenoptions.userinfo.md}

@@ -2,8 +2,8 @@
 
 ## UseTokenOptions.userInfo property
 
-## Import
+**Signature:**
 
 ```typescript
-import { userInfo } from '@livekit/components-react';
+userInfo?: UserInfo;
 ```

package/generated-docs/react/usetrackmutedindicatoroptions.md

@@ -8,7 +8,7 @@
 export interface UseTrackMutedIndicatorOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 

package/generated-docs/react/usetrackshookreturntype.md

@@ -14,4 +14,4 @@ export type UseTracksHookReturnType<T> = T extends Track.Source[]
 
 **References:** [TrackReference](./core/trackreference.md)<!-- -->, [TrackSourceWithOptions](./core/tracksourcewithoptions.md)<!-- -->, [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usetracksoptions.md

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

package/generated-docs/react/usetracktoggleprops.md

@@ -10,4 +10,4 @@ export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackT
 
 **Extends:** Omit&lt;[TrackToggleProps](./react/tracktoggleprops.md)<!-- -->&lt;T&gt;, 'showIcon'&gt;
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -10,4 +10,4 @@ Overwrites the default sort function.
 customSortFunction?: (trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usevisualstableupdateoptions.md

@@ -8,7 +8,7 @@
 export interface UseVisualStableUpdateOptions
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties