summaryrefslogtreecommitdiff
path: root/desktop/node_modules/electron-packager/docs
diff options
context:
space:
mode:
authorRaindropsSys <raindrops@equestria.dev>2023-10-24 17:43:37 +0200
committerRaindropsSys <raindrops@equestria.dev>2023-10-24 17:43:37 +0200
commitae187b6d75c8079da0be1dc288613bad8466fe61 (patch)
tree5ea0d34185a2270f29ffaa65e1f5258028d7d5d0 /desktop/node_modules/electron-packager/docs
downloadmist-ae187b6d75c8079da0be1dc288613bad8466fe61.tar.gz
mist-ae187b6d75c8079da0be1dc288613bad8466fe61.tar.bz2
mist-ae187b6d75c8079da0be1dc288613bad8466fe61.zip
Initial commit
Diffstat (limited to 'desktop/node_modules/electron-packager/docs')
-rw-r--r--desktop/node_modules/electron-packager/docs/api.md1
-rw-r--r--desktop/node_modules/electron-packager/docs/faq.md50
2 files changed, 51 insertions, 0 deletions
diff --git a/desktop/node_modules/electron-packager/docs/api.md b/desktop/node_modules/electron-packager/docs/api.md
new file mode 100644
index 0000000..0136885
--- /dev/null
+++ b/desktop/node_modules/electron-packager/docs/api.md
@@ -0,0 +1 @@
+[API Documentation](https://electron.github.io/electron-packager/) has moved.
diff --git a/desktop/node_modules/electron-packager/docs/faq.md b/desktop/node_modules/electron-packager/docs/faq.md
new file mode 100644
index 0000000..198cf94
--- /dev/null
+++ b/desktop/node_modules/electron-packager/docs/faq.md
@@ -0,0 +1,50 @@
+# Frequently Asked Questions
+
+## Why does the menubar appear when running in development mode, but disappear when packaged?
+
+**Note**: as of Electron 5, the menubar always appears, so this question is not relevant to
+officially supported versions of Electron.
+
+Based on [a comment from **@MarshallOfSound**](https://github.com/electron/electron-packager/issues/553#issuecomment-270805213):
+
+When you're running in "development mode" (for example, `electron /path/to/app`), Electron uses the
+`default_app` codepath to run your app, which also provides a default menubar. When the app is
+packaged, Electron runs your app directly. To have a menubar that's consistent between development
+and packaged modes, you'll need to [define it yourself](https://electronjs.org/docs/api/menu/).
+
+## Why isn't my `ignore` option working?
+
+As stated in the documentation for [`ignore`](https://electron.github.io/electron-packager/main/interfaces/electronpackager.options.html#ignore), it uses "[one] or more additional
+[regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions)
+patterns. […] Please note that [glob patterns](https://en.wikipedia.org/wiki/Glob_%28programming%29)
+will not work."
+
+## Why isn't the relative path in my app code working?
+
+To make a path work in both development and packaged mode, you'll need to generate a path based on
+the location of the JavaScript file that is referencing the file. For example, if you had an app
+structure like the following:
+
+```
+AppName
+├── package.json
+├── data
+│   └── somedata.json
+└── src
+    └── main.js
+```
+
+In `src/main.js`, you would access `data/somedata.json` similar to this:
+
+```javascript
+const path = require('path');
+const jsonFilename = path.resolve(__dirname, '..', 'data', 'somedata.json');
+console.log(require(jsonFilename));
+```
+
+## How do I set an icon on Linux?
+
+The docs for [`icon`](https://electron.github.io/electron-packager/main/interfaces/electronpackager.options.html#icon)
+already show how to set an icon on your `BrowserWindow`, but your dock/taskbar may not use that and
+instead use the `Icon` value in your `.desktop` file. The [Linux distributable creators](https://github.com/electron/electron-packager#distributable-creators)
+can help you set/distribute the appropriate icon in that case.