@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
@@ -0,0 +1,12 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ # encryptionStatusObservable
4
+
5
+ **Signature:**
6
+
7
+ ```typescript
8
+ export declare function encryptionStatusObservable(
9
+ room: Room,
10
+ participant: Participant,
11
+ ): Observable<boolean>;
12
+ ```
@@ -12,4 +12,4 @@ export declare function getTrackReferenceId(
12
12
  ): string;
13
13
  ```
14
14
 
15
- {% partial file="p_usage.md" /%}
15
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -12,4 +12,4 @@ export declare function getTrackReferenceSource(
12
12
  ): Track.Source;
13
13
  ```
14
14
 
15
- {% partial file="p_usage.md" /%}
15
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -32,6 +32,7 @@
32
32
  | [cssPrefix](./core/cssprefix.md) | |
33
33
  | [DataSendOptions](./core/datasendoptions.md) | |
34
34
  | [DataTopic](./core/datatopic.md) | |
35
+ | [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md) | |
35
36
  | [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md) | |
36
37
  | [getTrackReferenceId(trackReference)](./core/gettrackreferenceid.md) | Returns a id to identify the <code>TrackReference</code> based on participant and source. |
37
38
  | [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md) | Returns the Source of the TrackReference. |
@@ -14,4 +14,4 @@ export declare function isMobileBrowser(): boolean;
14
14
 
15
15
  This should only be used if feature detection or other methods do not work!
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -14,4 +14,4 @@ export declare function isParticipantSourcePinned(
14
14
  ): boolean;
15
15
  ```
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -13,4 +13,4 @@ export declare function isTrackReferencePinned(
13
13
  ): boolean;
14
14
  ```
15
15
 
16
- {% partial file="p_usage.md" /%}
16
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -15,4 +15,4 @@ export declare function sendMessage(
15
15
  ): Promise<void>;
16
16
  ```
17
17
 
18
- {% partial file="p_usage.md" /%}
18
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Set the log level for both the `@livekit/components-react` package and the `@liv
10
10
  export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Default sort for participants, it'll order participants by: 1. local participant
10
10
  export declare function sortParticipants(participants: Participant[]): Participant[];
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -12,4 +12,4 @@ export declare function sortTrackReferences(
12
12
  ): TrackReferenceOrPlaceholder[];
13
13
  ```
14
14
 
15
- {% partial file="p_usage.md" /%}
15
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Returns `true` if the browser supports screen sharing.
10
10
  export declare function supportsScreenSharing(): 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 TrackIdentifier<T extends Track.Source = Track.Source> =
14
14
 
15
15
  **References:** [TrackSource](./core/tracksource.md)<!-- -->, [TrackReference](./core/trackreference.md)
16
16
 
17
- {% partial file="p_usage.md" /%}
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -14,4 +14,4 @@ export declare function updatePages<T extends UpdatableItem>(
14
14
  ): T[];
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 AllowAudioPlaybackProps extends React.ButtonHTMLAttributes<HTML
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 @@ export interface AudioConferenceProps 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} /%}
@@ -10,7 +10,7 @@ export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement>
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
 
@@ -10,4 +10,4 @@ by the default the range is between 0 and 1
10
10
  volume?: number;
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 AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;SVGElement&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 CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaEleme
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLMediaElement&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 @@ Place the tiles vertically or horizontally next to each other. If undefined orie
10
10
  orientation?: 'vertical' | 'horizontal';
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ The chat massage object to display.
10
10
  entry: ReceivedChatMessage;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Hide sender name. Useful when displaying multiple consecutive chat messages from
10
10
  hideName?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,4 +10,4 @@ Hide message timestamp.
10
10
  hideTimestamp?: boolean;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -12,7 +12,7 @@ export interface ChatEntryProps extends React.HTMLAttributes<HTMLLIElement>
12
12
 
13
13
  **Extends:** React.HTMLAttributes&lt;HTMLLIElement&gt;
14
14
 
15
- {% partial file="p_usage.md" /%}
15
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
16
16
 
17
17
  ## Properties
18
18
 
@@ -10,4 +10,4 @@ An optional formatter for the message body.
10
10
  messageFormatter?: MessageFormatter;
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 ChatProps extends React.HTMLAttributes<HTMLDivElement>
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 @@ export interface ChatToggleProps extends React.ButtonHTMLAttributes<HTMLButtonEl
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} /%}
@@ -10,4 +10,4 @@ export interface ClearPinButtonProps extends React.ButtonHTMLAttributes<HTMLButt
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} /%}
@@ -22,4 +22,4 @@ The component is implemented with other LiveKit components like `FocusContextPro
22
22
  <LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -18,7 +18,7 @@ import { AudioTrack } from '@livekit/components-react';
18
18
  </ParticipantTile>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -8,7 +8,7 @@
8
8
  import { AudioVisualizer } 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
  ## Properties
14
14
 
@@ -19,7 +19,7 @@ const tracks = useTracks();
19
19
  </CarouselLayout>;
20
20
  ```
21
21
 
22
- {% partial file="p_usage.md" /%}
22
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
23
23
 
24
24
  ## Properties
25
25
 
@@ -18,7 +18,7 @@ import { Chat } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -18,7 +18,7 @@ import { ChatEntry } from '@livekit/components-react';
18
18
  </Chat>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -18,4 +18,4 @@ import { ChatToggle } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -22,4 +22,4 @@ This component works only inside a PinContext.
22
22
  </LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -16,4 +16,4 @@ import { ConnectionQualityIndicator } from '@livekit/components-react';
16
16
  <ConnectionQualityIndicator />
17
17
  ```
18
18
 
19
- {% partial file="p_usage.md" /%}
19
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -18,7 +18,7 @@ import { ConnectionState } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -8,7 +8,7 @@
8
8
  import { ConnectionStateToast } 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
  ## Properties
14
14
 
@@ -22,7 +22,7 @@ This component is build with other LiveKit components like `TrackToggle`<!-- -->
22
22
  </LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
26
26
 
27
27
  ## Properties
28
28
 
@@ -18,7 +18,7 @@ import { DisconnectButton } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -8,7 +8,7 @@
8
8
  import { FocusLayout } 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
  ## Properties
14
14
 
@@ -8,7 +8,7 @@
8
8
  import { FocusLayoutContainer } 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
  ## Properties
14
14
 
@@ -18,7 +18,7 @@ import { FocusToggle } from '@livekit/components-react';
18
18
  </ParticipantTile>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -20,7 +20,7 @@ import { GridLayout } from '@livekit/components-react';
20
20
  <LiveKitRoom>
21
21
  ```
22
22
 
23
- {% partial file="p_usage.md" /%}
23
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
24
24
 
25
25
  ## Properties
26
26
 
@@ -18,7 +18,7 @@ import { LiveKitRoom } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -22,7 +22,7 @@ This component is implemented with the `MediaDeviceSelect` LiveKit components.
22
22
  </LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
26
26
 
27
27
  ## Properties
28
28
 
@@ -18,7 +18,7 @@ import { MediaDeviceSelect } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -16,7 +16,7 @@ import { ParticipantAudioTile } from '@livekit/components-react';
16
16
  <ParticipantAudioTile />
17
17
  ```
18
18
 
19
- {% partial file="p_usage.md" /%}
19
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
20
20
 
21
21
  ## Properties
22
22
 
@@ -8,4 +8,4 @@
8
8
  import { ParticipantContextIfNeeded } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -23,7 +23,7 @@ const participants = useParticipants();
23
23
  <ParticipantLoop />
24
24
  ```
25
25
 
26
- {% partial file="p_usage.md" /%}
26
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
27
27
 
28
28
  ## Properties
29
29
 
@@ -16,4 +16,4 @@ import { ParticipantName } from '@livekit/components-react';
16
16
  <ParticipantName />
17
17
  ```
18
18
 
19
- {% partial file="p_usage.md" /%}
19
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -18,7 +18,7 @@ import { ParticipantTile } from '@livekit/components-react';
18
18
  <ParticipantTile {...trackReference} />
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -20,7 +20,7 @@ This component is independent from the LiveKitRoom component and don't has to be
20
20
  <PreJoin />
21
21
  ```
22
22
 
23
- {% partial file="p_usage.md" /%}
23
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
24
24
 
25
25
  ## Properties
26
26
 
@@ -18,4 +18,4 @@ import { RoomAudioRenderer } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
@@ -18,7 +18,7 @@ import { RoomName } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -18,7 +18,7 @@ import { StartAudio } from '@livekit/components-react';
18
18
  </LiveKitRoom>
19
19
  ```
20
20
 
21
- {% partial file="p_usage.md" /%}
21
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
22
22
 
23
23
  ## Properties
24
24
 
@@ -8,4 +8,4 @@
8
8
  import { Toast } from '@livekit/components-react';
9
9
  ```
10
10
 
11
- {% partial file="p_usage.md" /%}
11
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -21,7 +21,7 @@ const tracks = useTracks([Track.Source.Camera]);
21
21
  <TrackLoop />
22
22
  ```
23
23
 
24
- {% partial file="p_usage.md" /%}
24
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
25
25
 
26
26
  ## Properties
27
27
 
@@ -17,7 +17,7 @@ import { TrackMutedIndicator } from '@livekit/components-react';
17
17
  <TrackMutedIndicator source={Track.Source.Microphone} />
18
18
  ```
19
19
 
20
- {% partial file="p_usage.md" /%}
20
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
21
21
 
22
22
  ## Properties
23
23
 
@@ -19,7 +19,7 @@ import { TrackToggle } from '@livekit/components-react';
19
19
  </LiveKitRoom>
20
20
  ```
21
21
 
22
- {% partial file="p_usage.md" /%}
22
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
23
23
 
24
24
  ## Properties
25
25
 
@@ -22,7 +22,7 @@ The component is implemented with other LiveKit components like `FocusContextPro
22
22
  <LiveKitRoom>
23
23
  ```
24
24
 
25
- {% partial file="p_usage.md" /%}
25
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
26
26
 
27
27
  ## Properties
28
28
 
@@ -16,7 +16,7 @@ import { VideoTrack } from '@livekit/components-react';
16
16
  <VideoTrack source={Track.Source.Camera} />
17
17
  ```
18
18
 
19
- {% partial file="p_usage.md" /%}
19
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
20
20
 
21
21
  ## Properties
22
22
 
@@ -8,7 +8,7 @@
8
8
  export interface ConnectionQualityIndicatorOptions
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 @@ export interface ConnectionQualityIndicatorProps extends React.HTMLAttributes<HT
10
10
 
11
11
  **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
@@ -10,7 +10,7 @@ export interface ConnectionStateToastProps extends React.HTMLAttributes<HTMLDivE
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 ConnectionStatusProps extends React.HTMLAttributes<HTMLDivEleme
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 @@ The room from which the connection status should be displayed.
10
10
  room?: Room;
11
11
  ```
12
12
 
13
- {% partial file="p_usage.md" /%}
13
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}