documentation/button.md

   1 # Button
   2
   3 VimFx has a toolbar button. It looks like this: ![VimFx button icon].
   4
   5 If you focus a text input, the icon is greyed out. This is to show that your
   6 keypresses will be passed into the text input rather than activating VimFx
   7 commands. (Except _some_ commands: See the [`<force>`] special key.)
   8
   9 When in Normal mode, clicking it opens VimFx’s Keyboard Shortcuts help dialog,
  10 just like the `?` shortcut does.
  11
  12 In other [modes], clicking it returns you to normal mode. If you feel like VimFx
  13 does not respond to any of your keypresses, it might be because you’re not in
  14 Normal mode. If you don’t know how to exit that mode (or have accidentally
  15 removed the keyboard shortcut to do so), clicking the button is the way to
  16 “escape” back to Normal mode. (On such occasions, you can hover the button and
  17 its tooltip will say what mode you’re currently in.)
  18
  19 In Ignore mode, the icon also turns red, like this: ![VimFx button icon red].
  20 ([Blacklisted] sites enter Ignore mode automatically.) The reason is that the
  21 whole point of Ignore mode is to “ignore” all of VimFx’s commands, passing your
  22 keypresses to the page instead. It is helpful to know that you’re really in
  23 Ignore mode, so you can be confident that your keypresses do what you expect
  24 them to. (See [Styling] if you’d like to highlight Ignore mode, or any mode for
  25 that matter, some other way.)
  26
  27 Other [modes] are easily detectable. You know that you’re in Find mode if the
  28 find bar is focused. If there are hint markers visible for the page, you’re in
  29 Hints mode. Finally, if there’s a blinking caret outside a text input, you’re in
  30 Caret mode.
  31
  32 A quick takeaway from this part of the documentation: **If you don’t know what’s
  33 going on, look for VimFx’s toolbar button.** It can often help you.
  34
  35 [VimFx button icon]: ../extension/skin/icon16.png
  36 [VimFx button icon red]: ../extension/skin/icon16-red.png
  37 [`<force>`]: shortcuts.md#force
  38 [modes]: modes.md
  39 [Blacklisted]: options.md#blacklist
  40 [Styling]: styling.md