Skip to content
This repository has been archived by the owner on May 9, 2022. It is now read-only.

guardian/scribe-plugin-toolbar

Repository files navigation

scribe-plugin-toolbar Build Status

A toolbar of buttons and shortcuts for Scribe

Installation

bower install scribe-plugin-toolbar

Alternatively, you can access the distribution files through GitHub releases.

Usage Example

scribe-plugin-toolbar is an AMD module:

require(['scribe', 'scribe-plugin-toolbar'], function (Scribe, scribePluginToolbar) {
  var scribeElement = document.querySelector('.scribe');
  // Create an instance of Scribe
  var scribe = new Scribe(scribeElement);

  var toolbarElement = document.querySelector('.toolbar');
  scribe.use(scribePluginToolbar(toolbarElement));
});

For more documentation see the project wiki

Options

Set the shared key to true to enable the shared toolbar functionality.

Development

After cloning the repo:

  • npm install
  • bower install
  • npm run test

If the tests run green then you are good to start developing