Neoclide-client
Neoclide-client is a redesigned UI component of neovim-component.
Besides many bugs fixed, neoclide-client introduce uniformed data flow specified for neovim to make the UI easy to reason about.
Note some features relies on electron to work.
Features
- Background transparent support
- Improved input method support (need to run electron-rebuild)
- More friendly cursor support, without antialiased issue
- Accessable editor state object
- Automatic resize handler, no screen blink
Install
node.js is need, just run:
npm install neoclide-client
Some native modules is used, since it's build for electron, electron-rebuild
need to be run after install or electron get upgraded.
Data flow
Usage
Include webcomponent, polymer and neovim-editor to html page and neovim-editor
tag.
See detailed in example/index.html
You can run the example by using node example/cli.js
after clone the repo and
electron-rebuild.
Configuration
neovim-editor
have some properties which allows specify how neovim-editor works before attched.
None of them are required.
font-size
: font size for rendering, default14
font
: font family for rendering, defaultmonospace
line-height
: line height for rendering, default1.3
nvim-cmd
: command start neovim defaultnvim
argv
: argument list add to nvimCmd, default[]
disable-alt-key
: defaultfalse
disable-meta-key
: defaulttrue
cursor-draw-delay
: delay for redrawing cursor default10
window-title
: defaultNeovim
on-process-attached
: optional callback function on editor attachedon-quit
: optional callback function on editor quiton-error
: optional callback function on editor errorcursor-fgcolor
: font color of cursor, default#000000
cursor-bgcolor
: background color of cursor, default#ffffff
Editor events
Access editor
instance by using element.editor
, for example:
const el = documentcosnt editor = eleditor
-
attached
fired on editor attached -
detach
fired on editor detached -
quit
fired on editor quit -
error
fired on editor error with error instance -
contextmenu
fired on contextmenu event of editor -
bell
fired on editor bell -
visual-bell
fired on editor visual-bell -
change title
fired with new title -
change icon
fired with new icon path -
change attribute
fired on element attribute change withname
andtype
-
change scroll_region
fired with newscroll_region
-
change size
fired with new size of editor, which containslines
andcols
-
change cursor
fired with new cursor position -
change bg_color
fired with new bg_color (rgba or rgb format) -
change fg_color
fired with new fg_color (rgba or rgb format) -
change busy
fired with busy (true of false) -
change focused
fired with focused (true of false) -
change mode
fired with new mode (command
orinsert
, need patch neovim to supportcmdline
)
Editor API
editor.getClient()
Get underlying promised-neovim client.
editor.focus()
Focus canvas element of editor
editor.setArgv(argv: Array)
Pass new argument list to neovim
, see :h args_f
editor.state
Get a readonly state object of editor.
editor.convertPositionToLocation(line, col)
Helper function covert cursor position to screen position.
editor.convertLocationToPosition(x, y)
Helper function covert screen position to cursor position.
editor.quit()
Quit editor
LICENCE
Copyright 2016 chemzqm@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.