@livekit/components-js-docs 0.1.9 → 0.1.10

package/generated-docs/core/widgetstate.md

@@ -15,6 +15,7 @@
 export type WidgetState = {
   showChat: boolean;
   unreadMessages: number;
+  showSettings?: boolean;
 };
 ```
 

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

@@ -47,3 +47,8 @@ _(Optional)_
 _(Optional)_
 
 {% /parameter %}
+
+{% parameter name="SettingsComponent" type="React.ComponentType" optional=true %}
+_(Optional)_
+
+{% /parameter %}

package/generated-docs/react/controlbarcontrols.md

@@ -18,6 +18,7 @@ export type ControlBarControls = {
   chat?: boolean;
   screenShare?: boolean;
   leave?: boolean;
+  settings?: boolean;
 };
 ```
 

package/generated-docs/react/index.md

@@ -50,7 +50,7 @@
 | [ControlBar({ variation, controls, saveUserChoices, ...props })](./react/component/controlbar.md)                                                                       | The <code>ControlBar</code> prefab gives the user the basic user interface to control their media devices (camera, microphone and screen share), open the <code>Chat</code> and leave the room.                                                                                                                                                                                     |
 | [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md)                         | The <code>MediaDeviceMenu</code> component is a button that opens a menu that lists all media devices and allows the user to select them.                                                                                                                                                                                                                                           |
 | [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, ...htmlProps })](./react/component/prejoin.md) | The <code>PreJoin</code> prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the <code>LiveKitRoom</code> so that the user enters the room with the correct media devices. |
-| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, ...props })](./react/component/videoconference.md)                                     | The <code>VideoConference</code> ready-made component is your drop-in solution for a classic video conferencing application. It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers of participants, basic non-persistent chat, screen sharing, and more.                                                                 |
+| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, SettingsComponent, ...props })](./react/component/videoconference.md)                  | The <code>VideoConference</code> ready-made component is your drop-in solution for a classic video conferencing application. It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers of participants, basic non-persistent chat, screen sharing, and more.                                                                 |
 
 ## Hooks
 

package/generated-docs/react/layoutcontexttype.md

@@ -14,7 +14,7 @@
 ```typescript
 export type LayoutContextType = {
   pin: PinContextType;
-  widget: ChatContextType;
+  widget: WidgetContextType;
 };
 ```
 

package/generated-docs/react/videoconferenceprops.md

@@ -26,3 +26,4 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
 | [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | [MessageDecoder](./react/messagedecoder.md)     | _(Optional)_ |
 | [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | [MessageEncoder](./react/messageencoder.md)     | _(Optional)_ |
 | [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
+| [SettingsComponent?](./react/videoconferenceprops.settingscomponent.md)       | React.ComponentType                             | _(Optional)_ |

package/generated-docs/react/videoconferenceprops.settingscomponent.md

@@ -0,0 +1,15 @@
+---
+{ "title": "VideoConferenceProps.SettingsComponent property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VideoConferenceProps.SettingsComponent property
+
+**Signature:**
+
+```typescript
+SettingsComponent?: React.ComponentType;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/widgetstate.md

@@ -15,6 +15,7 @@
 export type WidgetState = {
   showChat: boolean;
   unreadMessages: number;
+  showSettings?: boolean;
 };
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "2.0.0"
+    "@livekit/components-react": "2.0.1"
   },
   "author": "",
   "license": "Apache-2.0",