Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samypesse/react-electron-menu
React API to controls electron's menu
https://github.com/samypesse/react-electron-menu
electron javascript react
Last synced: 4 months ago
JSON representation
React API to controls electron's menu
- Host: GitHub
- URL: https://github.com/samypesse/react-electron-menu
- Owner: SamyPesse
- Created: 2017-02-12T20:08:54.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-29T01:24:11.000Z (over 4 years ago)
- Last Synced: 2024-10-28T06:34:17.938Z (4 months ago)
- Topics: electron, javascript, react
- Language: JavaScript
- Size: 42 KB
- Stars: 20
- Watchers: 2
- Forks: 10
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-electron-menu
[![NPM version](https://badge.fury.io/js/react-electron-menu.svg)](http://badge.fury.io/js/react-electron-menu)
[![Build Status](https://travis-ci.org/SamyPesse/react-electron-menu.png?branch=master)](https://travis-ci.org/SamyPesse/react-electron-menu)This modules provides a react API to create and manage electron's menus.
### Installation
```
$ npm install react-electron-menu --save
```### Usage
This module provides 2 types of menu: `WindowMenu` and `PopupMenu`.
##### `WindowMenu`
This menu type is displayed only for the currently focused window.
```js
const React = require('react');
const { render } = require('react-dom');
const { WindowMenu, MenuItem } = require('react-electron-menu');
const electron = require('electron');render(
,
document.body
)
```##### `PopupMenu`
This menu is shown on screen at `x` and `y`.
```js
const React = require('react');
const { render } = require('react-dom');
const { PopupMenu, MenuItem } = require('react-electron-menu');
const electron = require('electron');render(
,
document.body
)
```##### Default Menus
This module also provides helper to replicate default system's menus:
```js
const { DefaultEditMenu, DefaultFileMenu, DefaultWindowMenu, MenuItem } = require('react-electron-menu');// Menu file (app menu on Mac): includes window controls
// Menu edit: includes undo, redo, cut, copy, paste, select all
// Menu view: includes minimize, close, Bring All to Front
```