1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
# This overrides the HelpDialog implementation in vimium_frontend.coffee, which prevents us from being able
# to spawn a help dialog within the help dialog UIComponent. As such, we need to provide all the properties
# that we expect on the normal HelpDialog implementation.
#
# NOTE(mrmr1993): In the future, we can move to a single help dialog UIComponent per tab (ie. in the
# top-level frame), and then we don't need to be concerned about nested help dialog frames.
HelpDialog =
dialogElement: null
showing: true
# This setting is pulled out of local storage. It's false by default.
getShowAdvancedCommands: -> Settings.get("helpDialog_showAdvancedCommands")
init: ->
return if @dialogElement?
@dialogElement = document.getElementById "vimiumHelpDialog"
@dialogElement.getElementsByClassName("closeButton")[0].addEventListener("click", (clickEvent) =>
clickEvent.preventDefault()
@hide()
false)
@dialogElement.getElementsByClassName("optionsPage")[0].addEventListener("click", (clickEvent) ->
clickEvent.preventDefault()
chrome.runtime.sendMessage({handler: "openOptionsPageInNewTab"})
false)
@dialogElement.getElementsByClassName("toggleAdvancedCommands")[0].addEventListener("click",
HelpDialog.toggleAdvancedCommands, false)
document.documentElement.addEventListener "click", (event) =>
@hide() unless @dialogElement.contains event.target
, false
isReady: -> true
show: (html) ->
for own placeholder, htmlString of html
@dialogElement.querySelector("#help-dialog-#{placeholder}").innerHTML = htmlString
@showAdvancedCommands(@getShowAdvancedCommands())
# When command names are shown, clicking on them copies their text to the clipboard (and they can be
# clicked with link hints).
for element in @dialogElement.getElementsByClassName "commandName"
do (element) ->
element.setAttribute "role", "link"
element.addEventListener "click", ->
commandName = element.textContent.replace("(","").replace ")", ""
chrome.runtime.sendMessage handler: "copyToClipboard", data: commandName
HUD.showForDuration("Yanked #{commandName}.", 2000)
@exitOnEscape = new Mode name: "help-page-escape", exitOnEscape: true
@exitOnEscape.onExit (event) =>
HelpDialog.hide() if event?.type == "keydown"
hide: ->
@exitOnEscape?.exit()
UIComponentServer.postMessage "hide"
toggle: (html) ->
if @showing then @hide() else @show html
#
# Advanced commands are hidden by default so they don't overwhelm new and casual users.
#
toggleAdvancedCommands: (event) ->
event.preventDefault()
showAdvanced = HelpDialog.getShowAdvancedCommands()
HelpDialog.showAdvancedCommands(!showAdvanced)
Settings.set("helpDialog_showAdvancedCommands", !showAdvanced)
showAdvancedCommands: (visible) ->
HelpDialog.dialogElement.getElementsByClassName("toggleAdvancedCommands")[0].innerHTML =
if visible then "Hide advanced commands" else "Show advanced commands"
# Add/remove the showAdvanced class to show/hide advanced commands.
addOrRemove = if visible then "add" else "remove"
HelpDialog.dialogElement.classList[addOrRemove] "showAdvanced"
UIComponentServer.registerHandler (event) ->
return if event.data == "hide"
HelpDialog.init()
HelpDialog.show event.data
root = exports ? window
root.HelpDialog = HelpDialog
|
