README.md

use-context-menu

Check out the demo.

A custom React Hook that allows you to place custom context menu(s) (right click menu) throughout your codebase.

use-context-menu accepts two arguments, menu (req) and targets (optional), and will return a state object representing which menu isOpen. See demo for examples.

Features

⏳ Saves you time by handling all the annoying event listeners for you.

⭐️ Flexibility to make your own custom menus, we don't force a style on you!

🐑 Accepts multiple targets, giving you the ability to have multiple custom context menus per target on the same page!

Requirement

To use use-context-menu, you must use react@16.8.0 or greater which includes Hooks.

Installation

$ yarn add use-context-menu
// or
$ npm i use-context-menu

Example

NOTE: if no targets are passed the returned state key is automatically keyed as document and it is assumed that a right-click anywhere in the document should trigger the custom menu (see demo for additional examples/use cases).

import { useRef } from 'react';
import useContextMenu from 'use-context-menu';

const SomeComponent = () => {
  const menu = useRef(null);
  const { document } = useContextMenu({ menu });

  return {
    <>
      {document.isOpen && (
        <ul ref={menu}>
          <li onClick={doSomething}>Im a custom context menu element!<li>
          <li onClick={doSomething}>Style me however you like!<li>
          <li onClick={doSomething}>See demo for additional examples/ideas<li>
        </ul>
      )}
    </>
  };
};

export default SomeComponent;

Example with Multiple Targets:

import { useRef } from 'react';
import useContextMenu from 'use-context-menu';

const SomeComponent = () => {
  const menu = useRef(null);
  const targetOneRef = useRef(null);
  const targetTwoRef = useRef(null);

  const { targetOne, targetTwo } = useContextMenu({
    menu,
    targets: [
      { id: 'targetOne', target: targetOneRef },
      { id: 'targetTwo', target: targetTwoRef },
    ]
  });

  return {
    <>
      <span ref={targetOneRef}>
        target one (right click me for target one menu).
      </span>
      {targetOne.isOpen && (
        <ul ref={menu}>
          <li onClick={doSomething}>Im targetOnes custom menu<li>
        </ul>
      )}
      <span ref={targetTwoRef}>
        target two (right click me for target two menu).
      </span>
      {targetTwo.isOpen && (
        <ul ref={menu}>
          <li onClick={doSomething}>Im targetTwos custom menu.<li>
        </ul>
      )}
    </>
  };
};

export default SomeComponent;

FULL API

useContextMenu({ menu, targets }): MenuState

MenuState = { [targetId: string]: { isOpen: boolean } }

• useContextMenu returns a MenuState object that consists of keys based on the id you supply for each target object in the targets array. Thus, if you pass to targets argument an array like this: [{ id: 'customId', target: someRef }] it will return an object like this: { customId: { isOpen: boolean } }.
• Note: if no targets are passed the key defaults to document and should be used like this: menuState.document.isOpen (or de-structure it if you're so inclined).

menu: RefObject

• a ref to the menu element. This can be reused for multiple menus on same page. No need to create multiple menu refs! See demo for examples on multiple menus.

targets?: Target[]

• optional array of targets, with a unique id for each.
• Target = { id: string, target: RefObject };

License

MIT Licensed

Contributors

This project follows the all-contributors specification. Contributions of any kind welcome!