Update documentation

This commit is contained in:
Dmitry Lyzo 2020-03-31 19:07:03 +03:00
parent a1cc977872
commit 8789b1b69b

View File

@ -60,8 +60,8 @@ if (!hasFieldKey) {
/** /**
* Returns key name from event. * Returns key name from event.
* *
* @param {KeyboardEvent} event - keyboard event * @param {KeyboardEvent} event - Keyboard event.
* @return {string} key name * @return {string} Key name.
*/ */
export function getKeyName(event) { export function getKeyName(event) {
return KeyNames[event.keyCode] || event.key; return KeyNames[event.keyCode] || event.key;
@ -70,8 +70,8 @@ export function getKeyName(event) {
/** /**
* Returns _true_ if key is used for navigation. * Returns _true_ if key is used for navigation.
* *
* @param {string} key - key name * @param {string} key - Key name.
* @return {boolean} _true_ if key is used for navigation * @return {boolean} _true_ if key is used for navigation.
*/ */
export function isNavigationKey(key) { export function isNavigationKey(key) {
return NavigationKeys.indexOf(key) != -1; return NavigationKeys.indexOf(key) != -1;