vjeux / tool-bar

Package providing customisable toolbar for Atom

Atom Tool Bar

This package provides extensible tool bar for Atom.

Note: this package by itself adds an empty toolbar. To propagate it with icons you can install plugins.

Configuration

Position

On which edge of the editor should the tool bar appear. Possible options:

• Top
• Right
• Bottom
• Left

Icon size

• Very Small (12px)
• Small (16px)
• Big (24px)
• Large (32px)

Visibility

• Visible
• Hidden

Full Width (available in Atom >= 1.7)

When on top/bottom, expand to full window width.

Plugins

• Flex Tool Bar
• Tool Bar Main
• Toolbar Almighty
• Toolbar for Atom
• Toolbar Shortcuts
• And more...

Packages using tool-bar

• Particle Dev
• Facebook Nuclide
• PlatformIO IDE

Integrating instructions

By itself this package shows an empty tool bar. To add buttons and spacers to the tool bar, follow the instructions below.

Package.json

Make sure the following properties are part of your package.json.

"consumedServices": {
  "tool-bar": {
    "versions": {
      "^0 || ^1": "consumeToolBar"
    }
  }
}

We recommend using Atom-Package-Deps in your package for installing dependency packages like this package.

Main package file

In your main package file, add the following methods and replace your-package-name with your package name.

let toolBar;

export function consumeToolBar(getToolBar) {
  toolBar = getToolBar('your-package-name');
  // Add buttons and spacers here...
}

export function deactivate() {
  if (toolBar) {
    toolBar.removeItems();
    toolBar = null;
  }
}

Example

let toolBar;

export function consumeToolBar(getToolBar) {
  toolBar = getToolBar('your-package-name');

  // Adding button
  toolBar.addButton({
    icon: 'octoface',
    callback: 'application:about',
    tooltip: 'About Atom'
  });

  // Adding spacer
  toolBar.addSpacer();

  // Using custom icon set (Ionicons)
  const button = toolBar.addButton({
    icon: 'gear-a',
    callback: 'application:show-settings',
    tooltip: 'Show Settings',
    iconset: 'ion'
  });

  // Disable button
  button.setEnabled(false);

  // Function with data in callback
  toolBar.addButton({
    icon: 'alert',
    callback(data) {
      alert(data);
    },
    tooltip: 'Show Alert',
    data: 'foo'
  });

  // Callback with modifiers
  toolBar.addButton({
    icon: 'octoface',
    callback: {
      '': 'application:cmd-1',      // Without modifiers is default action
      'alt': 'application:cmd-2',
      'ctrl': 'application:cmd-3',  // With function callback
      'shift'(data) {
        console.log(data);
      },
      'alt+shift': 'application:cmd-5',       // Multiple modifiers
      'alt+ctrl+shift': 'application:cmd-6'   // All modifiers 
    },
    data: 'foo'
  });

  // Adding spacer and button at the beginning of the tool bar
  toolBar.addSpacer({priority: 10});
  toolBar.addButton({
    icon: 'octoface',
    callback: 'application:about',
    priority: 10
  });

  // Cleaning up when tool bar is deactivated
  toolBar.onDidDestroy(() => {
    this.toolBar = null;
    // Teardown any stateful code that depends on tool bar ...
  });
}

Methods

.addButton({icon, callback, priority, tooltip, data})

The method addButton requires an object with at least the properties icon and callback. The icon can be any single icon from the iconset. The callback must be an Atom command string, an custom callback function or an object where the keys are key modifiers (alt, ctrl or shift) and the values are commands or custom function (see example).

The remaining properties tooltip (default there is no tooltip), iconset (defaults to Octicons), data and priority (defaults 50) are optional.

The return value of this method shares another method called setEnabled(enabled) to enable or disable the button.

.addSpacer({priority})

The method addSpacer has only one optional property priority (defaults 50).

.removeItems()

Use the method removeItems to remove the buttons added by your package. This is particular useful in your package deactivate method, but can be used at any time.

.onDidDestroy(callback)

The onDidDestroy method takes a function that will be called when the tool-bar package is destroyed. This is useful if your package needs to do cleanup when the tool-bar is deactivated but your package continues running.

Supported icon sets

• Octicons (Atom's flavour)
• Ionicons (ion)
• FontAwesome (fa)
• Foundation (fi)
• IcoMoon (icomoon)
• Devicon (devicon)
• MaterialDesignIcons (mdi)

Supported commands

• tool-bar:toggle
• tool-bar:position-top
• tool-bar:position-right
• tool-bar:position-bottom
• tool-bar:position-left

Authors

• Wojtek Siudzinski ^(owner)
• Jeroen van Warmerdam
• Ryo Narita

Contributors

Issues and pull requests are very welcome. Feel free to write your own packages using this one. For all contributions credits are due:

• Pascal Bihler
• Nikita Gusakov
• Carlos Santos
• Daniel Alejandro Cast
• James Coyle
• Andres Suarez