@livekit/components-js-docs 0.0.3 → 0.0.5

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 (202) hide show
  1. package/generated-docs/core/encryptionstatusobservable.md +12 -0
  2. package/generated-docs/core/gettrackreferenceid.md +1 -1
  3. package/generated-docs/core/gettrackreferencesource.md +1 -1
  4. package/generated-docs/core/index.md +1 -0
  5. package/generated-docs/core/ismobilebrowser.md +1 -1
  6. package/generated-docs/core/isparticipantsourcepinned.md +1 -1
  7. package/generated-docs/core/istrackreferencepinned.md +1 -1
  8. package/generated-docs/core/sendmessage.md +1 -1
  9. package/generated-docs/core/setloglevel.md +1 -1
  10. package/generated-docs/core/sortparticipants.md +1 -1
  11. package/generated-docs/core/sorttrackreferences.md +1 -1
  12. package/generated-docs/core/supportsscreensharing.md +1 -1
  13. package/generated-docs/core/trackidentifier.md +1 -1
  14. package/generated-docs/core/updatepages.md +1 -1
  15. package/generated-docs/react/allowaudioplaybackprops.md +1 -1
  16. package/generated-docs/react/audioconferenceprops.md +1 -1
  17. package/generated-docs/react/audiotrackprops.md +1 -1
  18. package/generated-docs/react/audiotrackprops.volume.md +1 -1
  19. package/generated-docs/react/audiovisualizerprops.md +1 -1
  20. package/generated-docs/react/carouselviewprops.md +1 -1
  21. package/generated-docs/react/carouselviewprops.orientation.md +1 -1
  22. package/generated-docs/react/chatentryprops.entry.md +1 -1
  23. package/generated-docs/react/chatentryprops.hidename.md +1 -1
  24. package/generated-docs/react/chatentryprops.hidetimestamp.md +1 -1
  25. package/generated-docs/react/chatentryprops.md +1 -1
  26. package/generated-docs/react/chatentryprops.messageformatter.md +1 -1
  27. package/generated-docs/react/chatprops.md +1 -1
  28. package/generated-docs/react/chattoggleprops.md +1 -1
  29. package/generated-docs/react/clearpinbuttonprops.md +1 -1
  30. package/generated-docs/react/component/audioconference.md +1 -1
  31. package/generated-docs/react/component/audiotrack.md +1 -1
  32. package/generated-docs/react/component/audiovisualizer.md +1 -1
  33. package/generated-docs/react/component/carouselview.md +1 -1
  34. package/generated-docs/react/component/chat.md +1 -1
  35. package/generated-docs/react/component/chatentry.md +1 -1
  36. package/generated-docs/react/component/chattoggle.md +1 -1
  37. package/generated-docs/react/component/clearpinbutton.md +1 -1
  38. package/generated-docs/react/component/connectionqualityindicator.md +1 -1
  39. package/generated-docs/react/component/connectionstate.md +1 -1
  40. package/generated-docs/react/component/connectionstatetoast.md +1 -1
  41. package/generated-docs/react/component/controlbar.md +1 -1
  42. package/generated-docs/react/component/disconnectbutton.md +1 -1
  43. package/generated-docs/react/component/focuslayout.md +1 -1
  44. package/generated-docs/react/component/focuslayoutcontainer.md +1 -1
  45. package/generated-docs/react/component/focustoggle.md +1 -1
  46. package/generated-docs/react/component/gridlayout.md +1 -1
  47. package/generated-docs/react/component/livekitroom.md +1 -1
  48. package/generated-docs/react/component/mediadevicemenu.md +1 -1
  49. package/generated-docs/react/component/mediadeviceselect.md +1 -1
  50. package/generated-docs/react/component/participantaudiotile.md +1 -1
  51. package/generated-docs/react/component/participantcontextifneeded.md +1 -1
  52. package/generated-docs/react/component/participantloop.md +1 -1
  53. package/generated-docs/react/component/participantname.md +1 -1
  54. package/generated-docs/react/component/participanttile.md +1 -1
  55. package/generated-docs/react/component/prejoin.md +1 -1
  56. package/generated-docs/react/component/roomaudiorenderer.md +1 -1
  57. package/generated-docs/react/component/roomname.md +1 -1
  58. package/generated-docs/react/component/startaudio.md +1 -1
  59. package/generated-docs/react/component/toast.md +1 -1
  60. package/generated-docs/react/component/trackloop.md +1 -1
  61. package/generated-docs/react/component/trackmutedindicator.md +1 -1
  62. package/generated-docs/react/component/tracktoggle.md +1 -1
  63. package/generated-docs/react/component/videoconference.md +1 -1
  64. package/generated-docs/react/component/videotrack.md +1 -1
  65. package/generated-docs/react/connectionqualityindicatoroptions.md +1 -1
  66. package/generated-docs/react/connectionqualityindicatorprops.md +1 -1
  67. package/generated-docs/react/connectionstatetoastprops.md +1 -1
  68. package/generated-docs/react/connectionstatusprops.md +1 -1
  69. package/generated-docs/react/connectionstatusprops.room.md +1 -1
  70. package/generated-docs/react/controlbarcontrols.md +1 -1
  71. package/generated-docs/react/controlbarprops.md +1 -1
  72. package/generated-docs/react/disconnectbuttonprops.md +1 -1
  73. package/generated-docs/react/focuslayoutcontainerprops.md +1 -1
  74. package/generated-docs/react/focuslayoutprops.md +1 -1
  75. package/generated-docs/react/focustoggleprops.md +1 -1
  76. package/generated-docs/react/formatchatmessagelinks.md +11 -0
  77. package/generated-docs/react/gridlayoutprops.md +1 -1
  78. package/generated-docs/react/hook/usechat.md +8 -2
  79. package/generated-docs/react/hook/usechattoggle.md +11 -2
  80. package/generated-docs/react/hook/useclearpinbutton.md +10 -2
  81. package/generated-docs/react/hook/useconnectionqualityindicator.md +64 -2
  82. package/generated-docs/react/hook/useconnectionstate.md +4 -2
  83. package/generated-docs/react/hook/usecreatelayoutcontext.md +4 -2
  84. package/generated-docs/react/hook/usedatachannel.md +4 -2
  85. package/generated-docs/react/hook/usedatachannel_1.md +4 -2
  86. package/generated-docs/react/hook/usedisconnectbutton.md +10 -2
  87. package/generated-docs/react/hook/useensurecreatelayoutcontext.md +4 -2
  88. package/generated-docs/react/hook/useensurelayoutcontext.md +4 -2
  89. package/generated-docs/react/hook/useensureparticipant.md +4 -2
  90. package/generated-docs/react/hook/useensureroom.md +4 -2
  91. package/generated-docs/react/hook/useensuretrackreference.md +4 -2
  92. package/generated-docs/react/hook/usefocustoggle.md +10 -2
  93. package/generated-docs/react/hook/usegridlayout.md +6 -2
  94. package/generated-docs/react/hook/useismuted.md +4 -2
  95. package/generated-docs/react/hook/useisspeaking.md +4 -2
  96. package/generated-docs/react/hook/uselayoutcontext.md +4 -2
  97. package/generated-docs/react/hook/uselivekitroom.md +7 -2
  98. package/generated-docs/react/hook/uselocalparticipant.md +13 -2
  99. package/generated-docs/react/hook/uselocalparticipantpermissions.md +4 -2
  100. package/generated-docs/react/hook/usemaybelayoutcontext.md +4 -2
  101. package/generated-docs/react/hook/usemaybeparticipantcontext.md +4 -2
  102. package/generated-docs/react/hook/usemayberoomcontext.md +4 -2
  103. package/generated-docs/react/hook/usemaybetrackcontext.md +4 -2
  104. package/generated-docs/react/hook/usemediadevices.md +4 -2
  105. package/generated-docs/react/hook/usemediadeviceselect.md +9 -2
  106. package/generated-docs/react/hook/usemediatrack.md +10 -2
  107. package/generated-docs/react/hook/usemediatrackbyname.md +10 -2
  108. package/generated-docs/react/hook/useparticipantcontext.md +4 -2
  109. package/generated-docs/react/hook/useparticipantinfo.md +8 -2
  110. package/generated-docs/react/hook/useparticipantpermissions.md +4 -2
  111. package/generated-docs/react/hook/useparticipants.md +4 -2
  112. package/generated-docs/react/hook/useparticipanttile.md +6 -2
  113. package/generated-docs/react/hook/usepinnedtracks.md +4 -2
  114. package/generated-docs/react/hook/usepreviewdevice.md +8 -2
  115. package/generated-docs/react/hook/useremoteparticipant.md +4 -2
  116. package/generated-docs/react/hook/useremoteparticipants.md +4 -2
  117. package/generated-docs/react/hook/useroomcontext.md +4 -2
  118. package/generated-docs/react/hook/useroominfo.md +7 -2
  119. package/generated-docs/react/hook/usesortedparticipants.md +4 -2
  120. package/generated-docs/react/hook/usespeakingparticipants.md +4 -2
  121. package/generated-docs/react/hook/usetoken.md +4 -2
  122. package/generated-docs/react/hook/usetrackcontext.md +4 -2
  123. package/generated-docs/react/hook/usetrackmutedindicator.md +7 -2
  124. package/generated-docs/react/hook/usetracks.md +4 -2
  125. package/generated-docs/react/hook/usetracktoggle.md +10 -2
  126. package/generated-docs/react/hook/usevisualstableupdate.md +4 -2
  127. package/generated-docs/react/index.md +1 -1
  128. package/generated-docs/react/layoutcontext.md +1 -1
  129. package/generated-docs/react/layoutcontexttype.md +1 -1
  130. package/generated-docs/react/livekitroomprops.audio.md +1 -1
  131. package/generated-docs/react/livekitroomprops.connect.md +1 -1
  132. package/generated-docs/react/livekitroomprops.connectoptions.md +1 -1
  133. package/generated-docs/react/livekitroomprops.md +1 -1
  134. package/generated-docs/react/livekitroomprops.options.md +1 -1
  135. package/generated-docs/react/livekitroomprops.room.md +1 -1
  136. package/generated-docs/react/livekitroomprops.screen.md +1 -1
  137. package/generated-docs/react/livekitroomprops.serverurl.md +1 -1
  138. package/generated-docs/react/livekitroomprops.token.md +1 -1
  139. package/generated-docs/react/livekitroomprops.video.md +1 -1
  140. package/generated-docs/react/localuserchoices.md +1 -1
  141. package/generated-docs/react/mediadevicemenuprops.md +1 -1
  142. package/generated-docs/react/mediadevicemenuprops.requestpermissions.md +1 -1
  143. package/generated-docs/react/mediadeviceselectprops.exactmatch.md +1 -1
  144. package/generated-docs/react/mediadeviceselectprops.md +1 -1
  145. package/generated-docs/react/mediadeviceselectprops.requestpermissions.md +1 -1
  146. package/generated-docs/react/messagedecoder.md +1 -1
  147. package/generated-docs/react/messageencoder.md +1 -1
  148. package/generated-docs/react/messageformatter.md +1 -1
  149. package/generated-docs/react/meta-data.json +1 -0
  150. package/generated-docs/react/participantcontext.md +1 -1
  151. package/generated-docs/react/participantloopprops.children.md +1 -1
  152. package/generated-docs/react/participantloopprops.md +1 -1
  153. package/generated-docs/react/participantloopprops.participants.md +1 -1
  154. package/generated-docs/react/participantnameprops.md +1 -1
  155. package/generated-docs/react/participanttileprops.md +1 -1
  156. package/generated-docs/react/prejoinprops.debug.md +1 -1
  157. package/generated-docs/react/prejoinprops.defaults.md +1 -1
  158. package/generated-docs/react/prejoinprops.md +12 -12
  159. package/generated-docs/react/prejoinprops.onsubmit.md +1 -1
  160. package/generated-docs/react/prejoinprops.onvalidate.md +1 -1
  161. package/generated-docs/react/{hook/prejoinprops.userlabel.md → prejoinprops.userlabel.md} +2 -2
  162. package/generated-docs/react/roomcontext.md +1 -1
  163. package/generated-docs/react/roomnameprops.md +1 -1
  164. package/generated-docs/react/trackcontext.md +1 -1
  165. package/generated-docs/react/trackloopprops.children.md +1 -1
  166. package/generated-docs/react/trackloopprops.md +1 -1
  167. package/generated-docs/react/trackloopprops.tracks.md +1 -1
  168. package/generated-docs/react/trackmutedindicatorprops.md +1 -1
  169. package/generated-docs/react/tracktoggleprops.md +1 -1
  170. package/generated-docs/react/usechattoggleprops.md +1 -1
  171. package/generated-docs/react/usefocustoggleprops.md +1 -1
  172. package/generated-docs/react/useismutedoptions.md +1 -1
  173. package/generated-docs/react/uselocalparticipantoptions.md +1 -1
  174. package/generated-docs/react/uselocalparticipantoptions.room.md +1 -1
  175. package/generated-docs/react/usemediadeviceselectprops.md +1 -1
  176. package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md +1 -1
  177. package/generated-docs/react/usemediatrackoptions.md +1 -1
  178. package/generated-docs/react/useparticipantinfooptions.md +1 -1
  179. package/generated-docs/react/useparticipantpermissionsoptions.md +1 -1
  180. package/generated-docs/react/useparticipantsoptions.md +1 -1
  181. package/generated-docs/react/useparticipantsoptions.room.md +1 -1
  182. package/generated-docs/react/useparticipantsoptions.updateonlyon.md +1 -1
  183. package/generated-docs/react/useparticipanttileprops.md +1 -1
  184. package/generated-docs/react/useremoteparticipantoptions.md +1 -1
  185. package/generated-docs/react/useremoteparticipantsoptions.md +1 -1
  186. package/generated-docs/react/useremoteparticipantsoptions.room.md +1 -1
  187. package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md +1 -1
  188. package/generated-docs/react/userinfo.md +1 -1
  189. package/generated-docs/react/useroominfooptions.md +1 -1
  190. package/generated-docs/react/usetokenoptions.md +4 -4
  191. package/generated-docs/react/{hook/usetokenoptions.userinfo.md → usetokenoptions.userinfo.md} +2 -2
  192. package/generated-docs/react/usetrackmutedindicatoroptions.md +1 -1
  193. package/generated-docs/react/usetrackshookreturntype.md +1 -1
  194. package/generated-docs/react/usetracksoptions.md +1 -1
  195. package/generated-docs/react/usetracktoggleprops.md +1 -1
  196. package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md +1 -1
  197. package/generated-docs/react/usevisualstableupdateoptions.md +1 -1
  198. package/generated-docs/react/videoconferenceprops.md +1 -1
  199. package/generated-docs/react/videotrackprops.md +1 -1
  200. package/package.json +1 -1
  201. package/generated-docs/react/component/formatchatmessagelinks.md +0 -11
  202. package/meta-data.json +0 -78
@@ -8,7 +8,7 @@
8
8
  import { useMediaTrack } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -23,4 +23,12 @@ import { useMediaTrack } from '@livekit/components-react';
23
23
 
24
24
  ## Returns
25
25
 
26
- `{ publication: import("livekit-client").TrackPublication | undefined; isMuted: boolean | undefined; isSubscribed: boolean | undefined; track: import("livekit-client").Track | undefined; elementProps: React.HTMLAttributes<HTMLElement>; }`
26
+ ```typescript
27
+ {
28
+ publication: import('livekit-client').TrackPublication | undefined;
29
+ isMuted: boolean | undefined;
30
+ isSubscribed: boolean | undefined;
31
+ track: import('livekit-client').Track | undefined;
32
+ elementProps: React.HTMLAttributes<HTMLElement>;
33
+ }
34
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useMediaTrackByName } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -23,4 +23,12 @@ import { useMediaTrackByName } from '@livekit/components-react';
23
23
 
24
24
  ## Returns
25
25
 
26
- `{ publication: import("livekit-client").TrackPublication | undefined; isMuted: boolean | undefined; isSubscribed: boolean | undefined; track: import("livekit-client").Track | undefined; elementProps: import("react").HTMLAttributes<HTMLElement>; }`
26
+ ```typescript
27
+ {
28
+ publication: import('livekit-client').TrackPublication | undefined;
29
+ isMuted: boolean | undefined;
30
+ isSubscribed: boolean | undefined;
31
+ track: import('livekit-client').Track | undefined;
32
+ elementProps: import('react').HTMLAttributes<HTMLElement>;
33
+ }
34
+ ```
@@ -10,8 +10,10 @@ Ensures that a participant is provided via context. If not inside a `Participant
10
10
  import { useParticipantContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Returns
16
16
 
17
- `Participant`
17
+ ```typescript
18
+ Participant;
19
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useParticipantInfo } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -17,4 +17,10 @@ import { useParticipantInfo } from '@livekit/components-react';
17
17
 
18
18
  ## Returns
19
19
 
20
- `{ identity: string; name: string | undefined; metadata: string | undefined; }`
20
+ ```typescript
21
+ {
22
+ identity: string;
23
+ name: string | undefined;
24
+ metadata: string | undefined;
25
+ }
26
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useParticipantPermissions } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -17,4 +17,6 @@ import { useParticipantPermissions } from '@livekit/components-react';
17
17
 
18
18
  ## Returns
19
19
 
20
- `import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined`
20
+ ```typescript
21
+ import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined;
22
+ ```
@@ -10,7 +10,7 @@ The useParticipants hook returns all participants (local and remote) of the curr
10
10
  import { useParticipants } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
@@ -19,4 +19,6 @@ import { useParticipants } from '@livekit/components-react';
19
19
 
20
20
  ## Returns
21
21
 
22
- `(import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]`
22
+ ```typescript
23
+ (import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]
24
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useParticipantTile } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -17,4 +17,8 @@ import { useParticipantTile } from '@livekit/components-react';
17
17
 
18
18
  ## Returns
19
19
 
20
- `{ elementProps: React.HTMLAttributes<T>; }`
20
+ ```typescript
21
+ {
22
+ elementProps: React.HTMLAttributes<T>;
23
+ }
24
+ ```
@@ -8,7 +8,7 @@
8
8
  import { usePinnedTracks } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -17,4 +17,6 @@ import { usePinnedTracks } from '@livekit/components-react';
17
17
 
18
18
  ## Returns
19
19
 
20
- `TrackReferenceOrPlaceholder[]`
20
+ ```typescript
21
+ TrackReferenceOrPlaceholder[]
22
+ ```
@@ -8,7 +8,7 @@
8
8
  import { usePreviewDevice } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -23,4 +23,10 @@ import { usePreviewDevice } from '@livekit/components-react';
23
23
 
24
24
  ## Returns
25
25
 
26
- `{ selectedDevice: MediaDeviceInfo | undefined; localTrack: T | undefined; deviceError: Error | null; }`
26
+ ```typescript
27
+ {
28
+ selectedDevice: MediaDeviceInfo | undefined;
29
+ localTrack: T | undefined;
30
+ deviceError: Error | null;
31
+ }
32
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useRemoteParticipant } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -20,4 +20,6 @@ import { useRemoteParticipant } from '@livekit/components-react';
20
20
 
21
21
  ## Returns
22
22
 
23
- `RemoteParticipant | undefined`
23
+ ```typescript
24
+ RemoteParticipant | undefined;
25
+ ```
@@ -10,7 +10,7 @@ The useRemoteParticipants
10
10
  import { useRemoteParticipants } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
@@ -19,4 +19,6 @@ import { useRemoteParticipants } from '@livekit/components-react';
19
19
 
20
20
  ## Returns
21
21
 
22
- `RemoteParticipant[]`
22
+ ```typescript
23
+ RemoteParticipant[]
24
+ ```
@@ -10,8 +10,10 @@ Ensures that a room is provided via context. If no room is provided, an error is
10
10
  import { useRoomContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Returns
16
16
 
17
- `Room`
17
+ ```typescript
18
+ Room;
19
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useRoomInfo } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -17,4 +17,9 @@ import { useRoomInfo } from '@livekit/components-react';
17
17
 
18
18
  ## Returns
19
19
 
20
- `{ name: string; metadata: string | undefined; }`
20
+ ```typescript
21
+ {
22
+ name: string;
23
+ metadata: string | undefined;
24
+ }
25
+ ```
@@ -10,7 +10,7 @@ The useSortedParticipants hook returns the only the active speakers of all parti
10
10
  import { useSortedParticipants } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Parameters
16
16
 
@@ -19,4 +19,6 @@ import { useSortedParticipants } from '@livekit/components-react';
19
19
 
20
20
  ## Returns
21
21
 
22
- `Participant[]`
22
+ ```typescript
23
+ Participant[]
24
+ ```
@@ -10,8 +10,10 @@ The useSpeakingParticipants hook returns the only the active speakers of all par
10
10
  import { useSpeakingParticipants } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Returns
16
16
 
17
- `import("livekit-client").Participant[]`
17
+ ```typescript
18
+ import("livekit-client").Participant[]
19
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useToken } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -23,4 +23,6 @@ import { useToken } from '@livekit/components-react';
23
23
 
24
24
  ## Returns
25
25
 
26
- `string | undefined`
26
+ ```typescript
27
+ string | undefined;
28
+ ```
@@ -10,8 +10,10 @@ Ensures that a track reference is provided via context. If not inside a `TrackCo
10
10
  import { useTrackContext } from '@livekit/components-react';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
14
14
 
15
15
  ## Returns
16
16
 
17
- `TrackReferenceOrPlaceholder`
17
+ ```typescript
18
+ TrackReferenceOrPlaceholder;
19
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useTrackMutedIndicator } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -20,4 +20,9 @@ import { useTrackMutedIndicator } from '@livekit/components-react';
20
20
 
21
21
  ## Returns
22
22
 
23
- `{ isMuted: boolean; className: string; }`
23
+ ```typescript
24
+ {
25
+ isMuted: boolean;
26
+ className: string;
27
+ }
28
+ ```
@@ -27,7 +27,7 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
27
27
  ]);
28
28
  ```
29
29
 
30
- {% partial file="p_usage.md" /%}
30
+ {% partial file="p_usage.md" variables={exampleCount: 2} /%}
31
31
 
32
32
  ## Parameters
33
33
 
@@ -39,4 +39,6 @@ const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks
39
39
 
40
40
  ## Returns
41
41
 
42
- `UseTracksHookReturnType<T>`
42
+ ```typescript
43
+ UseTracksHookReturnType<T>;
44
+ ```
@@ -8,7 +8,7 @@
8
8
  import { useTrackToggle } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
12
12
 
13
13
  ## Parameters
14
14
 
@@ -17,4 +17,12 @@ import { useTrackToggle } from '@livekit/components-react';
17
17
 
18
18
  ## Returns
19
19
 
20
- `{ toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>); enabled: boolean; pending: boolean; track: import("livekit-client").LocalTrackPublication | undefined; buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>; }`
20
+ ```typescript
21
+ {
22
+ toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>);
23
+ enabled: boolean;
24
+ pending: boolean;
25
+ track: import("livekit-client").LocalTrackPublication | undefined;
26
+ buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
27
+ }
28
+ ```
@@ -14,7 +14,7 @@ Updating works with pagination. For example, if a participant starts speaking on
14
14
  import { useVisualStableUpdate } from '@livekit/components-react';
15
15
  ```
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
18
18
 
19
19
  ## Parameters
20
20
 
@@ -29,4 +29,6 @@ import { useVisualStableUpdate } from '@livekit/components-react';
29
29
 
30
30
  ## Returns
31
31
 
32
- `TrackReferenceOrPlaceholder[]`
32
+ ```typescript
33
+ TrackReferenceOrPlaceholder[]
34
+ ```
@@ -19,7 +19,6 @@
19
19
  | [FocusLayout({ track, ...htmlProps })](./react/component/focuslayout.md) | |
20
20
  | [FocusLayoutContainer(props)](./react/component/focuslayoutcontainer.md) | |
21
21
  | [FocusToggle({ trackSource, participant, ...props })](./react/component/focustoggle.md) | The FocusToggle puts the ParticipantTile in focus or removes it from focus. |
22
- | [formatChatMessageLinks(message)](./react/component/formatchatmessagelinks.md) | |
23
22
  | [GridLayout({ tracks, ...props })](./react/component/gridlayout.md) | The GridLayout component displays the nested participants in a grid where every participants has the same size. |
24
23
  | [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. |
25
24
  | [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 @@
125
124
  | [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
126
125
  | [FocusLayoutProps](./react/focuslayoutprops.md) | |
127
126
  | [FocusToggleProps](./react/focustoggleprops.md) | |
127
+ | [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
128
128
  | [GridLayoutProps](./react/gridlayoutprops.md) | |
129
129
  | [LayoutContext](./react/layoutcontext.md) | |
130
130
  | [LayoutContextType](./react/layoutcontexttype.md) | |
@@ -8,4 +8,4 @@
8
8
  LayoutContext: React.Context<LayoutContextType | undefined>;
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -11,4 +11,4 @@ export type LayoutContextType = {
11
11
  };
12
12
  ```
13
13
 
14
- {% partial file="p_usage.md" /%}
14
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Publish audio immediately after connecting to your LiveKit room.
10
10
  audio?: AudioCaptureOptions | boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ If set to true a connection to LiveKit room is initiated.
10
10
  connect?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Define options how to connect to the LiveKit server.
10
10
  connectOptions?: RoomConnectOptions;
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 LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
10
10
 
11
11
  **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, '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
 
@@ -10,4 +10,4 @@ Options for when creating a new room. When you pass your own room instance to th
10
10
  options?: RoomOptions;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -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} /%}