demo-mode

• Show keystroke and command on hover indicator.
• Intended to be used for atom package author to create explanatory GIF animation.
• Initially created for vim-mode-plus and extracted to make this generally available.

Development State

alpha

Commands

• demo-mode:toggle: Start or stop, auto-hide based on autoHideTimeout setting.
• demo-mode:toggle-auto-hide:: Toggle autoHide config value via command, also apply new value to currently displayed hover.
• demo-mode:clear: Clear(= fadeout ) displayed keystrokes.
• demo-mode:move-hover-up: Move hover, position is remembered until deactivate package.
• demo-mode:move-hover-down: Move hover, position is remembered until deactivate package.
• demo-mode:move-hover-left: Move hover, position is remembered until deactivate package.
• demo-mode:move-hover-right: Move hover, position is remembered until deactivate package.
• Also you can move hover by mouse drag.

Mouse

• Can move hover by drag.
• Can toggle-auto-hide by double click.

Keymap( keymap.cson )

No keymap by default. Find it by yourself.

Example keymap

'atom-text-editor.vim-mode-plus.normal-mode':
  'space d s': 'demo-mode:toggle'

'atom-workspace.demo-mode-active atom-text-editor:not([mini])':
  'up': 'demo-mode:move-hover-up'
  'down': 'demo-mode:move-hover-down'
  'left': 'demo-mode:move-hover-left'
  'right': 'demo-mode:move-hover-right'

  'space d !': 'demo-mode:toggle-auto-hide'
  'space d d': 'demo-mode:clear'

Style customization example

.demo-mode-container {
  min-width: 30em;
  font-family: "Ricty";
  .keystroke {
    font-size: 1.5em;
  }
}

Service consumer example.

demo-mode currently provide, onWillAddItem service which package author can to add extra information.

See vim-mode-plus project for practical use-case.