Chapter 1: Getting Started

Chapter 2: Using Atom

Chapter 3: Hacking Atom

Chapter 4: Behind Atom

Reference: API

Appendix A: Resources

Appendix B: FAQ

Appendix C: Shadow DOM

Appendix D: Upgrading to 1.0 APIs

Appendix E: Atom server-side APIs

TooltipManager Essential

Associates tooltips with HTML elements or selectors.

You can get the TooltipManager via atom.tooltips.

Examples

The essence of displaying a tooltip

# 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

[CompositeDisposable](../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.

disposable = atom.tooltips.add @caseOptionButton,
  title: "Match Case"
  keyBindingCommand: 'find-and-replace:toggle-case-option'
  keyBindingTarget: @findEditor.element

Methods

::add(target, options)

Add a tooltip to the given element.

Argument Description

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.
Return values

Returns a Disposable on which .dispose() can be called to remove the tooltip.