vue-focus
Version:
A set of reusable focus directives for reusable Vue.js components
95 lines (62 loc) • 2.86 kB
Markdown
> A reusable focus directive for reusable [Vue.js](https://github.com/vuejs/vue) components
[](https://www.npmjs.com/package/vue-focus)
It can be tricky to manage input focus. You always have to fall back to accessing DOM elements and calling `.focus` or `.blur` on them.
Well not anymore. `vue-focus` lets you manage focus from the safety of your view model.
[](https://jsfiddle.net/simplesmiler/k5vxp69o/), [read the docs](#api) or [file an issue](https://github.com/simplesmiler/vue-focus/issues).
- Focus the field when the modal windows appears
- Track the focus to show a hint for the focused field
- Move between fields with cursor keys
- Implement custom focus-related controls (e.g labels)
## Requirements
- vue: ^2.0.0
If you need a version for Vue 1, try `vue-focus@1.0`.
## Install
From npm:
``` sh
$ npm install vue-focus --save
```
From CDN:
``` html
<script src="https://cdnjs.cloudflare.com/ajax/libs/vue-focus/2.1.0/vue-focus.js"></script>
<!-- OR -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/vue-focus/2.1.0/vue-focus.min.js"></script>
```
A directive that binds focus to the expression in a one-way manner, so that the element receives focus when the expression is `truthy` and loses focus when the expression is `falsy`.
``` js
import { focus } from 'vue-focus';
export default {
directives: { focus: focus },
template: '<input type="text" v-focus="focused" @focus="focused = true" @blur="focused = false">',
data: function() {
return {
focused: false,
};
},
};
```
> NOTE: As opposed to 1.x, in Vue 2.0, directives are updated every time the host component rerenders, not just when the directive expression chages. Somethimes this may be undesirable, especially for the "autofocus" use case. If you want to mimic the 1.x behavior, then add the `.lazy` modifier to the directive, e.g. `v-focus.lazy="true"`.
A mixin that makes the `v-focus` directive available to the component under the default name.
``` js
import { mixin as focusMixin } from 'vue-focus';
export default {
mixins: [ focusMixin ],
template: '<input type="text" v-focus="focused" @focus="focused = true" @blur="focused = false">',
data: function() {
return {
focused: false,
};
},
};
```
1. Although you can write an input that gains focus immediately after loosing it, this is not recommended, as two such inputs will fall into infinite recursion and freeze the browser.
Form elements are not the only elements that are able to receive focus. The list also includes links, elements with `tabindex` attribute set and elements with `contentEditable` set to `true`.
[](https://opensource.org/licenses/MIT)