Skip to content

Virtual whiteboard for sketching hand-drawn like diagrams

feat(editor): add showHints to command palette (#12187)

neihyud2d3707b81610
diff --git a/packages/excalidraw/actions/actionToggleShowHints.tsx b/packages/excalidraw/actions/actionToggleShowHints.tsx
new file mode 100644
index 0000000000..758067b594
--- /dev/null
+++ b/packages/excalidraw/actions/actionToggleShowHints.tsx
@@ -0,0 +1,28 @@
+import { CaptureUpdateAction } from "@excalidraw/element";
+
+import { messageCircleIcon } from "../components/icons";
+
+import { register } from "./register";
+
+export const actionToggleShowHints = register({
+ name: "showHints",
+ label: "labels.showHints",
+ icon: messageCircleIcon,
+ keywords: ["hint", "hints", "tip", "tips"],
+ // hints live in the toolbar, which view mode hides entirely
+ viewMode: false,
+ trackEvent: {
+ category: "canvas",
+ predicate: (appState) => !appState.showHints,
+ },
+ perform(elements, appState) {
+ return {
+ appState: {
+ ...appState,
+ showHints: !this.checked!(appState),
+ },
+ captureUpdate: CaptureUpdateAction.NEVER,
+ };
+ },
+ checked: (appState) => appState.showHints,
+});
diff --git a/packages/excalidraw/actions/index.ts b/packages/excalidraw/actions/index.ts
index 6d2321ba0e..e72deb1766 100644
--- a/packages/excalidraw/actions/index.ts
+++ b/packages/excalidraw/actions/index.ts
@@ -82,6 +82,7 @@ export { actionToggleZenMode } from "./actionToggleZenMode";
export { actionToggleObjectsSnapMode } from "./actionToggleObjectsSnapMode";
export { actionToggleArrowBinding } from "./actionToggleArrowBinding";
export { actionToggleMidpointSnapping } from "./actionToggleMidpointSnapping";
+export { actionToggleShowHints } from "./actionToggleShowHints";
export { actionToggleStats } from "./actionToggleStats";
export { actionUnbindText, actionBindText } from "./actionBoundText";
diff --git a/packages/excalidraw/actions/types.ts b/packages/excalidraw/actions/types.ts
index 4f7cbd37c7..cd1305a7fe 100644
--- a/packages/excalidraw/actions/types.ts
+++ b/packages/excalidraw/actions/types.ts
@@ -61,6 +61,7 @@ export type ActionName =
| "objectsSnapMode"
| "arrowBinding"
| "midpointSnapping"
+ | "showHints"
| "stats"
| "changeStrokeColor"
| "changeBackgroundColor"
diff --git a/packages/excalidraw/components/CommandPalette/CommandPalette.tsx b/packages/excalidraw/components/CommandPalette/CommandPalette.tsx
index 31dafd50ca..d529747c81 100644
--- a/packages/excalidraw/components/CommandPalette/CommandPalette.tsx
+++ b/packages/excalidraw/components/CommandPalette/CommandPalette.tsx
@@ -368,6 +368,7 @@ function CommandPaletteInner({
actionManager.actions.viewMode,
actionManager.actions.gridMode,
actionManager.actions.objectsSnapMode,
+ actionManager.actions.showHints,
actionManager.actions.toggleShortcuts,
actionManager.actions.selectAll,
actionManager.actions.toggleElementLock,
diff --git a/packages/excalidraw/components/main-menu/DefaultItems.tsx b/packages/excalidraw/components/main-menu/DefaultItems.tsx
index 3b29b6cc46..6869ad1be4 100644
--- a/packages/excalidraw/components/main-menu/DefaultItems.tsx
+++ b/packages/excalidraw/components/main-menu/DefaultItems.tsx
@@ -14,6 +14,7 @@ import {
actionToggleMidpointSnapping,
actionToggleObjectsSnapMode,
actionToggleSearchMenu,
+ actionToggleShowHints,
actionToggleStats,
actionToggleTheme,
actionToggleZenMode,
@@ -565,13 +566,13 @@ const PreferencesToggleMidpointSnappingItem = () => {
const PreferencesToggleShowHintsItem = () => {
const { t } = useI18n();
+ const actionManager = useExcalidrawActionManager();
const appState = useUIAppState();
- const setAppState = useExcalidrawSetAppState();
return (
<DropdownMenuItemCheckbox
checked={appState.showHints}
onSelect={(event) => {
- setAppState({ showHints: !appState.showHints });
+ actionManager.executeAction(actionToggleShowHints);
event.preventDefault();
}}
>