browser-config.md

Browser Config

Please note that browser-config.json may be deprecated after Neovim 0.2 because of the change of Neovim frontend architecture

NyaoVim is rendered in browser window using Electron framework. You can configure editor options with properties of <neovim-editor> component, but cannot configure the browser window options. This is because the browser window options must be specified before window opened.

You can configure browser window options using browser-config.json in ~/.config/nyaovim/. It does not exist by default and you need to create it at first.

$ echo "{\n  \"window_options\": {}\n}" > ~/.config/nyaovim/browser-config.json

browser-config.json contains one JSON object. The object optionally contains below key/value entries.

• window_options : Its value is options of BrowserWindow class of Electron. You can configure many options here; width, height, fullscreen, webPreferences, and so on.
• remember_window_state : Boolean value. Preserve the window state (position, size, fullscreen?, maximized?) at closing window and restore it at next start-up. The state is written to ~/.config/nyaovim/window-state.json.
• single_instance : Boolean value. If true, NyaoVim becomes 'Single Instance Application'. Only one NyaoVim instance can exist in desktop. If nyaovim command is secondly executed, it focuses on NyaoVim window which already exists, opens files specified as arguments in it, and simply quits.
• show_menubar : Boolean value. If false, NyaoVim hides menubar. Otherwise, NyaoVim shows menubar because Alt key is hijacked in some environment when menubar is auto-hidden.

Below is an example:

{
  "window_options": {
    "width": 1200,
    "height": 960,
    "fullscreen": true,
    "alwaysOnTop": true,
    "webPreferences": {
      "webgl": false,
      "plugins": true
    }
  },
  "remember_window_state": true,
  "single_instance": true,
  "show_menubar": false
}