fix(strikethrough): update strikethrough shortcut (#4288)

* update strikethrough shortcut * update tests
ueberdosis · Aug 5, 2023 · fd35db4 · fd35db4
1 parent 4f4a389
commit fd35db4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/demos/src/Marks/Strike/React/index.spec.js b/demos/src/Marks/Strike/React/index.spec.js
@@ -58,15 +58,15 @@ context('/src/Marks/Strike/React/', () => {
 
   it('should strike the selected text when the keyboard shortcut is pressed', () => {
     cy.get('.tiptap')
-      .trigger('keydown', { modKey: true, shiftKey: true, key: 'x' })
+      .trigger('keydown', { ctrlKey: true, shiftKey: true, key: 's' })
       .find('s')
       .should('contain', 'Example Text')
   })
 
   it('should toggle the selected text striked when the keyboard shortcut is pressed', () => {
     cy.get('.tiptap')
-      .trigger('keydown', { modKey: true, shiftKey: true, key: 'x' })
-      .trigger('keydown', { modKey: true, shiftKey: true, key: 'x' })
+      .trigger('keydown', { ctrlKey: true, shiftKey: true, key: 's' })
+      .trigger('keydown', { ctrlKey: true, shiftKey: true, key: 's' })
       .find('s')
       .should('not.exist')
   })

diff --git a/demos/src/Marks/Strike/Vue/index.spec.js b/demos/src/Marks/Strike/Vue/index.spec.js
@@ -64,15 +64,15 @@ context('/src/Marks/Strike/Vue/', () => {
 
   it('should strike the selected text when the keyboard shortcut is pressed', () => {
     cy.get('.tiptap')
-      .trigger('keydown', { modKey: true, shiftKey: true, key: 'x' })
+      .trigger('keydown', { ctrlKey: true, shiftKey: true, key: 's' })
       .find('s')
       .should('contain', 'Example Text')
   })
 
   it('should toggle the selected text striked when the keyboard shortcut is pressed', () => {
     cy.get('.tiptap')
-      .trigger('keydown', { modKey: true, shiftKey: true, key: 'x' })
-      .trigger('keydown', { modKey: true, shiftKey: true, key: 'x' })
+      .trigger('keydown', { ctrlKey: true, shiftKey: true, key: 's' })
+      .trigger('keydown', { ctrlKey: true, shiftKey: true, key: 's' })
       .find('s')
       .should('not.exist')
   })

diff --git a/packages/extension-strike/src/strike.ts b/packages/extension-strike/src/strike.ts
@@ -1,4 +1,5 @@
 import {
+  isMacOS,
   Mark,
   markInputRule,
   markPasteRule,
@@ -78,9 +79,15 @@ export const Strike = Mark.create<StrikeOptions>({
   },
 
   addKeyboardShortcuts() {
-    return {
-      'Mod-Shift-x': () => this.editor.commands.toggleStrike(),
+    const shortcuts: Record<string, () => boolean> = {}
+
+    if (isMacOS()) {
+      shortcuts['Mod-Shift-s'] = () => this.editor.commands.toggleStrike()
+    } else {
+      shortcuts['Ctrl-Shift-s'] = () => this.editor.commands.toggleStrike()
     }
+
+    return shortcuts
   },
 
   addInputRules() {