Skip to content

Commit

Permalink
rename to react-electron-menu-stable for now
Browse files Browse the repository at this point in the history
  • Loading branch information
wsmlby committed Jul 27, 2020
1 parent efeda2c commit 7de90c1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 83 deletions.
82 changes: 4 additions & 78 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,84 +1,10 @@
# react-electron-menu
# react-electron-menu-stable

[![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.
[![Forked From](https://github.com/SamyPesse/react-electron-menu)](https://github.com/SamyPesse/react-electron-menu)
This modules is forked from react-electron-menu, only difference is that on Win/Linux, WindowMenu will not disappear when the window lost focus.

### 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(
<Provider electron={electron}>
<WindowMenu>
<MenuItem label="File">
<MenuItem label="Open ..." onClick={...} />
</MenuItem>
</WindowMenu>
</Provider>,
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(
<Provider electron={electron}>
<PopupMenu x={200} y={100}>
<MenuItem label="Open ..." onClick={...} />
</PopupMenu>
</Provider>,
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
<DefaultFileMenu>
<MenuItem label="Check for updates..." />
</DefaultFileMenu>

// Menu edit: includes undo, redo, cut, copy, paste, select all
<DefaultEditMenu>
<MenuItem.Separator />
<MenuItem label="Entry at the bottom" />
</DefaultEditMenu>

// Menu view: includes minimize, close, Bring All to Front
<DefaultWindowMenu>
<MenuItem.Separator />
<MenuItem label="Toggle an app view" />
</DefaultWindowMenu>
$ npm install react-electron-menu-stable --save
```
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "react-electron-menu",
"version": "0.3.0",
"name": "react-electron-menu-stable",
"version": "0.3.1",
"main": "lib/index.js",
"author": "Samy Pesse <samypesse@gmailk.com>",
"author": "wsmlby@gmail.com",
"description": "React API to create menu for electron",
"bugs": "https://github.com/SamyPesse/react-electron-menu/issues",
"bugs": "https://github.com/wsmlby/react-electron-menu/issues",
"license": "Apache-2.0",
"dependencies": {
"react": "^15.4.2",
Expand All @@ -26,6 +26,6 @@
},
"repository": {
"type": "git",
"url": "https://github.com/SamyPesse/react-electron-menu.git"
"url": "https://github.com/wsmlby/react-electron-menu.git"
}
}

0 comments on commit 7de90c1

Please sign in to comment.