@livekit/components-js-docs 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (200) hide show
  1. package/generated-docs/core/gettrackreferenceid.md +1 -1
  2. package/generated-docs/core/gettrackreferencesource.md +1 -1
  3. package/generated-docs/core/ismobilebrowser.md +1 -1
  4. package/generated-docs/core/isparticipantsourcepinned.md +1 -1
  5. package/generated-docs/core/istrackreferencepinned.md +1 -1
  6. package/generated-docs/core/sendmessage.md +1 -1
  7. package/generated-docs/core/setloglevel.md +1 -1
  8. package/generated-docs/core/sortparticipants.md +1 -1
  9. package/generated-docs/core/sorttrackreferences.md +1 -1
  10. package/generated-docs/core/supportsscreensharing.md +1 -1
  11. package/generated-docs/core/trackidentifier.md +1 -1
  12. package/generated-docs/core/updatepages.md +1 -1
  13. package/generated-docs/react/allowaudioplaybackprops.md +1 -1
  14. package/generated-docs/react/audioconferenceprops.md +1 -1
  15. package/generated-docs/react/audiotrackprops.md +1 -1
  16. package/generated-docs/react/audiotrackprops.volume.md +1 -1
  17. package/generated-docs/react/audiovisualizerprops.md +1 -1
  18. package/generated-docs/react/carouselviewprops.md +1 -1
  19. package/generated-docs/react/carouselviewprops.orientation.md +1 -1
  20. package/generated-docs/react/chatentryprops.entry.md +1 -1
  21. package/generated-docs/react/chatentryprops.hidename.md +1 -1
  22. package/generated-docs/react/chatentryprops.hidetimestamp.md +1 -1
  23. package/generated-docs/react/chatentryprops.md +1 -1
  24. package/generated-docs/react/chatentryprops.messageformatter.md +1 -1
  25. package/generated-docs/react/chatprops.md +1 -1
  26. package/generated-docs/react/chattoggleprops.md +1 -1
  27. package/generated-docs/react/clearpinbuttonprops.md +1 -1
  28. package/generated-docs/react/component/audioconference.md +1 -1
  29. package/generated-docs/react/component/audiotrack.md +1 -1
  30. package/generated-docs/react/component/audiovisualizer.md +1 -1
  31. package/generated-docs/react/component/carouselview.md +1 -1
  32. package/generated-docs/react/component/chat.md +1 -1
  33. package/generated-docs/react/component/chatentry.md +1 -1
  34. package/generated-docs/react/component/chattoggle.md +1 -1
  35. package/generated-docs/react/component/clearpinbutton.md +1 -1
  36. package/generated-docs/react/component/connectionqualityindicator.md +1 -1
  37. package/generated-docs/react/component/connectionstate.md +1 -1
  38. package/generated-docs/react/component/connectionstatetoast.md +1 -1
  39. package/generated-docs/react/component/controlbar.md +1 -1
  40. package/generated-docs/react/component/disconnectbutton.md +1 -1
  41. package/generated-docs/react/component/focuslayout.md +1 -1
  42. package/generated-docs/react/component/focuslayoutcontainer.md +1 -1
  43. package/generated-docs/react/component/focustoggle.md +1 -1
  44. package/generated-docs/react/component/gridlayout.md +1 -1
  45. package/generated-docs/react/component/livekitroom.md +1 -1
  46. package/generated-docs/react/component/mediadevicemenu.md +1 -1
  47. package/generated-docs/react/component/mediadeviceselect.md +1 -1
  48. package/generated-docs/react/component/participantaudiotile.md +1 -1
  49. package/generated-docs/react/component/participantcontextifneeded.md +1 -1
  50. package/generated-docs/react/component/participantloop.md +1 -1
  51. package/generated-docs/react/component/participantname.md +1 -1
  52. package/generated-docs/react/component/participanttile.md +1 -1
  53. package/generated-docs/react/component/prejoin.md +1 -1
  54. package/generated-docs/react/component/roomaudiorenderer.md +1 -1
  55. package/generated-docs/react/component/roomname.md +1 -1
  56. package/generated-docs/react/component/startaudio.md +1 -1
  57. package/generated-docs/react/component/toast.md +1 -1
  58. package/generated-docs/react/component/trackloop.md +1 -1
  59. package/generated-docs/react/component/trackmutedindicator.md +1 -1
  60. package/generated-docs/react/component/tracktoggle.md +1 -1
  61. package/generated-docs/react/component/videoconference.md +1 -1
  62. package/generated-docs/react/component/videotrack.md +1 -1
  63. package/generated-docs/react/connectionqualityindicatoroptions.md +1 -1
  64. package/generated-docs/react/connectionqualityindicatorprops.md +1 -1
  65. package/generated-docs/react/connectionstatetoastprops.md +1 -1
  66. package/generated-docs/react/connectionstatusprops.md +1 -1
  67. package/generated-docs/react/connectionstatusprops.room.md +1 -1
  68. package/generated-docs/react/controlbarcontrols.md +1 -1
  69. package/generated-docs/react/controlbarprops.md +1 -1
  70. package/generated-docs/react/disconnectbuttonprops.md +1 -1
  71. package/generated-docs/react/focuslayoutcontainerprops.md +1 -1
  72. package/generated-docs/react/focuslayoutprops.md +1 -1
  73. package/generated-docs/react/focustoggleprops.md +1 -1
  74. package/generated-docs/react/formatchatmessagelinks.md +11 -0
  75. package/generated-docs/react/gridlayoutprops.md +1 -1
  76. package/generated-docs/react/hook/usechat.md +1 -1
  77. package/generated-docs/react/hook/usechattoggle.md +1 -1
  78. package/generated-docs/react/hook/useclearpinbutton.md +1 -1
  79. package/generated-docs/react/hook/useconnectionqualityindicator.md +1 -1
  80. package/generated-docs/react/hook/useconnectionstate.md +1 -1
  81. package/generated-docs/react/hook/usecreatelayoutcontext.md +1 -1
  82. package/generated-docs/react/hook/usedatachannel.md +1 -1
  83. package/generated-docs/react/hook/usedatachannel_1.md +1 -1
  84. package/generated-docs/react/hook/usedisconnectbutton.md +1 -1
  85. package/generated-docs/react/hook/useensurecreatelayoutcontext.md +1 -1
  86. package/generated-docs/react/hook/useensurelayoutcontext.md +1 -1
  87. package/generated-docs/react/hook/useensureparticipant.md +1 -1
  88. package/generated-docs/react/hook/useensureroom.md +1 -1
  89. package/generated-docs/react/hook/useensuretrackreference.md +1 -1
  90. package/generated-docs/react/hook/usefocustoggle.md +1 -1
  91. package/generated-docs/react/hook/usegridlayout.md +1 -1
  92. package/generated-docs/react/hook/useismuted.md +1 -1
  93. package/generated-docs/react/hook/useisspeaking.md +1 -1
  94. package/generated-docs/react/hook/uselayoutcontext.md +1 -1
  95. package/generated-docs/react/hook/uselivekitroom.md +1 -1
  96. package/generated-docs/react/hook/uselocalparticipant.md +1 -1
  97. package/generated-docs/react/hook/uselocalparticipantpermissions.md +1 -1
  98. package/generated-docs/react/hook/usemaybelayoutcontext.md +1 -1
  99. package/generated-docs/react/hook/usemaybeparticipantcontext.md +1 -1
  100. package/generated-docs/react/hook/usemayberoomcontext.md +1 -1
  101. package/generated-docs/react/hook/usemaybetrackcontext.md +1 -1
  102. package/generated-docs/react/hook/usemediadevices.md +1 -1
  103. package/generated-docs/react/hook/usemediadeviceselect.md +1 -1
  104. package/generated-docs/react/hook/usemediatrack.md +1 -1
  105. package/generated-docs/react/hook/usemediatrackbyname.md +1 -1
  106. package/generated-docs/react/hook/useparticipantcontext.md +1 -1
  107. package/generated-docs/react/hook/useparticipantinfo.md +1 -1
  108. package/generated-docs/react/hook/useparticipantpermissions.md +1 -1
  109. package/generated-docs/react/hook/useparticipants.md +1 -1
  110. package/generated-docs/react/hook/useparticipanttile.md +1 -1
  111. package/generated-docs/react/hook/usepinnedtracks.md +1 -1
  112. package/generated-docs/react/hook/usepreviewdevice.md +1 -1
  113. package/generated-docs/react/hook/useremoteparticipant.md +1 -1
  114. package/generated-docs/react/hook/useremoteparticipants.md +1 -1
  115. package/generated-docs/react/hook/useroomcontext.md +1 -1
  116. package/generated-docs/react/hook/useroominfo.md +1 -1
  117. package/generated-docs/react/hook/usesortedparticipants.md +1 -1
  118. package/generated-docs/react/hook/usespeakingparticipants.md +1 -1
  119. package/generated-docs/react/hook/usetoken.md +1 -1
  120. package/generated-docs/react/hook/usetrackcontext.md +1 -1
  121. package/generated-docs/react/hook/usetrackmutedindicator.md +1 -1
  122. package/generated-docs/react/hook/usetracks.md +1 -1
  123. package/generated-docs/react/hook/usetracktoggle.md +1 -1
  124. package/generated-docs/react/hook/usevisualstableupdate.md +1 -1
  125. package/generated-docs/react/index.md +1 -1
  126. package/generated-docs/react/layoutcontext.md +1 -1
  127. package/generated-docs/react/layoutcontexttype.md +1 -1
  128. package/generated-docs/react/livekitroomprops.audio.md +1 -1
  129. package/generated-docs/react/livekitroomprops.connect.md +1 -1
  130. package/generated-docs/react/livekitroomprops.connectoptions.md +1 -1
  131. package/generated-docs/react/livekitroomprops.md +1 -1
  132. package/generated-docs/react/livekitroomprops.options.md +1 -1
  133. package/generated-docs/react/livekitroomprops.room.md +1 -1
  134. package/generated-docs/react/livekitroomprops.screen.md +1 -1
  135. package/generated-docs/react/livekitroomprops.serverurl.md +1 -1
  136. package/generated-docs/react/livekitroomprops.token.md +1 -1
  137. package/generated-docs/react/livekitroomprops.video.md +1 -1
  138. package/generated-docs/react/localuserchoices.md +1 -1
  139. package/generated-docs/react/mediadevicemenuprops.md +1 -1
  140. package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +1 -1
  141. package/generated-docs/react/mediadeviceselectprops.exactmatch.md +1 -1
  142. package/generated-docs/react/mediadeviceselectprops.md +1 -1
  143. package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +1 -1
  144. package/generated-docs/react/messagedecoder.md +1 -1
  145. package/generated-docs/react/messageencoder.md +1 -1
  146. package/generated-docs/react/messageformatter.md +1 -1
  147. package/generated-docs/react/meta-data.json +1 -0
  148. package/generated-docs/react/participantcontext.md +1 -1
  149. package/generated-docs/react/participantloopprops.children.md +1 -1
  150. package/generated-docs/react/participantloopprops.md +1 -1
  151. package/generated-docs/react/participantloopprops.participants.md +1 -1
  152. package/generated-docs/react/participantnameprops.md +1 -1
  153. package/generated-docs/react/participanttileprops.md +1 -1
  154. package/generated-docs/react/prejoinprops.debug.md +1 -1
  155. package/generated-docs/react/prejoinprops.defaults.md +1 -1
  156. package/generated-docs/react/prejoinprops.md +12 -12
  157. package/generated-docs/react/prejoinprops.onsubmit.md +1 -1
  158. package/generated-docs/react/prejoinprops.onvalidate.md +1 -1
  159. package/generated-docs/react/{hook/prejoinprops.userlabel.md → prejoinprops.userlabel.md} +2 -2
  160. package/generated-docs/react/roomcontext.md +1 -1
  161. package/generated-docs/react/roomnameprops.md +1 -1
  162. package/generated-docs/react/trackcontext.md +1 -1
  163. package/generated-docs/react/trackloopprops.children.md +1 -1
  164. package/generated-docs/react/trackloopprops.md +1 -1
  165. package/generated-docs/react/trackloopprops.tracks.md +1 -1
  166. package/generated-docs/react/trackmutedindicatorprops.md +1 -1
  167. package/generated-docs/react/tracktoggleprops.md +1 -1
  168. package/generated-docs/react/usechattoggleprops.md +1 -1
  169. package/generated-docs/react/usefocustoggleprops.md +1 -1
  170. package/generated-docs/react/useismutedoptions.md +1 -1
  171. package/generated-docs/react/uselocalparticipantoptions.md +1 -1
  172. package/generated-docs/react/uselocalparticipantoptions.room.md +1 -1
  173. package/generated-docs/react/usemediadeviceselectprops.md +1 -1
  174. package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +1 -1
  175. package/generated-docs/react/usemediatrackoptions.md +1 -1
  176. package/generated-docs/react/useparticipantinfooptions.md +1 -1
  177. package/generated-docs/react/useparticipantpermissionsoptions.md +1 -1
  178. package/generated-docs/react/useparticipantsoptions.md +1 -1
  179. package/generated-docs/react/useparticipantsoptions.room.md +1 -1
  180. package/generated-docs/react/useparticipantsoptions.updateonlyon.md +1 -1
  181. package/generated-docs/react/useparticipanttileprops.md +1 -1
  182. package/generated-docs/react/useremoteparticipantoptions.md +1 -1
  183. package/generated-docs/react/useremoteparticipantsoptions.md +1 -1
  184. package/generated-docs/react/useremoteparticipantsoptions.room.md +1 -1
  185. package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +1 -1
  186. package/generated-docs/react/userinfo.md +1 -1
  187. package/generated-docs/react/useroominfooptions.md +1 -1
  188. package/generated-docs/react/usetokenoptions.md +4 -4
  189. package/generated-docs/react/{hook/usetokenoptions.userinfo.md → usetokenoptions.userinfo.md} +2 -2
  190. package/generated-docs/react/usetrackmutedindicatoroptions.md +1 -1
  191. package/generated-docs/react/usetrackshookreturntype.md +1 -1
  192. package/generated-docs/react/usetracksoptions.md +1 -1
  193. package/generated-docs/react/usetracktoggleprops.md +1 -1
  194. package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +1 -1
  195. package/generated-docs/react/usevisualstableupdateoptions.md +1 -1
  196. package/generated-docs/react/videoconferenceprops.md +1 -1
  197. package/generated-docs/react/videotrackprops.md +1 -1
  198. package/package.json +1 -1
  199. package/generated-docs/react/component/formatchatmessagelinks.md +0 -11
  200. package/meta-data.json +0 -78
@@ -10,4 +10,4 @@ Optional room instance. By passing your own room instance you overwrite the `opt
10
10
  room?: Room;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Publish screen share immediately after connecting to your LiveKit room.
10
10
  screen?: ScreenShareCaptureOptions | boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simpli
10
10
  serverUrl: string | undefined;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ A user specific access token for a client to authenticate to the room. This toke
10
10
  token: string | undefined;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Publish video immediately after connecting to your LiveKit room.
10
10
  video?: VideoCaptureOptions | boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -14,4 +14,4 @@ export type LocalUserChoices = {
14
14
  };
15
15
  ```
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface MediaDeviceMenuProps extends React.ButtonHTMLAttributes<HTMLBut
10
10
 
11
11
  **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,4 +10,4 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
10
10
  requestPermissions?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ will force the browser to only return the specified device will call `onDeviceSe
10
10
  exactMatch?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface MediaDeviceSelectProps extends React.HTMLAttributes<HTMLUListEl
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLUListElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,4 +10,4 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
10
10
  requestPermissions?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ export type MessageDecoder = (message: Uint8Array) => ReceivedChatMessage;
10
10
 
11
11
  **References:** [ReceivedChatMessage](./core/receivedchatmessage.md)
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ export type MessageEncoder = (message: ChatMessage) => Uint8Array;
10
10
 
11
11
  **References:** [ChatMessage](./core/chatmessage.md)
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,4 +8,4 @@
8
8
  export type MessageFormatter = (message: string) => React.ReactNode;
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -0,0 +1 @@
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"}]}
@@ -8,4 +8,4 @@
8
8
  ParticipantContext: React.Context<Participant | undefined>;
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ The template component to be used in the loop.
10
10
  children: React.ReactNode;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,7 +8,7 @@
8
8
  export interface ParticipantLoopProps
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,4 +10,4 @@ The participants to loop over. Use `useParticipants()` hook to get participants.
10
10
  participants: Participant[];
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanEleme
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,4 +10,4 @@ Display a debug window for your convenience.
10
10
  debug?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Prefill the input form with initial values.
10
10
  defaults?: Partial<LocalUserChoices>;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,18 +10,18 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
10
10
 
11
11
  **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onSubmit' \| 'onError'&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
17
- | Property | Type | Description |
18
- | ---------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
19
- | [camLabel?](./react/prejoinprops.camlabel.md) | string | _(Optional)_ |
20
- | [debug?](./react/prejoinprops.debug.md) | boolean | _(Optional)_ Display a debug window for your convenience. |
21
- | [defaults?](./react/prejoinprops.defaults.md) | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt; | _(Optional)_ Prefill the input form with initial values. |
22
- | [joinLabel?](./react/prejoinprops.joinlabel.md) | string | _(Optional)_ |
23
- | [micLabel?](./react/prejoinprops.miclabel.md) | string | _(Optional)_ |
24
- | [onError?](./react/prejoinprops.onerror.md) | (error: Error) =&gt; void | _(Optional)_ |
25
- | [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. |
26
- | [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. |
27
- | [userLabel?](./react/hook/prejoinprops.userlabel.md) | string | _(Optional)_ |
17
+ | Property | Type | Description |
18
+ | ------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
19
+ | [camLabel?](./react/prejoinprops.camlabel.md) | string | _(Optional)_ |
20
+ | [debug?](./react/prejoinprops.debug.md) | boolean | _(Optional)_ Display a debug window for your convenience. |
21
+ | [defaults?](./react/prejoinprops.defaults.md) | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt; | _(Optional)_ Prefill the input form with initial values. |
22
+ | [joinLabel?](./react/prejoinprops.joinlabel.md) | string | _(Optional)_ |
23
+ | [micLabel?](./react/prejoinprops.miclabel.md) | string | _(Optional)_ |
24
+ | [onError?](./react/prejoinprops.onerror.md) | (error: Error) =&gt; void | _(Optional)_ |
25
+ | [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. |
26
+ | [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. |
27
+ | [userLabel?](./react/prejoinprops.userlabel.md) | string | _(Optional)_ |
@@ -10,4 +10,4 @@ This function is called with the `LocalUserChoices` if validation is passed.
10
10
  onSubmit?: (values: LocalUserChoices) => void;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Provide your custom validation function. Only if validation is successful the us
10
10
  onValidate?: (values: LocalUserChoices) => boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -2,8 +2,8 @@
2
2
 
3
3
  ## PreJoinProps.userLabel property
4
4
 
5
- ## Import
5
+ **Signature:**
6
6
 
7
7
  ```typescript
8
- import { userLabel } from '@livekit/components-react';
8
+ userLabel?: string;
9
9
  ```
@@ -8,4 +8,4 @@
8
8
  RoomContext: React.Context<Room | undefined>;
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface RoomNameProps extends React.HTMLAttributes<HTMLSpanElement>
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -8,4 +8,4 @@
8
8
  TrackContext: React.Context<TrackReferenceOrPlaceholder | undefined>;
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ The template component to be used in the loop.
10
10
  children: React.ReactNode;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,7 +8,7 @@
8
8
  export interface TrackLoopProps
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,4 +10,4 @@ Track references to loop over. You can the use `useTracks()` hook to get TrackRe
10
10
  tracks: TrackReference[] | TrackReferenceOrPlaceholder[];
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,7 +10,7 @@ export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.But
10
10
 
11
11
  **Extends:** Omit&lt;React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;, 'onChange'&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -8,7 +8,7 @@
8
8
  export interface UseChatToggleProps
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseFocusToggleProps
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseIsMutedOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseLocalParticipantOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,4 +10,4 @@ The room to use. If not provided, the hook will use the room from the context.
10
10
  room?: Room;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,7 +8,7 @@
8
8
  export interface UseMediaDeviceSelectProps
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,4 +10,4 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
10
10
  requestPermissions?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,7 +8,7 @@
8
8
  export interface UseMediaTrackOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseParticipantInfoOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseParticipantPermissionsOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseParticipantsOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,4 +10,4 @@ The room to use. If not provided, the hook will use the room from the context.
10
10
  room?: Room;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
10
10
  updateOnlyOn?: RoomEvent[];
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React.HT
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;T&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -8,7 +8,7 @@
8
8
  export interface UseRemoteParticipantOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseRemoteParticipantsOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,4 +10,4 @@ The room to use. If not provided, the hook will use the room from the context.
10
10
  room?: Room;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
10
10
  updateOnlyOn?: RoomEvent[];
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,7 +8,7 @@
8
8
  export interface UserInfo
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  export interface UseRoomInfoOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -8,10 +8,10 @@
8
8
  export interface UseTokenOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
15
- | Property | Type | Description |
16
- | ----------------------------------------------------- | ------------------------------- | ------------ |
17
- | [userInfo?](./react/hook/usetokenoptions.userinfo.md) | [UserInfo](./react/userinfo.md) | _(Optional)_ |
15
+ | Property | Type | Description |
16
+ | ------------------------------------------------ | ------------------------------- | ------------ |
17
+ | [userInfo?](./react/usetokenoptions.userinfo.md) | [UserInfo](./react/userinfo.md) | _(Optional)_ |
@@ -2,8 +2,8 @@
2
2
 
3
3
  ## UseTokenOptions.userInfo property
4
4
 
5
- ## Import
5
+ **Signature:**
6
6
 
7
7
  ```typescript
8
- import { userInfo } from '@livekit/components-react';
8
+ userInfo?: UserInfo;
9
9
  ```
@@ -8,7 +8,7 @@
8
8
  export interface UseTrackMutedIndicatorOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -14,4 +14,4 @@ export type UseTracksHookReturnType<T> = T extends Track.Source[]
14
14
 
15
15
  **References:** [TrackReference](./core/trackreference.md)<!-- -->, [TrackSourceWithOptions](./core/tracksourcewithoptions.md)<!-- -->, [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -12,4 +12,4 @@ export type UseTracksOptions = {
12
12
  };
13
13
  ```
14
14
 
15
- {% partial file="p_usage.md" /%}
15
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackT
10
10
 
11
11
  **Extends:** Omit&lt;[TrackToggleProps](./react/tracktoggleprops.md)<!-- -->&lt;T&gt;, 'showIcon'&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Overwrites the default sort function.
10
10
  customSortFunction?: (trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[];
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -8,7 +8,7 @@
8
8
  export interface UseVisualStableUpdateOptions
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Properties
14
14
 
@@ -10,7 +10,7 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16
 
@@ -10,7 +10,7 @@ export interface VideoTrackProps extends React.HTMLAttributes<HTMLVideoElement>
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLVideoElement&gt;
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Properties
16
16