apunkt/SurfSense
1
0
Fork 0
mirror of https://github.com/MODSetter/SurfSense.git synced 2026-05-17 18:35:19 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(editor): align PlateEditor onSave JSDoc with Mod+Shift+S chord

Browse source 
Per #1373, the registered save chord is Mod+Shift+S (not Mod+S, which
collides with the browser's Save-Page-As). The JSDoc on PlateEditorProps.onSave
still claims Mod+S, which is misleading for downstream consumers of the
component. Update the JSDoc to match the actual chord and call out why.

Targeting dev per maintainer request.
This commit is contained in:
Matt Van Horn 2026-05-15 09:06:42 -07:00
parent eea2d68098
commit f0a51fad6f
No known key found for this signature in database
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
surfsense_web/components/editor/plate-editor.tsx
View file

@ -42,7 +42,7 @@ export interface PlateEditorProps {
editorVariant?: "default" | "demo" | "fullWidth" | "none"; editorVariant?: "default" | "demo" | "fullWidth" | "none";
/** Additional className for the container */ /** Additional className for the container */
className?: string; className?: string;
/** Save callback. When provided, ⌘+S / Ctrl+S shortcut is registered and save button appears. */ /** Save callback. When provided, ⌘+Shift+S / Ctrl+Shift+S shortcut is registered (avoiding the browser's ⌘+S / Ctrl+S "Save Page As" conflict) and a save button appears in the toolbar. */
onSave?: () => void; onSave?: () => void;
/** Whether there are unsaved changes */ /** Whether there are unsaved changes */
hasUnsavedChanges?: boolean; hasUnsavedChanges?: boolean;