@yandeu/tap
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.3 • Public • Published

    🖱️ Tap

    Handling of user interactions such as mouse, touch and pointer events.
    (Inspired by tapjs)

    Installation

    npm install @yandeu/tap

    CDN

    https://unpkg.com/@yandeu/tap/umd/tap.min.js

    Usage

    // print the current version
    console.log('Tap VERSION: ', Tap.VERSION)
    
    // the element you want to listen for events (your canvas for example)
    const el = document.getElementById('myCanvas')
    
    // instantiate
    const tap = new Tap(el)
    
    // listen on down
    tap.on.down(({ position, event }) => {
      console.log('down', position, event)
    })
    
    // listen on move
    tap.on.move(({ position, event, dragging }) => {
      console.log('move', position, event)
    
      const isDragging = dragging
      console.log('Is pointer down while moving?', isDragging)
    })
    
    // listen on up
    tap.on.up(({ position, event }) => {
      console.log('up:', position, event)
    })
    
    // listen on down once
    tap.once.down(({ position, event }) => {
      console.log('down', position, event)
    })
    
    // check if down
    tap.isDown
    
    // get current position
    tap.currentPosition
    
    // get last position
    tap.lastPosition
    
    // is pointer lock available
    tap.pointerLock.available
    
    // is pointer locked
    tap.pointerLock.isLocked
    
    // listen for pointer lock change once (returns a Promise)
    tap.pointerLock.onceChange().then(event => {
      console.log(event)
    })
    
    // request pointer lock (returns a Promise)
    tap.pointerLock.request().then(event => {
      console.log(event)
    })
    
    // request pointer lock (returns a Promise)
    tap.pointerLock.exit().then(event => {
      console.log(event)
    })
    
    // check if paused
    tap.isPaused
    
    // pause all events (except .once())
    tap.pause()
    
    // resume all events
    tap.resume()
    
    // destroy all events once you are done
    tap.destroy()

    License

    MIT

    Install

    npm i @yandeu/tap

    DownloadsWeekly Downloads

    81

    Version

    0.0.3

    License

    MIT

    Unpacked Size

    38.7 kB

    Total Files

    22

    Last publish

    Collaborators

    • yandeu