vue-tooltip-directive

A Vue 2 plugin that provides a custom directive allowing the usage of any tooltip component as a directive.

Currently built for Vuetify and depends on usage of their components' activator functionality, however I'm sure this could be adapted to handle others.

Usage

1. Install the npm dependency:
   npm install --save vue-tooltip-directive

2. Include the plugin into your Vue app by adding a Vue.use(..) in the root file of your Vue project (usually main.js/main.ts):

import Vue from 'vue'
import VueTooltipDirective from 'vue-tooltip-directive'

Vue.use(VueTooltipDirective)

3. You should now be able to use the directive in your project on any display component:

<span v-tooltip="'A cool and helpful tooltip!'">
  Hover me!
</span>

4. vue-tooltip-directive provides a default Tooltip component for you, but if you want to customize it you can simply create your own and pass it to the plugin as the component key in the config object:

import MyCustomTooltip from '@/components/MyCustomTooltip.vue'

Vue.use(VueTooltipDirective, {
  component: MyCustomTooltip
})

Configuration

The directive binding can be used in a few different ways:

• v-tooltip="'Basic explanatory tooltip'"
• v-tooltip:left="'Left aligned tooltip'"
• v-tooltip:[variable]="'Dynamically positioned tooltip'"
• v-tooltip="{ content: 'Config object tooltip', position: 'right', anyExtraProps: 'here!' }"

If no position is provided either via the directive argument or in the config object, it will default to top.
Any extra values provided in the config object will also be passed to your custom component as props.

Config options

| Field | Values | |----------|------------------------------------------| | content | string | | position | 'top' \| 'right' \| 'bottom' \| 'left' |

Contributing

All contributions are welcome via PR.
This is a hobby project and as such may feature bugs or performance issues, and you are welcome to help me diagnose or fix these.