Naming: hotkey -> shortcut

Author: mme

CopilotKit/packages/react-ui/src/components/chat/Chat.tsx

@@ -55,11 +55,11 @@ export interface CopilotChatProps {
   onSetOpen?: (open: boolean) => void;
 
   /**
-   * The hotkey to open the chat window.
-   * Uses Command-<hotkey> on a Mac and Ctrl-<hotkey> on Windows.
+   * The shortcut key to open the chat window.
+   * Uses Command-<shortcut> on a Mac and Ctrl-<shortcut> on Windows.
    * @default "e"
    */
-  hotkey?: string;
+  shortcut?: string;
 
   /**
    * Icons can be used to set custom icons for the chat window.
@@ -127,7 +127,7 @@ export const CopilotChat = ({
   clickOutsideToClose = true,
   hitEscapeToClose = true,
   onSetOpen,
-  hotkey = "e",
+  shortcut = "e",
   icons,
   labels,
   makeSystemMessage,
@@ -169,7 +169,7 @@ export const CopilotChat = ({
           open={openState}
           setOpen={setOpen}
           clickOutsideToClose={clickOutsideToClose}
-          hotkey={hotkey}
+          shortcut={shortcut}
           hitEscapeToClose={hitEscapeToClose}
         >
           <Header open={openState} setOpen={setOpen} />

CopilotKit/packages/react-ui/src/components/chat/Window.tsx

@@ -6,7 +6,7 @@ export const Window = ({
   setOpen,
   children,
   clickOutsideToClose,
-  hotkey,
+  shortcut,
   hitEscapeToClose,
 }: WindowProps) => {
   const windowRef = React.useRef<HTMLDivElement>(null);
@@ -45,14 +45,14 @@ export const Window = ({
       ) {
         setOpen(false);
       } else if (
-        event.key === hotkey &&
+        event.key === shortcut &&
         ((isMacOS() && event.metaKey) || (!isMacOS() && event.ctrlKey)) &&
         (!isInput || isDescendantOfWrapper)
       ) {
         setOpen(!open);
       }
     },
-    [hitEscapeToClose, hotkey, open, setOpen],
+    [hitEscapeToClose, shortcut, open, setOpen],
   );
 
   const adjustForMobile = useCallback(() => {

CopilotKit/packages/react-ui/src/components/chat/props.ts

@@ -10,7 +10,7 @@ export interface WindowProps {
   setOpen: (open: boolean) => void;
   clickOutsideToClose: boolean;
   hitEscapeToClose: boolean;
-  hotkey: string;
+  shortcut: string;
   children?: React.ReactNode;
 }
 

docs/reference/CopilotPopup.mdx

@@ -73,9 +73,9 @@ For example:
   opens or closes.
 </ResponseField>
 
-<ResponseField name="hotkey" type="string" default="e">
-  The hotkey to open the chat window. Uses Command-`hotkey` on a Mac and
-  Ctrl-`hotkey` on Windows.
+<ResponseField name="shortcut" type="string" default="e">
+  The shortcut key to open the chat window. Uses Command-`shortcut` on a Mac and
+  Ctrl-`shortcut` on Windows.
 </ResponseField>
 
 <ResponseField name="icons" type="CopilotChatIcons">

docs/reference/CopilotSidebar.mdx

@@ -81,9 +81,9 @@ For example:
   opens or closes.
 </ResponseField>
 
-<ResponseField name="hotkey" type="string" default="e">
-  The hotkey to open the chat window. Uses Command-`hotkey` on a Mac and
-  Ctrl-`hotkey` on Windows.
+<ResponseField name="shortcut" type="string" default="e">
+  The shortcut key to open the chat window. Uses Command-`shortcut` on a Mac and
+  Ctrl-`shortcut` on Windows.
 </ResponseField>
 
 <ResponseField name="icons" type="CopilotChatIcons">