cursor-helper

0.0.4 • Public • Published

cursor-helper

Cursor utility implementing all the different behaviors with priority between components




Example

Example on antoninlanglade.github.io/cursor-helper/



Features & Requirements



Module Installation & Usage

Installation from npm
# using npm 
$ npm install --save cursor-helper
 
# or using yarn 
$ yarn add cursor-helper
Usage with npm and a module bundler
import CursorHelper from 'cursor-helper' // ES6 module import
const CursorHelper = require('cursor-helper') // CommonJS module import
 
// Declaring a new cursor behavior cursor-example at index 10
const key = 'cursor-example'
CursorHelper.add(key, 10)
// Set cursor for this cursor
CursorHelper.setCursor(key, 'grab')
// Remove cursor
CursorHelper.remove(key)
 



Development commands

  • npm install - Install all npm dependencies
  • npm run start - Start the dev server with livereload on the example folder
  • npm run build - Bundle your library in CJS / UMD / ESM
  • npm run deploy - Deploy your example folder on a gh-page branch
  • npm run test - Lint your js inside the src folder



License

MIT.

Package

Packaged with https://github.com/pqml/brique ❤️

Package Sidebar

Install

npm i cursor-helper

Weekly Downloads

1

Version

0.0.4

License

MIT

Unpacked Size

341 kB

Total Files

10

Last publish

Collaborators

  • antoninlanglade