what-input 5.2.12 → 6.0.0

package/src/scripts/what-input.js

@@ -1,482 +0,0 @@
-module.exports = (() => {
-  /*
-   * bail out if there is no document or window
-   * (i.e. in a node/non-DOM environment)
-   *
-   * Return a stubbed API instead
-   */
-  if (typeof document === 'undefined' || typeof window === 'undefined') {
-    return {
-      // always return "initial" because no interaction will ever be detected
-      ask: () => 'initial',
-
-      // always return null
-      element: () => null,
-
-      // no-op
-      ignoreKeys: () => {},
-
-      // no-op
-      specificKeys: () => {},
-
-      // no-op
-      registerOnChange: () => {},
-
-      // no-op
-      unRegisterOnChange: () => {}
-    }
-  }
-
-  /*
-   * variables
-   */
-
-  // cache document.documentElement
-  const docElem = document.documentElement
-
-  // currently focused dom element
-  let currentElement = null
-
-  // last used input type
-  let currentInput = 'initial'
-
-  // last used input intent
-  let currentIntent = currentInput
-
-  // UNIX timestamp of current event
-  let currentTimestamp = Date.now()
-
-  // check for a `data-whatpersist` attribute on either the `html` or `body` elements, defaults to `true`
-  let shouldPersist = false
-
-  // form input types
-  const formInputs = ['button', 'input', 'select', 'textarea']
-
-  // empty array for holding callback functions
-  const functionList = []
-
-  // list of modifier keys commonly used with the mouse and
-  // can be safely ignored to prevent false keyboard detection
-  let ignoreMap = [
-    16, // shift
-    17, // control
-    18, // alt
-    91, // Windows key / left Apple cmd
-    93 // Windows menu / right Apple cmd
-  ]
-
-  let specificMap = []
-
-  // mapping of events to input types
-  const inputMap = {
-    keydown: 'keyboard',
-    keyup: 'keyboard',
-    mousedown: 'mouse',
-    mousemove: 'mouse',
-    MSPointerDown: 'pointer',
-    MSPointerMove: 'pointer',
-    pointerdown: 'pointer',
-    pointermove: 'pointer',
-    touchstart: 'touch',
-    touchend: 'touch'
-  }
-
-  // boolean: true if the page is being scrolled
-  let isScrolling = false
-
-  // store current mouse position
-  const mousePos = {
-    x: null,
-    y: null
-  }
-
-  // map of IE 10 pointer events
-  const pointerMap = {
-    2: 'touch',
-    3: 'touch', // treat pen like touch
-    4: 'mouse'
-  }
-
-  // check support for passive event listeners
-  let supportsPassive = false
-
-  try {
-    const opts = Object.defineProperty({}, 'passive', {
-      get: () => {
-        supportsPassive = true
-      }
-    })
-
-    window.addEventListener('test', null, opts)
-  } catch (e) {
-    // fail silently
-  }
-
-  /*
-   * set up
-   */
-
-  const setUp = () => {
-    // add correct mouse wheel event mapping to `inputMap`
-    inputMap[detectWheel()] = 'mouse'
-
-    addListeners()
-  }
-
-  /*
-   * events
-   */
-
-  const addListeners = () => {
-    // `pointermove`, `MSPointerMove`, `mousemove` and mouse wheel event binding
-    // can only demonstrate potential, but not actual, interaction
-    // and are treated separately
-    const options = supportsPassive ? { passive: true, capture: true } : true
-
-    document.addEventListener('DOMContentLoaded', setPersist, true)
-
-    // pointer events (mouse, pen, touch)
-    if (window.PointerEvent) {
-      window.addEventListener('pointerdown', setInput, true)
-      window.addEventListener('pointermove', setIntent, true)
-    } else if (window.MSPointerEvent) {
-      window.addEventListener('MSPointerDown', setInput, true)
-      window.addEventListener('MSPointerMove', setIntent, true)
-    } else {
-      // mouse events
-      window.addEventListener('mousedown', setInput, true)
-      window.addEventListener('mousemove', setIntent, true)
-
-      // touch events
-      if ('ontouchstart' in window) {
-        window.addEventListener('touchstart', setInput, options)
-        window.addEventListener('touchend', setInput, true)
-      }
-    }
-
-    // mouse wheel
-    window.addEventListener(detectWheel(), setIntent, options)
-
-    // keyboard events
-    window.addEventListener('keydown', setInput, true)
-    window.addEventListener('keyup', setInput, true)
-
-    // focus events
-    window.addEventListener('focusin', setElement, true)
-    window.addEventListener('focusout', clearElement, true)
-  }
-
-  // checks if input persistence should happen and
-  // get saved state from session storage if true (defaults to `false`)
-  const setPersist = () => {
-    shouldPersist = !(
-      docElem.getAttribute('data-whatpersist') === 'false' ||
-      document.body.getAttribute('data-whatpersist') === 'false'
-    )
-
-    if (shouldPersist) {
-      // check for session variables and use if available
-      try {
-        if (window.sessionStorage.getItem('what-input')) {
-          currentInput = window.sessionStorage.getItem('what-input')
-        }
-
-        if (window.sessionStorage.getItem('what-intent')) {
-          currentIntent = window.sessionStorage.getItem('what-intent')
-        }
-      } catch (e) {
-        // fail silently
-      }
-    }
-
-    // always run these so at least `initial` state is set
-    doUpdate('input')
-    doUpdate('intent')
-  }
-
-  // checks conditions before updating new input
-  const setInput = (event) => {
-    const eventKey = event.which
-    let value = inputMap[event.type]
-
-    if (value === 'pointer') {
-      value = pointerType(event)
-    }
-
-    const ignoreMatch =
-      !specificMap.length && ignoreMap.indexOf(eventKey) === -1
-
-    const specificMatch =
-      specificMap.length && specificMap.indexOf(eventKey) !== -1
-
-    let shouldUpdate =
-      (value === 'keyboard' && eventKey && (ignoreMatch || specificMatch)) ||
-      value === 'mouse' ||
-      value === 'touch'
-
-    // prevent touch detection from being overridden by event execution order
-    if (validateTouch(value)) {
-      shouldUpdate = false
-    }
-
-    if (shouldUpdate && currentInput !== value) {
-      currentInput = value
-
-      persistInput('input', currentInput)
-      doUpdate('input')
-    }
-
-    if (shouldUpdate && currentIntent !== value) {
-      // preserve intent for keyboard interaction with form fields
-      const activeElem = document.activeElement
-      const notFormInput =
-        activeElem &&
-        activeElem.nodeName &&
-        (formInputs.indexOf(activeElem.nodeName.toLowerCase()) === -1 ||
-          (activeElem.nodeName.toLowerCase() === 'button' &&
-            !checkClosest(activeElem, 'form')))
-
-      if (notFormInput) {
-        currentIntent = value
-
-        persistInput('intent', currentIntent)
-        doUpdate('intent')
-      }
-    }
-  }
-
-  // updates the doc and `inputTypes` array with new input
-  const doUpdate = (which) => {
-    docElem.setAttribute(
-      'data-what' + which,
-      which === 'input' ? currentInput : currentIntent
-    )
-
-    fireFunctions(which)
-  }
-
-  // updates input intent for `mousemove` and `pointermove`
-  const setIntent = (event) => {
-    let value = inputMap[event.type]
-
-    if (value === 'pointer') {
-      value = pointerType(event)
-    }
-
-    // test to see if `mousemove` happened relative to the screen to detect scrolling versus mousemove
-    detectScrolling(event)
-
-    // only execute if scrolling isn't happening
-    if (
-      ((!isScrolling && !validateTouch(value)) ||
-        (isScrolling && event.type === 'wheel') ||
-        event.type === 'mousewheel' ||
-        event.type === 'DOMMouseScroll') &&
-      currentIntent !== value
-    ) {
-      currentIntent = value
-
-      persistInput('intent', currentIntent)
-      doUpdate('intent')
-    }
-  }
-
-  const setElement = (event) => {
-    if (!event.target.nodeName) {
-      // If nodeName is undefined, clear the element
-      // This can happen if click inside an <svg> element.
-      clearElement()
-      return
-    }
-
-    currentElement = event.target.nodeName.toLowerCase()
-    docElem.setAttribute('data-whatelement', currentElement)
-
-    if (event.target.classList && event.target.classList.length) {
-      docElem.setAttribute(
-        'data-whatclasses',
-        event.target.classList.toString().replace(' ', ',')
-      )
-    }
-  }
-
-  const clearElement = () => {
-    currentElement = null
-
-    docElem.removeAttribute('data-whatelement')
-    docElem.removeAttribute('data-whatclasses')
-  }
-
-  const persistInput = (which, value) => {
-    if (shouldPersist) {
-      try {
-        window.sessionStorage.setItem('what-' + which, value)
-      } catch (e) {
-        // fail silently
-      }
-    }
-  }
-
-  /*
-   * utilities
-   */
-
-  const pointerType = (event) => {
-    if (typeof event.pointerType === 'number') {
-      return pointerMap[event.pointerType]
-    } else {
-      // treat pen like touch
-      return event.pointerType === 'pen' ? 'touch' : event.pointerType
-    }
-  }
-
-  // prevent touch detection from being overridden by event execution order
-  const validateTouch = (value) => {
-    const timestamp = Date.now()
-
-    const touchIsValid =
-      value === 'mouse' &&
-      currentInput === 'touch' &&
-      timestamp - currentTimestamp < 200
-
-    currentTimestamp = timestamp
-
-    return touchIsValid
-  }
-
-  // detect version of mouse wheel event to use
-  // via https://developer.mozilla.org/en-US/docs/Web/API/Element/wheel_event
-  const detectWheel = () => {
-    let wheelType = null
-
-    // Modern browsers support "wheel"
-    if ('onwheel' in document.createElement('div')) {
-      wheelType = 'wheel'
-    } else {
-      // Webkit and IE support at least "mousewheel"
-      // or assume that remaining browsers are older Firefox
-      wheelType =
-        document.onmousewheel !== undefined ? 'mousewheel' : 'DOMMouseScroll'
-    }
-
-    return wheelType
-  }
-
-  // runs callback functions
-  const fireFunctions = (type) => {
-    for (let i = 0, len = functionList.length; i < len; i++) {
-      if (functionList[i].type === type) {
-        functionList[i].fn.call(
-          this,
-          type === 'input' ? currentInput : currentIntent
-        )
-      }
-    }
-  }
-
-  // finds matching element in an object
-  const objPos = (match) => {
-    for (let i = 0, len = functionList.length; i < len; i++) {
-      if (functionList[i].fn === match) {
-        return i
-      }
-    }
-  }
-
-  const detectScrolling = (event) => {
-    if (mousePos.x !== event.screenX || mousePos.y !== event.screenY) {
-      isScrolling = false
-
-      mousePos.x = event.screenX
-      mousePos.y = event.screenY
-    } else {
-      isScrolling = true
-    }
-  }
-
-  // manual version of `closest()`
-  const checkClosest = (elem, tag) => {
-    const ElementPrototype = window.Element.prototype
-
-    if (!ElementPrototype.matches) {
-      ElementPrototype.matches =
-        ElementPrototype.msMatchesSelector ||
-        ElementPrototype.webkitMatchesSelector
-    }
-
-    if (!ElementPrototype.closest) {
-      do {
-        if (elem.matches(tag)) {
-          return elem
-        }
-
-        elem = elem.parentElement || elem.parentNode
-      } while (elem !== null && elem.nodeType === 1)
-
-      return null
-    } else {
-      return elem.closest(tag)
-    }
-  }
-
-  /*
-   * init
-   */
-
-  // don't start script unless browser cuts the mustard
-  // (also passes if polyfills are used)
-  if ('addEventListener' in window && Array.prototype.indexOf) {
-    setUp()
-  }
-
-  /*
-   * api
-   */
-
-  return {
-    // returns string: the current input type
-    // opt: 'intent'|'input'
-    // 'input' (default): returns the same value as the `data-whatinput` attribute
-    // 'intent': includes `data-whatintent` value if it's different than `data-whatinput`
-    ask: (opt) => {
-      return opt === 'intent' ? currentIntent : currentInput
-    },
-
-    // returns string: the currently focused element or null
-    element: () => {
-      return currentElement
-    },
-
-    // overwrites ignored keys with provided array
-    ignoreKeys: (arr) => {
-      ignoreMap = arr
-    },
-
-    // overwrites specific char keys to update on
-    specificKeys: (arr) => {
-      specificMap = arr
-    },
-
-    // attach functions to input and intent "events"
-    // funct: function to fire on change
-    // eventType: 'input'|'intent'
-    registerOnChange: (fn, eventType) => {
-      functionList.push({
-        fn: fn,
-        type: eventType || 'input'
-      })
-    },
-
-    unRegisterOnChange: (fn) => {
-      const position = objPos(fn)
-
-      if (position || position === 0) {
-        functionList.splice(position, 1)
-      }
-    },
-
-    clearStorage: () => {
-      window.sessionStorage.clear()
-    }
-  }
-})()

package/src/styles/_html.scss

@@ -1,49 +0,0 @@
-*,
-*::before,
-*::after {
-  box-sizing: border-box;
-}
-
-html {
-  -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
-}
-
-body {
-  color: #555;
-  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
-  margin: 0;
-  padding: 0;
-}
-
-a,
-button,
-input,
-select,
-textarea {
-  @include a11y-focus;
-}
-
-a {
-  color: #337ab7;
-  text-decoration: none;
-
-  @include hover {
-    text-decoration: underline;
-  }
-}
-
-h1 {
-  border-bottom: 1px solid #eee;
-  font-size: 36px;
-  font-weight: 500;
-  margin: 20px 0 10px;
-  padding-bottom: 9px;
-}
-
-p {
-  margin: ($unit * 2) 0;
-
-  @media (min-width: 800px) {
-    margin: ($unit * 3) 0;
-  }
-}