atom-keymap
Advanced tools
Comparing version 5.1.5 to 5.1.6
36
api.json
@@ -6,3 +6,3 @@ { | ||
"filename": "src/keymap-manager.coffee", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L67", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L67", | ||
"sections": [ | ||
@@ -42,3 +42,3 @@ { | ||
"sectionName": "Class Methods", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L84", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L84", | ||
"visibility": "Public", | ||
@@ -105,3 +105,3 @@ "summary": "Create a keydown DOM event for testing purposes.", | ||
"sectionName": "Construction and Destruction", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L108", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L108", | ||
"visibility": "Public", | ||
@@ -130,3 +130,3 @@ "summary": "Create a new KeymapManager.", | ||
"sectionName": "Construction and Destruction", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L118", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L118", | ||
"visibility": "Public", | ||
@@ -139,3 +139,3 @@ "summary": "Unwatch all watched paths. ", | ||
"sectionName": "Event Subscription", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L144", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L144", | ||
"visibility": "Public", | ||
@@ -190,3 +190,3 @@ "summary": "Invoke the given callback when one or more keystrokes completely\nmatch a key binding.", | ||
"sectionName": "Event Subscription", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L160", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L160", | ||
"visibility": "Public", | ||
@@ -241,3 +241,3 @@ "summary": "Invoke the given callback when one or more keystrokes partially\nmatch a binding.", | ||
"sectionName": "Event Subscription", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L174", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L174", | ||
"visibility": "Public", | ||
@@ -286,3 +286,3 @@ "summary": "Invoke the given callback when one or more keystrokes fail to match\nany bindings.", | ||
"sectionName": "Event Subscription", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L205", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L205", | ||
"visibility": "Public", | ||
@@ -331,3 +331,3 @@ "summary": "Invoke the given callback when a keymap file not able to be loaded.", | ||
"sectionName": "Adding and Removing Bindings", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L218", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L218", | ||
"visibility": "Public", | ||
@@ -354,3 +354,3 @@ "summary": "Add sets of key bindings grouped by CSS selector.", | ||
"sectionName": "Accessing Bindings", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L251", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L251", | ||
"visibility": "Public", | ||
@@ -369,3 +369,3 @@ "summary": "Get all current key bindings.", | ||
"sectionName": "Accessing Bindings", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L266", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L266", | ||
"visibility": "Public", | ||
@@ -412,3 +412,3 @@ "summary": "Get the key bindings for a given command and optional target.", | ||
"sectionName": "Managing Keymap Files", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L301", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L301", | ||
"visibility": "Public", | ||
@@ -443,3 +443,3 @@ "summary": "Load the key bindings from the given path.", | ||
"sectionName": "Managing Keymap Files", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L321", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L321", | ||
"visibility": "Public", | ||
@@ -460,3 +460,3 @@ "summary": "Cause the keymap to reload the key bindings file at the given path\nwhenever it changes.", | ||
"sectionName": "Managing Keyboard Events", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L395", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L395", | ||
"visibility": "Public", | ||
@@ -477,3 +477,3 @@ "summary": "Dispatch a custom event associated with the matching key binding for\nthe given `KeyboardEvent` if one can be found.", | ||
"sectionName": "Managing Keyboard Events", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L473", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L473", | ||
"visibility": "Public", | ||
@@ -500,3 +500,3 @@ "summary": "Translate a keydown event to a keystroke string.", | ||
"sectionName": "Managing Keyboard Events", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.5/src/keymap-manager.coffee#L480", | ||
"srcUrl": "https://github.com/atom/atom-keymap/blob/v5.1.6/src/keymap-manager.coffee#L480", | ||
"visibility": "Public", | ||
@@ -516,6 +516,6 @@ "summary": "Get the number of milliseconds allowed before pending states caused\nby partial matches of multi-keystroke bindings are terminated.", | ||
"visibility": "Extended", | ||
"summary": "Allows commands to be associated with keystrokes in a\ncontext-sensitive way. In Atom, you can access a global instance of this\nobject via `atom.keymap`.", | ||
"description": "Allows commands to be associated with keystrokes in a\ncontext-sensitive way. In Atom, you can access a global instance of this\nobject via `atom.keymap`.\n\nKey bindings are plain JavaScript objects containing **CSS selectors** as\ntheir top level keys, then **keystroke patterns** mapped to commands.\n\n```cson\n'.workspace':\n 'ctrl-l': 'package:do-something'\n 'ctrl-z': 'package:do-something-else'\n'.mini.editor':\n 'enter': 'core:confirm'\n```\n\nWhen a keystroke sequence matches a binding in a given context, a custom DOM\nevent with a type based on the command is dispatched on the target of the\nkeyboard event.\n\nTo match a keystroke sequence, the keymap starts at the target element for the\nkeyboard event. It looks for key bindings associated with selectors that match\nthe target element. If multiple match, the most specific is selected. If there\nis a tie in specificity, the most recently added binding wins. If no bindings\nare found for the events target, the search is repeated again for the target's\nparent node and so on recursively until a binding is found or we traverse off\nthe top of the document.\n\nWhen a binding is found, its command event is always dispatched on the\noriginal target of the keyboard event, even if the matching element is higher\nup in the DOM. In addition, `.preventDefault()` is called on the keyboard\nevent to prevent the browser from taking action. `.preventDefault` is only\ncalled if a matching binding is found.\n\nCommand event objects have a non-standard method called `.abortKeyBinding()`.\nIf your command handler is invoked but you programmatically determine that no\naction can be taken and you want to allow other bindings to be matched, call\n`.abortKeyBinding()` on the event object. An example of where this is useful\nis binding snippet expansion to `tab`. If `snippets:expand` is invoked when\nthe cursor does not follow a valid snippet prefix, we abort the binding and\nallow `tab` to be handled by the default handler, which inserts whitespace.\n\nMulti-keystroke bindings are possible. If a sequence of one or more keystrokes\n*partially* matches a multi-keystroke binding, the keymap enters a pending\nstate. The pending state is terminated on the next keystroke, or after\n{::partialMatchTimeout} milliseconds has elapsed. When the pending state is\nterminated via a timeout or a keystroke that leads to no matches, the longest\nambiguous bindings that caused the pending state are temporarily disabled and\nthe previous keystrokes are replayed. If there is ambiguity again during the\nreplay, the next longest bindings are disabled and the keystrokes are replayed\nagain. " | ||
"summary": "Allows commands to be associated with keystrokes in a\ncontext-sensitive way. In Atom, you can access a global instance of this\nobject via `atom.keymaps`.", | ||
"description": "Allows commands to be associated with keystrokes in a\ncontext-sensitive way. In Atom, you can access a global instance of this\nobject via `atom.keymaps`.\n\nKey bindings are plain JavaScript objects containing **CSS selectors** as\ntheir top level keys, then **keystroke patterns** mapped to commands.\n\n```cson\n'.workspace':\n 'ctrl-l': 'package:do-something'\n 'ctrl-z': 'package:do-something-else'\n'.mini.editor':\n 'enter': 'core:confirm'\n```\n\nWhen a keystroke sequence matches a binding in a given context, a custom DOM\nevent with a type based on the command is dispatched on the target of the\nkeyboard event.\n\nTo match a keystroke sequence, the keymap starts at the target element for the\nkeyboard event. It looks for key bindings associated with selectors that match\nthe target element. If multiple match, the most specific is selected. If there\nis a tie in specificity, the most recently added binding wins. If no bindings\nare found for the events target, the search is repeated again for the target's\nparent node and so on recursively until a binding is found or we traverse off\nthe top of the document.\n\nWhen a binding is found, its command event is always dispatched on the\noriginal target of the keyboard event, even if the matching element is higher\nup in the DOM. In addition, `.preventDefault()` is called on the keyboard\nevent to prevent the browser from taking action. `.preventDefault` is only\ncalled if a matching binding is found.\n\nCommand event objects have a non-standard method called `.abortKeyBinding()`.\nIf your command handler is invoked but you programmatically determine that no\naction can be taken and you want to allow other bindings to be matched, call\n`.abortKeyBinding()` on the event object. An example of where this is useful\nis binding snippet expansion to `tab`. If `snippets:expand` is invoked when\nthe cursor does not follow a valid snippet prefix, we abort the binding and\nallow `tab` to be handled by the default handler, which inserts whitespace.\n\nMulti-keystroke bindings are possible. If a sequence of one or more keystrokes\n*partially* matches a multi-keystroke binding, the keymap enters a pending\nstate. The pending state is terminated on the next keystroke, or after\n{::partialMatchTimeout} milliseconds has elapsed. When the pending state is\nterminated via a timeout or a keystroke that leads to no matches, the longest\nambiguous bindings that caused the pending state are temporarily disabled and\nthe previous keystrokes are replayed. If there is ambiguity again during the\nreplay, the next longest bindings are disabled and the keystrokes are replayed\nagain. " | ||
} | ||
} | ||
} |
{ | ||
"name": "atom-keymap", | ||
"version": "5.1.5", | ||
"version": "5.1.6", | ||
"description": "Atom's DOM-aware keymap module", | ||
@@ -5,0 +5,0 @@ "main": "./lib/keymap-manager", |
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
New author
Supply chain riskA new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.
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
63486
1