wikimedia/mediawiki-extensions-WikiEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/WikiEditor synced 2024-11-23 15:57:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Retry adding keyboard shortcuts for formatting tools in WikiEditor 2010

Browse source 
Retry I63414a78ce2546125d557cb37ccb37ea16a15fe1: adds shortcuts for
bold, italic, subscript, superscript and nowiki options, and the link
insertion tool in WikiEditor. The hotkeys match the ones used in
VisualEditor and NWE 2017.

jQuery event.which is used instead of event.code or event.key for
compatibility with alternative keyboard layouts and non-English
keyboards.

Bug: T62928
Change-Id: I18db5b6c53000457524573a9ae06939e8df0dc4f
This commit is contained in:
Siddharth VP 2024-10-02 15:22:18 +05:30
parent 718297c26f
commit 5413262fee
4 changed files with 33 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
extension.json
View file

@ -246,6 +246,7 @@
], ],
"dependencies": [ "dependencies": [
"mediawiki.cookie", "mediawiki.cookie",
"jquery.client",
"jquery.textSelection", "jquery.textSelection",
"jquery.ui", "jquery.ui",
"mediawiki.api", "mediawiki.api",

3
modules/jquery.wikiEditor.dialogs.config.js
View file

@ -42,7 +42,8 @@ module.exports = {
action: { action: {
type: 'dialog', type: 'dialog',
module: 'insert-link' module: 'insert-link'
} },
hotkey: 75 // K
}, },
file: { file: {
label: mw.msg( 'wikieditor-toolbar-tool-file' ), label: mw.msg( 'wikieditor-toolbar-tool-file' ),

15
modules/jquery.wikiEditor.toolbar.config.js
View file

@ -45,7 +45,8 @@ toolbarConfig = {
peri: mw.msg( 'wikieditor-toolbar-tool-bold-example' ), peri: mw.msg( 'wikieditor-toolbar-tool-bold-example' ),
post: "'''" post: "'''"
} }
} },
hotkey: 66 // B
}, },
italic: { italic: {
section: 'main', section: 'main',
@ -61,7 +62,8 @@ toolbarConfig = {
peri: mw.msg( 'wikieditor-toolbar-tool-italic-example' ), peri: mw.msg( 'wikieditor-toolbar-tool-italic-example' ),
post: "''" post: "''"
} }
} },
hotkey: 73 // I
} }
} }
}, },
@ -206,7 +208,8 @@ toolbarConfig = {
peri: mw.msg( 'wikieditor-toolbar-tool-nowiki-example' ), peri: mw.msg( 'wikieditor-toolbar-tool-nowiki-example' ),
post: '</nowiki>' post: '</nowiki>'
} }
} },
hotkey: 220 // Backslash (\)
}, },
newline: { newline: {
label: mw.msg( 'wikieditor-toolbar-tool-newline' ), label: mw.msg( 'wikieditor-toolbar-tool-newline' ),
@ -260,7 +263,8 @@ toolbarConfig = {
peri: mw.msg( 'wikieditor-toolbar-tool-superscript-example' ), peri: mw.msg( 'wikieditor-toolbar-tool-superscript-example' ),
post: '</sup>' post: '</sup>'
} }
} },
hotkey: 190 // Period (.)
}, },
subscript: { subscript: {
label: mw.msg( 'wikieditor-toolbar-tool-subscript' ), label: mw.msg( 'wikieditor-toolbar-tool-subscript' ),
@ -273,7 +277,8 @@ toolbarConfig = {
peri: mw.msg( 'wikieditor-toolbar-tool-subscript-example' ), peri: mw.msg( 'wikieditor-toolbar-tool-subscript-example' ),
post: '</sub>' post: '</sub>'
} }
} },
hotkey: 188 // Comma (,)
} }
} }
}, },

20
modules/jquery.wikiEditor.toolbar.js
View file

@ -359,6 +359,9 @@ var toolbarModule = {
} }
} ); } );
} }
if ( 'hotkey' in tool ) {
toolbarModule.fn.ctrlShortcuts[ tool.hotkey ] = tool;
}
} }
return $button; return $button;
case 'select': case 'select':
@ -786,6 +789,23 @@ var toolbarModule = {
// Use hook for attaching new toolbar tools to avoid race conditions // Use hook for attaching new toolbar tools to avoid race conditions
mw.hook( 'wikiEditor.toolbarReady' ).fire( context.$textarea ); mw.hook( 'wikiEditor.toolbarReady' ).fire( context.$textarea );
} ); } );
toolbarModule.fn.setupShortcuts( context );
},
ctrlShortcuts: {},
setupShortcuts: function ( context ) {
var platform = $.client.profile().platform;
var platformModifier = platform === 'mac' ? 'metaKey' : 'ctrlKey';
var otherModifier = platform === 'mac' ? 'ctrlKey' : 'metaKey';
context.$textarea.on( 'keydown', function ( e ) {
// Check if the primary modifier key is pressed and that others aren't
var target = e[ platformModifier ] && !e[ otherModifier ] && !e.altKey && !e.shiftKey &&
toolbarModule.fn.ctrlShortcuts[ e.which ];
if ( target ) {
e.preventDefault();
toolbarModule.fn.doAction( context, target.action );
}
} );
}, },
handleKeyDown: function ( $element, event, $parent ) { handleKeyDown: function ( $element, event, $parent ) {
var $currentItem = $element.find( '.wikiEditor-character-highlighted' ), var $currentItem = $element.find( '.wikiEditor-character-highlighted' ),