npm - @livekit/components-js-docs - Versions diffs - 0.0.3 → 0.0.4 - Mend

@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

package/generated-docs/core/gettrackreferenceid.md CHANGED Viewed

@@ -12,4 +12,4 @@ export declare function getTrackReferenceId(
 ): string;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/gettrackreferencesource.md CHANGED Viewed

@@ -12,4 +12,4 @@ export declare function getTrackReferenceSource(
 ): Track.Source;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/ismobilebrowser.md CHANGED Viewed

@@ -14,4 +14,4 @@ export declare function isMobileBrowser(): boolean;
 This should only be used if feature detection or other methods do not work!
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/isparticipantsourcepinned.md CHANGED Viewed

@@ -14,4 +14,4 @@ export declare function isParticipantSourcePinned(
 ): boolean;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/istrackreferencepinned.md CHANGED Viewed

@@ -13,4 +13,4 @@ export declare function isTrackReferencePinned(
 ): boolean;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/sendmessage.md CHANGED Viewed

@@ -15,4 +15,4 @@ export declare function sendMessage(
 ): Promise<void>;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/setloglevel.md CHANGED Viewed

@@ -10,4 +10,4 @@ Set the log level for both the `@livekit/components-react` package and the `@liv
 export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/sortparticipants.md CHANGED Viewed

@@ -10,4 +10,4 @@ Default sort for participants, it'll order participants by: 1. local participant
 export declare function sortParticipants(participants: Participant[]): Participant[];
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/sorttrackreferences.md CHANGED Viewed

@@ -12,4 +12,4 @@ export declare function sortTrackReferences(
 ): TrackReferenceOrPlaceholder[];
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/supportsscreensharing.md CHANGED Viewed

@@ -10,4 +10,4 @@ Returns `true` if the browser supports screen sharing.
 export declare function supportsScreenSharing(): boolean;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/trackidentifier.md CHANGED Viewed

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

package/generated-docs/core/updatepages.md CHANGED Viewed

@@ -14,4 +14,4 @@ export declare function updatePages<T extends UpdatableItem>(
 ): T[];
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/allowaudioplaybackprops.md CHANGED Viewed

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

package/generated-docs/react/audioconferenceprops.md CHANGED Viewed

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

package/generated-docs/react/audiotrackprops.md CHANGED Viewed

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

package/generated-docs/react/audiotrackprops.volume.md CHANGED Viewed

@@ -10,4 +10,4 @@ by the default the range is between 0 and 1
 volume?: number;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiovisualizerprops.md CHANGED Viewed

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

package/generated-docs/react/carouselviewprops.md CHANGED Viewed

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

package/generated-docs/react/carouselviewprops.orientation.md CHANGED Viewed

@@ -10,4 +10,4 @@ Place the tiles vertically or horizontally next to each other. If undefined orie
 orientation?: 'vertical' | 'horizontal';
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.entry.md CHANGED Viewed

@@ -10,4 +10,4 @@ The chat massage object to display.
 entry: ReceivedChatMessage;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.hidename.md CHANGED Viewed

@@ -10,4 +10,4 @@ Hide sender name. Useful when displaying multiple consecutive chat messages from
 hideName?: boolean;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.hidetimestamp.md CHANGED Viewed

@@ -10,4 +10,4 @@ Hide message timestamp.
 hideTimestamp?: boolean;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.md CHANGED Viewed

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

package/generated-docs/react/chatentryprops.messageformatter.md CHANGED Viewed

@@ -10,4 +10,4 @@ An optional formatter for the message body.
 messageFormatter?: MessageFormatter;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatprops.md CHANGED Viewed

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

package/generated-docs/react/chattoggleprops.md CHANGED Viewed

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

package/generated-docs/react/clearpinbuttonprops.md CHANGED Viewed

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

package/generated-docs/react/component/audioconference.md CHANGED Viewed

@@ -22,4 +22,4 @@ The component is implemented with other LiveKit components like `FocusContextPro
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/audiotrack.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { AudioTrack } from '@livekit/components-react';
 </ParticipantTile>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/audiovisualizer.md CHANGED Viewed

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

package/generated-docs/react/component/carouselview.md CHANGED Viewed

@@ -19,7 +19,7 @@ const tracks = useTracks();
 </CarouselLayout>;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/chat.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { Chat } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/chatentry.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { ChatEntry } from '@livekit/components-react';
 </Chat>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/chattoggle.md CHANGED Viewed

@@ -18,4 +18,4 @@ import { ChatToggle } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/clearpinbutton.md CHANGED Viewed

@@ -22,4 +22,4 @@ This component works only inside a PinContext.
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/connectionqualityindicator.md CHANGED Viewed

@@ -16,4 +16,4 @@ import { ConnectionQualityIndicator } from '@livekit/components-react';
 <ConnectionQualityIndicator />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/connectionstate.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { ConnectionState } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/connectionstatetoast.md CHANGED Viewed

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

package/generated-docs/react/component/controlbar.md CHANGED Viewed

@@ -22,7 +22,7 @@ This component is build with other LiveKit components like `TrackToggle`<!-- -->
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/disconnectbutton.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { DisconnectButton } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/focuslayout.md CHANGED Viewed

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

package/generated-docs/react/component/focuslayoutcontainer.md CHANGED Viewed

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

package/generated-docs/react/component/focustoggle.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { FocusToggle } from '@livekit/components-react';
 </ParticipantTile>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/gridlayout.md CHANGED Viewed

@@ -20,7 +20,7 @@ import { GridLayout } from '@livekit/components-react';
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/livekitroom.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { LiveKitRoom } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/mediadevicemenu.md CHANGED Viewed

@@ -22,7 +22,7 @@ This component is implemented with the `MediaDeviceSelect` LiveKit components.
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/mediadeviceselect.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { MediaDeviceSelect } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/participantaudiotile.md CHANGED Viewed

@@ -16,7 +16,7 @@ import { ParticipantAudioTile } from '@livekit/components-react';
 <ParticipantAudioTile />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/participantcontextifneeded.md CHANGED Viewed

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

package/generated-docs/react/component/participantloop.md CHANGED Viewed

@@ -23,7 +23,7 @@ const participants = useParticipants();
 <ParticipantLoop />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/participantname.md CHANGED Viewed

@@ -16,4 +16,4 @@ import { ParticipantName } from '@livekit/components-react';
 <ParticipantName />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/participanttile.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { ParticipantTile } from '@livekit/components-react';
 <ParticipantTile {...trackReference} />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/prejoin.md CHANGED Viewed

@@ -20,7 +20,7 @@ This component is independent from the LiveKitRoom component and don't has to be
 <PreJoin />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/roomaudiorenderer.md CHANGED Viewed

@@ -18,4 +18,4 @@ import { RoomAudioRenderer } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/roomname.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { RoomName } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/startaudio.md CHANGED Viewed

@@ -18,7 +18,7 @@ import { StartAudio } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/toast.md CHANGED Viewed

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

package/generated-docs/react/component/trackloop.md CHANGED Viewed

@@ -21,7 +21,7 @@ const tracks = useTracks([Track.Source.Camera]);
 <TrackLoop />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/trackmutedindicator.md CHANGED Viewed

@@ -17,7 +17,7 @@ import { TrackMutedIndicator } from '@livekit/components-react';
 <TrackMutedIndicator source={Track.Source.Microphone} />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/tracktoggle.md CHANGED Viewed

@@ -19,7 +19,7 @@ import { TrackToggle } from '@livekit/components-react';
 </LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/videoconference.md CHANGED Viewed

@@ -22,7 +22,7 @@ The component is implemented with other LiveKit components like `FocusContextPro
 <LiveKitRoom>
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/component/videotrack.md CHANGED Viewed

@@ -16,7 +16,7 @@ import { VideoTrack } from '@livekit/components-react';
 <VideoTrack source={Track.Source.Camera} />
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties

package/generated-docs/react/connectionqualityindicatoroptions.md CHANGED Viewed

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

package/generated-docs/react/connectionqualityindicatorprops.md CHANGED Viewed

@@ -10,4 +10,4 @@ export interface ConnectionQualityIndicatorProps extends React.HTMLAttributes<HT
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/connectionstatetoastprops.md CHANGED Viewed

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

package/generated-docs/react/connectionstatusprops.md CHANGED Viewed

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

package/generated-docs/react/connectionstatusprops.room.md CHANGED Viewed

@@ -10,4 +10,4 @@ The room from which the connection status should be displayed.
 room?: Room;
 ```
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/controlbarcontrols.md CHANGED Viewed

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

package/generated-docs/react/controlbarprops.md CHANGED Viewed

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

package/generated-docs/react/disconnectbuttonprops.md CHANGED Viewed

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