https://github.com/quentinroy/marking-menu

Marking Menu implementation in JavaScript
https://github.com/quentinroy/marking-menu

interaction marking-menu menu technique

Last synced: 5 days ago
JSON representation

Marking Menu implementation in JavaScript

• Host: GitHub
• URL: https://github.com/quentinroy/marking-menu
• Owner: QuentinRoy
• License: mit
• Created: 2017-07-19T10:48:16.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T16:43:46.000Z (17 days ago)
• Last Synced: 2024-10-31T17:58:07.063Z (15 days ago)
• Topics: interaction, marking-menu, menu, technique
• Language: JavaScript
• Homepage: https://quentinroy.github.io/Marking-Menu/
• Size: 2.41 MB
• Stars: 12
• Watchers: 2
• Forks: 2
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Marking Menu

[![NPM](https://img.shields.io/npm/v/marking-menu.svg)](https://www.npmjs.com/package/marking-menu)

[![Build Status](https://travis-ci.org/QuentinRoy/Marking-Menu.svg?branch=master)](https://travis-ci.org/QuentinRoy/Marking-Menu)

[![codecov](https://img.shields.io/codecov/c/github/QuentinRoy/Marking-Menu.svg)](https://codecov.io/gh/QuentinRoy/Marking-Menu)

This library is an implementation of Gordon Kurtenbach's infamous Marking Menus in JavaScript [[1](https://doi.org/10.1145/120782.120797), [2](http://doi.acm.org/10.1145/169059.169426), [3](http://doi.acm.org/10.1145/191666.191759)].

[Have a look at the **demo**](https://quentinroy.github.io/Marking-Menu/).

## License

This _codebase_ is licensed under the MIT license.

**However**, Marking Menus are concerned by several patents, none of which are owned by the author of this library.

Make sure you have the rights to include this library in your application before doing so.

The authors and contributors of this library may not be held responsible for any patent infringement following the use of this codebase.

## Dependencies

- [`rxjs`](http://reactivex.io/rxjs/).

## Install

### Browser with CDN

You can use [unpkg](https://unpkg.com) to fetch both [`rxjs`](http://reactivex.io/rxjs/) and `marking-menu`:

- https://unpkg.com/rxjs@7/dist/bundles/rxjs.umd.js,

- https://unpkg.com/marking-menu,

```html

  

    

    

    

      // Your stuff.

    

  

  

```

### ES modules or CommonJS

```sh

npm install -S marking-menu

```

Then (ES modules)

```js

import MarkingMenu from 'marking-menu';

```

or (CommonJS)

```js

var MarkingMenu = require('marking-menu');

```

## API

### `MarkingMenu(items, parentDOM): Observable`

`MarkingMenu` returns a 'hot' [`Observable`](https://github.com/tc39/proposal-observable) that emits notification of the form `{ name, angle }`. The menu is activated upon subscription of this observable, and disabled upon un-subscription.

- `items`: `Array` of `string` or `{ name, children }`. The list of the menu's items. If `children` is provided, the item will be considered as a sub-menu (`children` has the same form as `items`). Currently, `MarkingMenu` supports up to 8 items per level. The first item is on the right and the followings are layed out clockwise.

- `parentDOM`: `HTMLElement`. The container of the menu.

#### Example

```js

// Create the menu with a sub-menu at the bottom.

const items = [

  'Item Right',

  {

    name: 'Others...',

    children: ['Sub Right', 'Sub Down', 'Sub Left', 'Sub Top'],

  },

  'Item Left',

  'Item Up',

];

const mm = MarkingMenu(items, document.getElementById('main'));

// Subscribe (and activates) the menu.

const subscription = mm.subscribe((selection) => {

  // Do something.

  console.log(selection.name);

});

setTimeout(() => {

  // Later, disable the menu.

  subscription.unsubscribe();

}, 60 * 1000);

```