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

@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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "scripts": {
     "yalc:publish": "yalc publish --private --push --replace",

package/generated-docs/react/component/formatchatmessagelinks.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-# formatChatMessageLinks
-## Import
-```typescript
-import { formatChatMessageLinks } from '@livekit/components-react';
-```
-{% partial file="p_usage.md" /%}

package/meta-data.json DELETED Viewed

@@ -1,78 +0,0 @@
-{
-  "react": {
-    "allComponents": [
-      "AudioConference",
-      "AudioTrack",
-      "AudioVisualizer",
-      "CarouselView",
-      "Chat",
-      "ChatEntry",
-      "ChatToggle",
-      "ClearPinButton",
-      "ConnectionStateToast",
-      "Controlbar",
-      "DisconnectButton",
-      "FocusLayout",
-      "FocusLayoutContainer",
-      "FocusToggle",
-      "GridLayout",
-      "LiveKitRoom",
-      "MediaDeviceSelect",
-      "ParticipantContextIfNeeded",
-      "ParticipantName",
-      "StartAudio",
-      "Toast",
-      "TrackToggle",
-      "VideoConference",
-      "VideoTrack"
-    ],
-    "allHooks": [
-      "useChat",
-      "useClearPinButton",
-      "useConnectionQualityIndicator",
-      "useConnectionState",
-      "useCreateLayoutContext",
-      "useDataChannel",
-      "useDisconnectButton",
-      "useEnsureCreateLayoutContext",
-      "useEnsureLayoutContext",
-      "useEnsureParticipant",
-      "useEnsureRoom",
-      "useEnsureTrackReference",
-      "useGridLayout",
-      "useIsMuted",
-      "useIsSpeaking",
-      "useLayoutContext",
-      "useLivekitRoom",
-      "useLocalParticipant",
-      "useLocalParticipantPermissions",
-      "useMaybeLayoutContext",
-      "useMaybeParticipantContext",
-      "useMaybeRoomContext",
-      "useMaybeTrackContext",
-      "useMediaDevices",
-      "useMediaDeviceSelect",
-      "useMediaTrack",
-      "useMediaTrackByName",
-      "useParticipantContext",
-      "useParticipantInfo",
-      "useParticipantPermissions",
-      "useParticipants",
-      "useParticipantTile",
-      "usePinnedTracks",
-      "usePreviewDevice",
-      "useRemoteParticipant",
-      "useRemoteParticipants",
-      "useRoomContext",
-      "useRoomInfo",
-      "useSortedParticipants",
-      "useSpeakingParticipants",
-      "useToken",
-      "useTrackContext",
-      "useTrackMutedIndicator",
-      "useTracks",
-      "useTrackToggle",
-      "useVisualStableUpdate"
-    ]
-  }
-}