prosemirror-keymap
Advanced tools
Comparing version 1.1.5 to 1.2.0-beta.1
@@ -1,110 +0,123 @@ | ||
'use strict'; | ||
import { keyName, base } from 'w3c-keyname'; | ||
import { Plugin } from 'prosemirror-state'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
var w3cKeyname = require('w3c-keyname'); | ||
var prosemirrorState = require('prosemirror-state'); | ||
// declare global: navigator | ||
var mac = typeof navigator != "undefined" ? /Mac|iP(hone|[oa]d)/.test(navigator.platform) : false; | ||
const mac = typeof navigator != "undefined" ? /Mac|iP(hone|[oa]d)/.test(navigator.platform) : false; | ||
function normalizeKeyName(name) { | ||
var parts = name.split(/-(?!$)/), result = parts[parts.length - 1]; | ||
if (result == "Space") { result = " "; } | ||
var alt, ctrl, shift, meta; | ||
for (var i = 0; i < parts.length - 1; i++) { | ||
var mod = parts[i]; | ||
if (/^(cmd|meta|m)$/i.test(mod)) { meta = true; } | ||
else if (/^a(lt)?$/i.test(mod)) { alt = true; } | ||
else if (/^(c|ctrl|control)$/i.test(mod)) { ctrl = true; } | ||
else if (/^s(hift)?$/i.test(mod)) { shift = true; } | ||
else if (/^mod$/i.test(mod)) { if (mac) { meta = true; } else { ctrl = true; } } | ||
else { throw new Error("Unrecognized modifier name: " + mod) } | ||
} | ||
if (alt) { result = "Alt-" + result; } | ||
if (ctrl) { result = "Ctrl-" + result; } | ||
if (meta) { result = "Meta-" + result; } | ||
if (shift) { result = "Shift-" + result; } | ||
return result | ||
let parts = name.split(/-(?!$)/), result = parts[parts.length - 1]; | ||
if (result == "Space") | ||
result = " "; | ||
let alt, ctrl, shift, meta; | ||
for (let i = 0; i < parts.length - 1; i++) { | ||
let mod = parts[i]; | ||
if (/^(cmd|meta|m)$/i.test(mod)) | ||
meta = true; | ||
else if (/^a(lt)?$/i.test(mod)) | ||
alt = true; | ||
else if (/^(c|ctrl|control)$/i.test(mod)) | ||
ctrl = true; | ||
else if (/^s(hift)?$/i.test(mod)) | ||
shift = true; | ||
else if (/^mod$/i.test(mod)) { | ||
if (mac) | ||
meta = true; | ||
else | ||
ctrl = true; | ||
} | ||
else | ||
throw new Error("Unrecognized modifier name: " + mod); | ||
} | ||
if (alt) | ||
result = "Alt-" + result; | ||
if (ctrl) | ||
result = "Ctrl-" + result; | ||
if (meta) | ||
result = "Meta-" + result; | ||
if (shift) | ||
result = "Shift-" + result; | ||
return result; | ||
} | ||
function normalize(map) { | ||
var copy = Object.create(null); | ||
for (var prop in map) { copy[normalizeKeyName(prop)] = map[prop]; } | ||
return copy | ||
let copy = Object.create(null); | ||
for (let prop in map) | ||
copy[normalizeKeyName(prop)] = map[prop]; | ||
return copy; | ||
} | ||
function modifiers(name, event, shift) { | ||
if (event.altKey) { name = "Alt-" + name; } | ||
if (event.ctrlKey) { name = "Ctrl-" + name; } | ||
if (event.metaKey) { name = "Meta-" + name; } | ||
if (shift !== false && event.shiftKey) { name = "Shift-" + name; } | ||
return name | ||
if (event.altKey) | ||
name = "Alt-" + name; | ||
if (event.ctrlKey) | ||
name = "Ctrl-" + name; | ||
if (event.metaKey) | ||
name = "Meta-" + name; | ||
if (shift !== false && event.shiftKey) | ||
name = "Shift-" + name; | ||
return name; | ||
} | ||
/** | ||
Create a keymap plugin for the given set of bindings. | ||
// :: (Object) → Plugin | ||
// Create a keymap plugin for the given set of bindings. | ||
// | ||
// Bindings should map key names to [command](#commands)-style | ||
// functions, which will be called with `(EditorState, dispatch, | ||
// EditorView)` arguments, and should return true when they've handled | ||
// the key. Note that the view argument isn't part of the command | ||
// protocol, but can be used as an escape hatch if a binding needs to | ||
// directly interact with the UI. | ||
// | ||
// Key names may be strings like `"Shift-Ctrl-Enter"`—a key | ||
// identifier prefixed with zero or more modifiers. Key identifiers | ||
// are based on the strings that can appear in | ||
// [`KeyEvent.key`](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key). | ||
// Use lowercase letters to refer to letter keys (or uppercase letters | ||
// if you want shift to be held). You may use `"Space"` as an alias | ||
// for the `" "` name. | ||
// | ||
// Modifiers can be given in any order. `Shift-` (or `s-`), `Alt-` (or | ||
// `a-`), `Ctrl-` (or `c-` or `Control-`) and `Cmd-` (or `m-` or | ||
// `Meta-`) are recognized. For characters that are created by holding | ||
// shift, the `Shift-` prefix is implied, and should not be added | ||
// explicitly. | ||
// | ||
// You can use `Mod-` as a shorthand for `Cmd-` on Mac and `Ctrl-` on | ||
// other platforms. | ||
// | ||
// You can add multiple keymap plugins to an editor. The order in | ||
// which they appear determines their precedence (the ones early in | ||
// the array get to dispatch first). | ||
Bindings should map key names to [command](https://prosemirror.net/docs/ref/#commands)-style | ||
functions, which will be called with `(EditorState, dispatch, | ||
EditorView)` arguments, and should return true when they've handled | ||
the key. Note that the view argument isn't part of the command | ||
protocol, but can be used as an escape hatch if a binding needs to | ||
directly interact with the UI. | ||
Key names may be strings like `"Shift-Ctrl-Enter"`—a key | ||
identifier prefixed with zero or more modifiers. Key identifiers | ||
are based on the strings that can appear in | ||
[`KeyEvent.key`](https:developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key). | ||
Use lowercase letters to refer to letter keys (or uppercase letters | ||
if you want shift to be held). You may use `"Space"` as an alias | ||
for the `" "` name. | ||
Modifiers can be given in any order. `Shift-` (or `s-`), `Alt-` (or | ||
`a-`), `Ctrl-` (or `c-` or `Control-`) and `Cmd-` (or `m-` or | ||
`Meta-`) are recognized. For characters that are created by holding | ||
shift, the `Shift-` prefix is implied, and should not be added | ||
explicitly. | ||
You can use `Mod-` as a shorthand for `Cmd-` on Mac and `Ctrl-` on | ||
other platforms. | ||
You can add multiple keymap plugins to an editor. The order in | ||
which they appear determines their precedence (the ones early in | ||
the array get to dispatch first). | ||
*/ | ||
function keymap(bindings) { | ||
return new prosemirrorState.Plugin({props: {handleKeyDown: keydownHandler(bindings)}}) | ||
return new Plugin({ props: { handleKeyDown: keydownHandler(bindings) } }); | ||
} | ||
// :: (Object) → (view: EditorView, event: dom.Event) → bool | ||
// Given a set of bindings (using the same format as | ||
// [`keymap`](#keymap.keymap)), return a [keydown | ||
// handler](#view.EditorProps.handleKeyDown) that handles them. | ||
/** | ||
Given a set of bindings (using the same format as | ||
[`keymap`](https://prosemirror.net/docs/ref/#keymap.keymap)), return a [keydown | ||
handler](https://prosemirror.net/docs/ref/#view.EditorProps.handleKeyDown) that handles them. | ||
*/ | ||
function keydownHandler(bindings) { | ||
var map = normalize(bindings); | ||
return function(view, event) { | ||
var name = w3cKeyname.keyName(event), isChar = name.length == 1 && name != " ", baseName; | ||
var direct = map[modifiers(name, event, !isChar)]; | ||
if (direct && direct(view.state, view.dispatch, view)) { return true } | ||
if (isChar && (event.shiftKey || event.altKey || event.metaKey || name.charCodeAt(0) > 127) && | ||
(baseName = w3cKeyname.base[event.keyCode]) && baseName != name) { | ||
// Try falling back to the keyCode when there's a modifier | ||
// active or the character produced isn't ASCII, and our table | ||
// produces a different name from the the keyCode. See #668, | ||
// #1060 | ||
var fromCode = map[modifiers(baseName, event, true)]; | ||
if (fromCode && fromCode(view.state, view.dispatch, view)) { return true } | ||
} else if (isChar && event.shiftKey) { | ||
// Otherwise, if shift is active, also try the binding with the | ||
// Shift- prefix enabled. See #997 | ||
var withShift = map[modifiers(name, event, true)]; | ||
if (withShift && withShift(view.state, view.dispatch, view)) { return true } | ||
} | ||
return false | ||
} | ||
let map = normalize(bindings); | ||
return function (view, event) { | ||
let name = keyName(event), isChar = name.length == 1 && name != " ", baseName; | ||
let direct = map[modifiers(name, event, !isChar)]; | ||
if (direct && direct(view.state, view.dispatch, view)) | ||
return true; | ||
if (isChar && (event.shiftKey || event.altKey || event.metaKey || name.charCodeAt(0) > 127) && | ||
(baseName = base[event.keyCode]) && baseName != name) { | ||
// Try falling back to the keyCode when there's a modifier | ||
// active or the character produced isn't ASCII, and our table | ||
// produces a different name from the the keyCode. See #668, | ||
// #1060 | ||
let fromCode = map[modifiers(baseName, event, true)]; | ||
if (fromCode && fromCode(view.state, view.dispatch, view)) | ||
return true; | ||
} | ||
else if (isChar && event.shiftKey) { | ||
// Otherwise, if shift is active, also try the binding with the | ||
// Shift- prefix enabled. See #997 | ||
let withShift = map[modifiers(name, event, true)]; | ||
if (withShift && withShift(view.state, view.dispatch, view)) | ||
return true; | ||
} | ||
return false; | ||
}; | ||
} | ||
exports.keydownHandler = keydownHandler; | ||
exports.keymap = keymap; | ||
//# sourceMappingURL=index.js.map | ||
export { keydownHandler, keymap }; |
{ | ||
"name": "prosemirror-keymap", | ||
"version": "1.1.5", | ||
"version": "1.2.0-beta.1", | ||
"description": "Keymap plugin for ProseMirror", | ||
"main": "dist/index.js", | ||
"module": "dist/index.es.js", | ||
"type": "module", | ||
"main": "dist/index.cjs", | ||
"module": "dist/index.js", | ||
"types": "dist/index.d.ts", | ||
"exports": { | ||
"import": "./dist/index.js", | ||
"require": "./dist/index.cjs" | ||
}, | ||
"sideEffects": false, | ||
"license": "MIT", | ||
@@ -24,13 +31,9 @@ "maintainers": [ | ||
"devDependencies": { | ||
"ist": "^1.0.1", | ||
"mocha": "^9.1.2", | ||
"rollup": "^2.26.3", | ||
"@rollup/plugin-buble": "^0.21.3" | ||
"@prosemirror/buildhelper": "^0.1.5", | ||
"prosemirror-test-builder": "^1.0.0" | ||
}, | ||
"scripts": { | ||
"test": "mocha test/test-*.js", | ||
"build": "rollup -c", | ||
"watch": "rollup -c -w", | ||
"prepare": "npm run build" | ||
"test": "pm-runtests", | ||
"prepare": "pm-buildhelper src/keymap.ts" | ||
} | ||
} |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
43680
2
14
411
Yes
2
1