vue-direction

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 33 Open GitHub ↗

👋 Declarative, direction-aware hover in Vuejs

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# vue-direction

![Minified size](https://img.shields.io/bundlephobia/min/vue-direction.svg?style=plastic)

> Direction aware hover in Vuejs

![Usage](https://user-images.githubusercontent.com/38357771/53678998-b326c680-3c94-11e9-8e4f-f65feee8651f.gif)

[![Try it on codesandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/3x46lrlk1q)

## Installation

Install the component via npm by running `npm i vue-direction` or `yarn add vue-direction`.

## Usage

Import, register and place the component in your Vue app.

```html
<template>
  <VueDirection>
    <template slot-scope="{ mouseDirection }">
      
      {{ mouseDirection.x }}
      {{ mouseDirection.y }}
    </template>
  <VueDirection/>
</template>
```

```js
import VueDirection from 'vue-direction'

export default {
  components: {
    VueDirection,
  },
}
```

## Dev

Running `dev` script requires @vue/cli and @vue/cli-service-global to be installed. Install these globally by running `npm i --g @vue/cli @vue/cli-service-global` or `yarn add global vue/cli @vue/cli-service-global`.

## Contributing

This project is open to and encourages contributions! Feel free to discuss any bug fixes/features in the [issues](https://github.com/shwilliam/vue-direction/issues). If you wish to work on this project:

1.  [Fork the project](https://github.com/shwilliam/vue-direction/archive/master.zip)
2.  Create your feature branch (`git checkout -b new-feature-branch`)
3.  Commit your changes (`git commit -am 'add new feature'`)
4.  Push to the branch (`git push origin new-feature-branch`)
5.  [Submit a pull request!](https://github.com/shwilliam/vue-direction/pull/new/master)

vue-direction

Today's picks

Was this content helpful?

Recent Feedback

vue-direction

Today's picks

Was this content helpful?

Recent Feedback

Download README