Skip to content

🏃 Vue.js directive to add a document event listener on escape keyup.

License

Notifications You must be signed in to change notification settings

ianaya89/vue-esc

Repository files navigation

vue-esc

🏃 Vue.js directive to add a document event listener on escape keyup.

Codeship Status for ianaya89/vue-esc Coverage Status Codacy Badge

Support

  • Vue.js 2 => vue-esc@>=2.0.0 [master]
  • Vue.js 1 => vue-esc@1.0.0

Install

$ npm i -S vue-esc
$ yarn add vue-esc

Use

// main.js

import Vue from 'vue';
import VueEsc from 'vue-esc';

Vue.use(VueEsc);
<script>
  // Component.vue

  export default {
    name: 'Component',

    methods: {
      escape(event) {
        console.log('Esc key pressed.', `Event: ${event}`);
      }
    }
  };
</script>

<template>
  <div v-esc="escape"></div>
</template>

Development

# install dependencies
$ npm install

# dev mode
$ npm run dev

# test
$ npm run test

# build
$ npm run build

License

MIT License

Style

js-standard-style


This project was built with yeoman and generator-vue-component ❤️

About

🏃 Vue.js directive to add a document event listener on escape keyup.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published