use-electron-context-menu

0 dependencies

Installation

npm install use-electron-context-menu

Note: If you prefer yarn instead of npm, just use yarn add use-electron-context-menu.

How to use

import React, { useRef } from "react"
import useContextMenu from "use-electron-context-menu"

export default function App() {
  const ref = useRef(null)

  useContextMenu(ref, [
    {
      label: "Copy",
      click: () => console.log("copied")
    }
  ])

  return (
    <div ref={ref} style={{ width: 200, height: 100 }}>
      {/* right clicking this area will spawn the context menu */}
    </div>
  )
}

API

const { closeMenu } = useContextMenu(ref, menuItems, options)

Parameters

• ref: React element you want to add the context menu to
• menuItems: An array of Electron menu items
• options: (optional) An object of options for this hook

Return Values

• closeMenu(): Force the context menu to close

Options

• x: Display context menu at fixed x coordinate
• y: Display context menu at fixed y coordinate
• onContext(event): Called when context menu opens
• onClose(): Called when context menu closes