Update ControlBar and PreJoin props

livekit · Nov 6, 2023 · 7416860 · 7416860
1 parent e3994a1
commit 7416860
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git a/packages/react/etc/components-react.api.md b/packages/react/etc/components-react.api.md
@@ -183,7 +183,7 @@ export interface ConnectionStatusProps extends React_2.HTMLAttributes<HTMLDivEle
 }
 
 // @public
-export function ControlBar({ variation, controls, saveDeviceSettings, ...props }: ControlBarProps): React_2.JSX.Element;
+export function ControlBar({ variation, controls, saveUserChoices, ...props }: ControlBarProps): React_2.JSX.Element;
 
 // @public (undocumented)
 export type ControlBarControls = {
@@ -198,7 +198,8 @@ export type ControlBarControls = {
 export interface ControlBarProps extends React_2.HTMLAttributes<HTMLDivElement> {
     // (undocumented)
     controls?: ControlBarControls;
-    saveDeviceSettings?: boolean;
+    // @alpha
+    saveUserChoices?: boolean;
     // (undocumented)
     variation?: 'minimal' | 'verbose' | 'textOnly';
 }
@@ -426,7 +427,7 @@ export interface ParticipantTileProps extends React_2.HTMLAttributes<HTMLDivElem
 }
 
 // @public
-export function PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, showE2EEOptions, saveDeviceSettings, ...htmlProps }: PreJoinProps): React_2.JSX.Element;
+export function PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, showE2EEOptions, persistUserChoices, ...htmlProps }: PreJoinProps): React_2.JSX.Element;
 
 // @public
 export interface PreJoinProps extends Omit<React_2.HTMLAttributes<HTMLDivElement>, 'onSubmit' | 'onError'> {
@@ -442,7 +443,8 @@ export interface PreJoinProps extends Omit<React_2.HTMLAttributes<HTMLDivElement
     onError?: (error: Error) => void;
     onSubmit?: (values: LocalUserChoices) => void;
     onValidate?: (values: LocalUserChoices) => boolean;
-    saveDeviceSettings?: boolean;
+    // @alpha
+    persistUserChoices?: boolean;
     // (undocumented)
     showE2EEOptions?: boolean;
     // (undocumented)
@@ -830,7 +832,7 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React_2.
 
 // @alpha
 export function usePersistentUserChoices(options?: UsePersistentUserChoicesOptions): {
-    deviceSettings: UserChoices;
+    userChoices: UserChoices;
     saveAudioInputEnabled: (isEnabled: boolean) => void;
     saveVideoInputEnabled: (isEnabled: boolean) => void;
     saveAudioInputDeviceId: (deviceId: string) => void;

diff --git a/packages/react/src/prefabs/ControlBar.tsx b/packages/react/src/prefabs/ControlBar.tsx
@@ -29,6 +29,7 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement> {
    * If `true`, the user's device choices will be persisted.
    * This will enables the user to have the same device choices when they rejoin the room.
    * @defaultValue true
+   * @alpha
    */
   saveUserChoices?: boolean;
 }
@@ -52,7 +53,7 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement> {
 export function ControlBar({
   variation,
   controls,
-  saveUserChoices: saveDeviceSettings = true,
+  saveUserChoices = true,
   ...props
 }: ControlBarProps) {
   const [isChatOpen, setIsChatOpen] = React.useState(false);
@@ -107,7 +108,7 @@ export function ControlBar({
     saveVideoInputEnabled,
     saveAudioInputDeviceId,
     saveVideoInputDeviceId,
-  } = usePersistentUserChoices({ preventSave: !saveDeviceSettings });
+  } = usePersistentUserChoices({ preventSave: !saveUserChoices });
 
   return (
     <div {...htmlProps}>