• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

hotkeys: js简单的设置快捷键,没有依赖。 https://jaywcjlove.gitee.io/hotkeys ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

hotkeys

开源软件地址:

https://gitee.com/jaywcjlove/hotkeys

开源软件介绍:

Hotkeys

Build Status Coverage Status jaywcjlove/sb

这是一个强健的 Javascript 库用于捕获键盘输入和输入的组合键,它易于使用,没有依赖,压缩只有(~3kb),gzip: 1.73kb。官方文档DEMO预览更多实例

╭┈┈╮          ╭┈┈╮  ╭┈┈╮┆  ├┈┈..┈┈┈┈┈.┆  └┈╮┆  ├┈┈..┈┈┈┈┈..┈┈.┈┈..┈┈┈┈┈.┆     ┆┆  □  ┆┆   ┈┤┆    < ┆  -__┘┆  ┆  ┆┆__ ┈┈┤╰┈┈┴┈┈╯╰┈┈┈┈┈╯╰┈┈┈┈╯╰┈┈┴┈┈╯╰┈┈┈┈┈╯╰┈┈┈  ┆╰┈┈┈┈┈╯                                  ╰┈┈┈┈┈╯

创建

您将需要在您的系统上安装的 Node.js。

# bower 安装$ bower install hotkeysjs# npm 安装$ npm install hotkeys-js$ npm run build # 编译$ npm run watch # 开发模式
import hotkeys from 'hotkeys-js';hotkeys('f5', function(event, handler){  // Prevent the default refresh event under WINDOWS system  event.preventDefault()   alert('you pressed F5!') });

或者在您的HTML中手动下载并引入 hotkeys.js,你也可以通过 UNPKG 进行下载:

CDN: UNPKG | jsDelivr | Githack | Statically | bundle.run

<script src="https://unpkg.com/hotkeys-js/dist/hotkeys.min.js"></script><script type="text/javascript">hotkeys('ctrl+a,ctrl+b,r,f', function(event,handler) {  switch(handler.key){    case "ctrl+a":alert('you pressed ctrl+a!');break;    case "ctrl+b":alert('you pressed ctrl+b!');break;    case "r":alert('you pressed r!');break;    case "f":alert('you pressed f!');break;  }});</script>

React中使用

react-hotkeys 是 React 组件,用于侦听 keydown 和 keyup 键盘事件,定义和分配键盘快捷键。 详细的使用方法请参见其文档,详细使用方法请参考文档 react-hotkeys

react-hotkeys-hook - React Hook,用于在组件中使用键盘快捷键。确保您至少安装了 16.8 版本的 react 和 react-dom,否则钩子将对您不起作用。

使用

传统调用

<script type="text/javascript" src="./js/hotkeys.js"></script>

包加载

import hotkeys from 'hotkeys-js';hotkeys('shift+a,alt+d, w', function(e){  console.log('干点活儿',e);  if(hotkeys.shift) console.log('大哥你摁下了 shift 键!');  if(hotkeys.ctrl) console.log('大哥你摁下了 ctrl 键!');  if(hotkeys.alt) console.log('大哥你摁下了 alt 键!');});

支持的键

, shift, option, , alt, ctrl, control, command,

Command()
Control
Option(alt)
Shift
Caps Lock(大写)
fn 功能键就是fn(不支持)
↩︎ return/enter
space 空格键

修饰键判断

可以对下面的修饰键判断 shift alt option ctrl control command,特别注意+=键值相同,组合键设置⌘+=

hotkeys('shift+a,alt+d, w', function(e){  console.log('干点活儿',e);  if(hotkeys.shift) console.log('您摁下了 shift 键!');  if(hotkeys.ctrl) console.log('您摁下了 ctrl 键!');  if(hotkeys.alt) console.log('您摁下了 alt 键!');  if(hotkeys.option) console.log('您摁下了 option 键!');  if(hotkeys.control) console.log('您摁下了 control 键!');  if(hotkeys.cmd) console.log('您摁下了 cmd 键!');  if(hotkeys.command) console.log('您摁下了 command 键!');});

定义快捷键

hotkeys([keys:<String>], [option:[string|object|function]], [callback:<function>])

// 定义 F5 快捷键hotkeys('f5', function(event,handler){  //event.srcElement: input   //event.target: input  // 阻止WINDOWS系统下的默认刷新事件  event.preventDefault()   alert('你按下了 F5 键!') });// 返回 false 将停止活动,并阻止默认浏览器事件// Mac OS 系统 定义 `command+r` 为刷新快捷键hotkeys('ctrl+r, command+r', function(){  alert('停止刷新!');  return false;});// 定义a快捷键hotkeys('a', function(event,handler){  //event.srcElement: input   //event.target: input  if(event.target === "input"){    alert('你在输入框中按下了 a!')  }  alert('你按下了 a!') });// 定义 ctrl+a、ctrl+b、r、f 四组快捷键hotkeys('ctrl+a,ctrl+b,r,f', function(event,handler){  switch(handler.key){    case "ctrl+a": alert('你按下了ctrl+a!'); break;    case "ctrl+b": alert('你按下了ctrl+b!'); break;    case "r": alert('你按下了r!'); break;    case "f": alert('你按下了f!'); break;  }  //handler.scope 范围});// 多个快捷方式做同样的事情hotkeys('⌘+r, ctrl+r', function(){ });// 对所有摁键执行任务hotkeys('*','wcj', function(e){  console.log('干点活儿',e);  console.log("key.getScope()::",hotkeys.getScope());  if(hotkeys.shift) console.log('大哥你摁下了 shift 键!');  if(hotkeys.ctrl) console.log('大哥你摁下了 ctrl 键!');  if(hotkeys.alt) console.log('大哥你摁下了 alt 键!');});// 可以设置自定义的分割符hotkeys('ctrl-y, ctrl-a', {splitKey: '-'}, function(e){  console.log('you press bind keys')})

option

  • scope<String>
  • element<HTMLElement>
  • keyup<Boolean>
  • keydown<Boolean>
hotkeys('o, enter', {  scope: 'wcj',  element: document.getElementById('warpper'),}, function(){   console.log('do something else');});

切换快捷键

如果在单页面在不同的区域,相同的快捷键,干不同的事儿,之间来回切换。O(∩_∩)O !

// 一个快捷键,有可能干的活儿不一样哦hotkeys('ctrl+o, ctrl+alt+enter', 'scope1', function(){  console.log('你好看');});hotkeys('ctrl+o, enter', 'scope2', function(){   console.log('你好丑陋啊!');});// 你摁 “ctrl+o”组合键// 当scope等于 scope1 ,执行 回调事件打印出 “你好看”,// 当scope等于 scope2 ,执行 回调事件打印出 “你好丑陋啊!”,// 通过setScope设定范围scopehotkeys.setScope('scope1'); // 默认所有事儿都干哦

标记快捷键范围

删除 区域范围标记

hotkeys.deleteScope('scope1');

获取 区域范围标记

hotkeys.getScope();

设置 区域范围标记

hotkeys.setScope('scope1');

解除绑定

hotkeys.unbind() 解除绑定的所有快捷键hotkeys.unbind("ctrl+o, ctrl+alt+enter") 解除绑定两组快捷键
hotkeys.unbind("ctrl+o","files") 解除绑定名字叫files钟的一组快捷键

// 解除绑定 'a' 程序函数hotkeys.unbind('a');// 仅针对单个范围解除绑定快捷键// 如果未指定范围,则默认为当前范围(hotkeys.getScope())hotkeys.unbind('o, enter', 'issues');hotkeys.unbind('o, enter', 'files');

通过函数来解除绑定

function example(){}hotkeys('a', example);hotkeys.unbind('a', example);hotkeys('a', 'issues', example);hotkeys.unbind('a', 'issues', example);
可以通过传入对象解除绑定的快捷键hotkeys.unbind({  key: 'ctrl-e,ctrl-u',  scope: 'issues',  spitKey: '-'})传入数组可同时解除多个scope下绑定的快捷键hotkeys.unbind([  {    key: 'a, ctrl+r',    scope: 'issues',  },  {    key: '+, ctrl-y',    scope: 'test',    splitKey: '-'  }])

键判断

判断摁下的键是否为某个键

hotkeys('a', function(){  console.log(hotkeys.isPressed("a")); //=> true  console.log(hotkeys.isPressed("A")); //=> true  console.log(hotkeys.isPressed(65)); //=> true});

获取摁下键值

获取摁下绑定键的键值 hotkeys.getPressedKeyCodes()

hotkeys('command+ctrl+shift+a,f', function(){  console.log(hotkeys.getPressedKeyCodes()); //=> [17, 65] 或者 [70]})

keyup

key downkey up 将都执行回调事件。

hotkeys('ctrl+a,alt+a+s', { keyup: true }, (evn, handler) => {  if(evn.type === 'keydown') {    console.log('keydown:', evn.type, handler, handler.key);  }  if(evn.type === 'keyup') {    console.log('keyup:', evn.type, handler, handler.key);  }});

过滤

INPUT SELECT TEXTAREA 默认不处理。hotkeys.filter 返回 true 快捷键设置才会起作用,false 快捷键设置失效。

hotkeys.filter = function(event){  return true;}// 如何增加过滤可编辑标签 <div contentEditable="true"></div>// contentEditable老浏览器不支持滴hotkeys.filter = function(event) {  var tagName = (event.target || event.srcElement).tagName;  return !(tagName.isContentEditable ||  tagName == 'INPUT' ||  tagName == 'SELECT' ||  tagName == 'TEXTAREA');}//hotkeys.filter = function(event){  var tagName = (event.target || event.srcElement).tagName;  hotkeys.setScope(/^(INPUT|TEXTAREA|SELECT)$/.test(tagName) ? 'input' : 'other');  return true;}

兼容模式

var k = hotkeys.noConflict();k('a', function() {  console.log("这里可以干一些事儿")});hotkeys()// -->Uncaught TypeError: hotkeys is not a function(anonymous function)// @ VM2170:2InjectedScript._evaluateOn// @ VM2165:883InjectedScript._evaluateAndWrap// @ VM2165:816InjectedScript.evaluate @ VM2165:682

开发

安装依赖,运行自重载构建,获取代码:

$ git https://github.com/jaywcjlove/hotkeys.git$ cd hotkeys     # 进入目录$ npm install    # 或者使用 yarn install 安装依赖

运行下面命令自动重载构建:

$ npm run watch

运行稳定环境

$ npm run doc

如果要贡献,请 fork Hotkeys.js, 并添加您的测试代码(在 test 目录中),并提交一个 PR。

$ npm run test$ npm run test:watch # Development model

License

MIT © Kenny Wong


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap