keyux/index.js

Improve keyboard UI of web apps

export * from './compat.js'
export * from './focus-group-polyfill.js'
export * from './focus-group.js'
export * from './hidden.js'
export * from './hotkey.js'
export * from './jump.js'
export * from './overrides.js'
export * from './press.js'

export function startKeyUX(window, plugins) {
  let unbinds = plugins.map(plugin => plugin(window))
  return () => {
    unbinds.forEach(unbind => unbind())
  }
}

export function likelyWithKeyboard(window = globalThis) {
  let agent = window.navigator.userAgent.toLowerCase()
  return !['iphone', 'ipad', 'android'].some(device => agent.includes(device))
}

export function getHotKeyHint(window, code, transformers = []) {
  let realCode = code
  for (let transformer of transformers) {
    realCode = transformer[1](realCode, window, 'r')
  }
  let prettyParts = realCode
    .split('+')
    .map(part => part[0].toUpperCase() + part.slice(1))
  if (window.navigator.platform.indexOf('Mac') === 0) {
    return prettyParts
      .join('')
      .replace(/(.*)Meta(.*)/, '⌘ $1$2')
      .replace(/(.*)Shift(.*)/, '⇧ $1$2')
      .replace(/(.*)Alt(.*)/, '⌥ $1$2')
      .replace(/(.*)Ctrl(.*)/, '⌃ $1$2')
  } else {
    return prettyParts.join(' + ')
  }
}