JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 6
  • Score
    100M100P100Q31990F
  • License MIT

Useful kit of Vue composition API utilities

Package Exports

  • vue-use-kit

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-use-kit) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vue-use-kit

NPM Version NPM Downloads Build Status GitHub license Demo

🌳 Vue kit of useful Vue Composition API functions.

Please note that Vue 3.0 has not been released yet, therefore the installation and setup of @vue/composition-api is required for this library to work.

Install

npm install @vue/composition-api vue-use-kit

Usage

Please check the documentation to learn how to use this kit of Vue Composition API functions.

APIs

  • Sensors
    • useHover — tracks mouse hover state of a given element. Demo
    • useMedia — tracks state of a CSS media query. Demo
    • useMouse — tracks the mouse position. Demo
    • useMouseElement — tracks the mouse position relative to given element. Demo
  • Animations
    • useTimeout — returns isReady true when timer is completed. Demo
    • useTimeoutFn — calls function when timer is completed. Demo
  • UI
    • useClickAway — triggers callback when user clicks outside target area. Demo
  • Utils
    • getQuery — get a CSS media query string. Demo

Inspiration

Made with