runtime-api.md

NyaoVim Runtime API

As described in README, many APIs are available in NyaoVim; APIs, Node.js APIs, Electron APIs, Neovim msgpack-rpc APIs), so many npm packages. In addition to them, NyaoVim offers some extra APIs.

• API in Vim script
• Subscriable events

API in Vim script

Vim script interface is defined in this directory. The directory is added to runtimepath at Neovim starting. All are defined in nyaovim# namespace.

nyaovim#load_nyaovim_plugin(runtimepath)

Load UI plugin from the runtimepath directory. It searches nyaovim-plugin directory and HTML files in the directory. Then load HTML files with <link rel="import">.

nyaovim#load_nyaovim_plugin_direct(html_path)

Directly load HTML from html_path HTML file with <link rel="import">.

nyaovim#require_javascript_file(script_path)

Load script_path JavaScript file with Node.js's require() function.

nyaovim#call_javascript_function(func_name, args)

Call JavaScript func_name global function with args. args values in Vim script will be converted to JavaScript values.

nyaovim#open_devtools(mode)

Open DevTools for NyaoVim. mode determines how to open DevTools window and should be one of 'right', 'bottom', 'undocked' or 'detach'. If omitted, 'detach' will be set.

nyaovim#execute_javascript(code)

Execute JavaScript code from Vim script with code string. With this function, you can run various APIs directly from Vim script. Below is a code to toggle window fullscreen.

call nyaovim#execute_javascript('(function(){
          \   const win = require("electron").remote.getCurrentWindow();
          \   win.setFullScreen(!win.isFullScreen());
          \ })()')

TODO: This function currently doesn't return the result of evaluating JavaScript.

nyaovim#browser_window(method, args)

Call BrowserWindow API in Electron for the main window. This function is currently using notification. So Vim script side can't receive the return value.

" Calls `window.setFullScreen(true);` in the main window
call nyaovim#browser_window('setFullScreen', [v:true])

Subscriable events

With Neovim msgpack API, you can receive rpc nortifications.

const neovim_element = document.getElementById('neovim');
const client = neovim_element.editor.getClient();
client.on('notification', (func_name, args) => {
    switch (func_name) {
        case 'nyaovim:edit-start':
            // Do something
            break;
        default:
            break;
    }
});

NyaoVim defines some notifications to use internally and UI plugins can also use them.

nyaovim:edit-start

This notification is sent when Neovim starts to edit some buffer. It passes the file path to 1st argument.