Skip to content

Composition API Usage

Import and call the useVuePopper.

vue
<script>
import { useVuePopper } from '@kalimahapps/vue-popper';

const VuePopperOptions = {
	hover: false,
	showArrow: true,
	strategy: 'fixed'
}

const {
	popperInstance,
	triggerElement,
	tooltipElement,
	toggleTooltip
} = useVuePopper(VuePopperOptions);
</script>

As you notice, the useVuePopper returns an object with three properties:

  • popperInstance: The popper instance. It will give you access to the popper instance.
  • triggerElement: The trigger element. Use this to add the trigger element.
  • tooltipElement: The tooltip element. Use this to add the tooltip element.
  • toggleTooltip: A function to toggle the tooltip visibility. Optionally pass a value of ('hide' or 'show') to force the tooltip to hide or show.

We can use these in template to add the trigger and tooltip elements. Like this:

vue
<template>
	<div class="popper-container">
		<component :is="triggerElement">
			Click here for more info
		</component>

		<component :is="tooltipElement">
			More info
		</component>
	</div>
</template>

Released under the MIT License.