Go to file
Adam Weeden adcf21a3df
macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121)
When setting a media key (play, pause, next/previous track) as global shortcut in Mac OS 10.14+, accessibility permissions must be given to the app for it to work (see https://www.electronjs.org/docs/api/global-shortcut?q=MediaPlayPause#globalshortcutregisteraccelerator-callback).

This PR will accomplish the following on generated app launch:
- Check if global shortcuts are being setup
- Check if the host OS is Mac OS
- Check if the global shortcuts were one of the media keys
- If the above are true, check if the app has accessibility permissions
- If the app does not have the accessibility permissions it will ask the user if they would like to be prompted for these permissions, and then ask Mac OS to prompt for accessibility permissions.

~~As well, a new command line flag is added (`--no-accessibility-prompt`) to preventatively suppress these prompts if desired.~~

Screenshots of the new behavior:
![Screen Shot 2021-02-26 at 2 41 21 PM](https://user-images.githubusercontent.com/547567/109356260-76bfde00-784e-11eb-8c36-3a51b911b780.png)
![Screen Shot 2021-02-26 at 2 41 28 PM](https://user-images.githubusercontent.com/547567/109356266-79223800-784e-11eb-94eb-66437c05fd10.png)
![Screen Shot 2021-02-26 at 2 41 50 PM](https://user-images.githubusercontent.com/547567/109356270-7aebfb80-784e-11eb-9e90-e09bb49752c6.png)

Co-authored-by: Ronan Jouchet <ronan@jouchet.fr>
2021-02-28 10:24:14 -05:00
.github CI: avoid npm funding messages 2021-02-26 22:19:45 -05:00
app macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
docs macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
icon-scripts Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00
src macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
test-resources Revamp and move to TypeScript (#898) 2020-03-15 16:50:01 -04:00
.dockerignore macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
.editorconfig Integrate prettier 2018-05-24 00:02:44 -07:00
.eslintrc.js Move some tooling config (eslintignore, prettierrc) to package.json 2021-02-27 22:31:59 -05:00
.gitignore macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
.npmignore macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
.npmrc Upgrade dependencies and default to latest Electron 1.7.9 (PR #483) 2017-11-14 08:05:01 -05:00
CHANGELOG.md Update changelog for `v42.3.0` 2021-02-25 19:49:22 -05:00
Dockerfile Move to nativefier organization 2021-01-30 04:49:52 +00:00
LICENSE.md Split docs into multiple files 2016-03-13 15:27:32 +08:00
README.md Move to nativefier organization 2021-01-30 04:49:52 +00:00
package.json macOS: Prompt for accessibility permissions if needed by Global Shortcuts using Media Keys (Fix #1120) (PR #1121) 2021-02-28 10:24:14 -05:00
tsconfig.json TSConfig: bump to target/lib es2018, since we require node10 2021-02-26 22:50:59 -05:00

README.md

Nativefier

👋 dear users / contributors! Public service announcement!

Nativefier is maintained by YOU. It's reasonably sane to hack on nowadays, it fits the use cases needed by the original author and the current maintainer, so we are not doing any active development.

But it's alive! It at least follows Electron releases with maintenance patches, and if YOU use it and want to see juicy features & fixes, PR welcome! Help welcome in particular on our pinned issues, or any issue / feature that motivates you 🙂.

Thanks! Take care.


Build Status npm version

Dock

You want to make a native wrapper for WhatsApp Web (or any web page).

nativefier web.whatsapp.com

Walkthrough animation

You're done.

Introduction

Nativefier is a command-line tool to easily create a desktop app for any web site with minimal configuration. Apps are wrapped by Electron (which uses Chromium under the hood) in an OS executable (.app, .exe, etc) for use on Windows, macOS and Linux.

I did this because I was tired of having to ⌘-tab or alt-tab to my browser and then search through the numerous open tabs when I was using Facebook Messenger or Whatsapp Web (HN thread). Nativefier features:

  • Automatically retrieval of app icon / name.
  • JavaScript and CSS injection.
  • Many more, see the API docs or nativefier --help

Installation

  • macOS 10.9+ / Windows / Linux
  • Node.js >= 10 and npm >= 6
  • Optional dependencies:
    • ImageMagick to convert icons. Make sure convert and identify are in your system $PATH.
    • Wine to package Windows apps under non-Windows platforms. Make sure wine is in your system $PATH.

Then, install Nativefier globally with npm install -g nativefier

Usage

To create a native desktop app for medium.com, simply nativefier "medium.com"

Nativefier will try to determine the app name, and well as lots of other options. If desired, these options can be overwritten. For example, to override the name, nativefier --name 'My Medium App' 'medium.com'

Read the API documentation or run nativefier --help to learn about other command-line flags usable to configure the packaged app.

To have high-resolution icons used by default for an app/domain, please contribute to the icon repository!

Usage with Docker

Nativefier is also usable from Docker.

  • Pull the latest stable image from Docker Hub: docker pull nativefier/nativefier
  • ... or build the image yourself: docker build -t local/nativefier . (in this case, replace nativefier/ in the below examples with local/)

By default, the command nativefier --help will be executed. To build e.g. a Gmail nativefier app to a writable local ~/nativefier-apps,

docker run --rm -v ~/nativefier-apps:/target/ nativefier/nativefier https://mail.google.com/ /target/

You can pass Nativefier flags, and mount volumes to provide local files. For example, to use an icon,

docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/nativefier --icon /src/icon.png --name whatsApp -p linux -a x64 https://web.whatsapp.com/ /target/

Development

Help welcome on bugs and feature requests.

Developer / build docs, API documentation, Changelog.

License

MIT