aboutsummaryrefslogtreecommitdiffstats
path: root/content_scripts/vomnibar.coffee
diff options
context:
space:
mode:
Diffstat (limited to 'content_scripts/vomnibar.coffee')
-rw-r--r--content_scripts/vomnibar.coffee8
1 files changed, 8 insertions, 0 deletions
diff --git a/content_scripts/vomnibar.coffee b/content_scripts/vomnibar.coffee
index 0e19f194..7b3cfdbe 100644
--- a/content_scripts/vomnibar.coffee
+++ b/content_scripts/vomnibar.coffee
@@ -1,3 +1,6 @@
+#
+# This wraps the vomnibar iframe, which we inject into the page to provide the vomnibar.
+#
Vomnibar =
vomnibarElement: null
@@ -21,6 +24,11 @@ Vomnibar =
newTab: true
}
+ # This function opens the vomnibar. It accepts options, a map with the values:
+ # completer - The completer to fetch results from.
+ # query - Optional. Text to prefill the Vomnibar with.
+ # selectFirst - Optional, boolean. Whether to select the first entry.
+ # newTab - Optional, boolean. Whether to open the result in a new tab.
open: (options) ->
unless @vomnibarElement?
@vomnibarElement = document.createElement "iframe"