mirror of
https://github.com/atom/atom.git
synced 2026-02-02 02:35:00 -05:00
118 lines
3.7 KiB
CoffeeScript
118 lines
3.7 KiB
CoffeeScript
_ = require 'underscore-plus'
|
|
{Disposable, CompositeDisposable} = require 'event-kit'
|
|
Tooltip = null
|
|
|
|
# Essential: Associates tooltips with HTML elements or selectors.
|
|
#
|
|
# You can get the `TooltipManager` via `atom.tooltips`.
|
|
#
|
|
# ## Examples
|
|
#
|
|
# The essence of displaying a tooltip
|
|
#
|
|
# ```coffee
|
|
# # display it
|
|
# disposable = atom.tooltips.add(div, {title: 'This is a tooltip'})
|
|
#
|
|
# # remove it
|
|
# disposable.dispose()
|
|
# ```
|
|
#
|
|
# In practice there are usually multiple tooltips. So we add them to a
|
|
# CompositeDisposable
|
|
#
|
|
# ```coffee
|
|
# {CompositeDisposable} = require 'atom'
|
|
# subscriptions = new CompositeDisposable
|
|
#
|
|
# div1 = document.createElement('div')
|
|
# div2 = document.createElement('div')
|
|
# subscriptions.add atom.tooltips.add(div1, {title: 'This is a tooltip'})
|
|
# subscriptions.add atom.tooltips.add(div2, {title: 'Another tooltip'})
|
|
#
|
|
# # remove them all
|
|
# subscriptions.dispose()
|
|
# ```
|
|
#
|
|
# You can display a key binding in the tooltip as well with the
|
|
# `keyBindingCommand` option.
|
|
#
|
|
# ```coffee
|
|
# disposable = atom.tooltips.add @caseOptionButton,
|
|
# title: "Match Case"
|
|
# keyBindingCommand: 'find-and-replace:toggle-case-option'
|
|
# keyBindingTarget: @findEditor.element
|
|
# ```
|
|
module.exports =
|
|
class TooltipManager
|
|
defaults:
|
|
delay:
|
|
show: 1000
|
|
hide: 100
|
|
container: 'body'
|
|
html: true
|
|
placement: 'auto top'
|
|
viewportPadding: 2
|
|
|
|
constructor: ({@keymapManager}) ->
|
|
|
|
# Essential: Add a tooltip to the given element.
|
|
#
|
|
# * `target` An `HTMLElement`
|
|
# * `options` See http://getbootstrap.com/javascript/#tooltips-options for a
|
|
# full list of options. You can also supply the following additional options:
|
|
# * `title` A {String} or {Function} to use for the text in the tip. If
|
|
# given a function, `this` will be set to the `target` element.
|
|
# * `trigger` A {String} that's the same as Bootstrap 'click | hover | focus
|
|
# | manual', except 'manual' will show the tooltip immediately.
|
|
# * `keyBindingCommand` A {String} containing a command name. If you specify
|
|
# this option and a key binding exists that matches the command, it will
|
|
# be appended to the title or rendered alone if no title is specified.
|
|
# * `keyBindingTarget` An `HTMLElement` on which to look up the key binding.
|
|
# If this option is not supplied, the first of all matching key bindings
|
|
# for the given command will be rendered.
|
|
#
|
|
# Returns a {Disposable} on which `.dispose()` can be called to remove the
|
|
# tooltip.
|
|
add: (target, options) ->
|
|
if target.jquery
|
|
disposable = new CompositeDisposable
|
|
disposable.add @add(element, options) for element in target
|
|
return disposable
|
|
|
|
Tooltip ?= require './tooltip'
|
|
|
|
{keyBindingCommand, keyBindingTarget} = options
|
|
|
|
if keyBindingCommand?
|
|
bindings = @keymapManager.findKeyBindings(command: keyBindingCommand, target: keyBindingTarget)
|
|
keystroke = getKeystroke(bindings)
|
|
if options.title? and keystroke?
|
|
options.title += " " + getKeystroke(bindings)
|
|
else if keystroke?
|
|
options.title = getKeystroke(bindings)
|
|
|
|
tooltip = new Tooltip(target, _.defaults(options, @defaults))
|
|
|
|
hideTooltip = ->
|
|
tooltip.leave(currentTarget: target)
|
|
tooltip.hide()
|
|
|
|
window.addEventListener('resize', hideTooltip)
|
|
|
|
disposable = new Disposable ->
|
|
window.removeEventListener('resize', hideTooltip)
|
|
hideTooltip()
|
|
tooltip.destroy()
|
|
|
|
disposable
|
|
|
|
humanizeKeystrokes = (keystroke) ->
|
|
keystrokes = keystroke.split(' ')
|
|
keystrokes = (_.humanizeKeystroke(stroke) for stroke in keystrokes)
|
|
keystrokes.join(' ')
|
|
|
|
getKeystroke = (bindings) ->
|
|
if bindings?.length
|
|
"<span class=\"keystroke\">#{humanizeKeystrokes(bindings[0].keystrokes)}</span>"
|