Fcitx5 UI inside neovim

WARNING This program is in very early stage and may break or change frequently!

This is a fcitx5 user interface for neovim written in lua.

Basical fcitx5 functions seems work after a simple setup.

demo

Install

rocks.nvim

Command style

:Rocks install fcitx5-ui.nvim

Declare style

~/.config/nvim/rocks.toml:

[plugins]
"fcitx5-ui.nvim" = "scm"

Then

:Rocks sync

or:

$ luarocks --lua-version 5.1 --local --tree ~/.local/share/nvim/rocks install fcitx5-ui.nvim
# ~/.local/share/nvim/rocks is the default rocks tree path
# you can change it according to your vim.g.rocks_nvim.rocks_path

packer.nvim

require('packer').use(
  "black-desk/fcitx5-ui.nvim",
  rocks = {'lgi', 'dbus_proxy'},
)

lazy.nvim

return {
  "black-desk/fcitx5-ui.nvim",
  config = config,
}

NOTE:

lgi and dbus_proxy needs gobject-introspection to build;
packer.nvim need unzip to install lua rocks;
You will recive a message (:messages) if any dependency is missing. ignore_module_missing_warning = true will disable this warning message.

Use

require'fcitx5-ui'.activate() to activate first input method, then you can use :startinsert to enter insert mode.

require'fcitx5-ui'.deactivate() to deactivate input method.

require'fcitx5-ui'.toggle() to toggle between activate/deactivate.

require'fcitx5-ui'.getCurrentIM() to get current IM.

require'fcitx5-ui'.setup(config) to config this plugin.

Config

default config is:

local consts = require("fcitx5-ui.consts")

local default_cfg = {
  keys = {
    trigger = { '<C-Space>', consts.FcitxKey.space, consts.FcitxKeyState.ctrl },
    up = { '<Up>', consts.FcitxKey.up, consts.FcitxKeyState.no },
    down = { '<Down>', consts.FcitxKey.down, consts.FcitxKeyState.no },
    left = { '<Left>', consts.FcitxKey.left, consts.FcitxKeyState.no },
    right = { '<Right>', consts.FcitxKey.right, consts.FcitxKeyState.no },
    enter = { '<CR>', consts.FcitxKey.enter, consts.FcitxKeyState.no },
    backspace = { '<BS>', consts.FcitxKey.backspace, consts.FcitxKeyState.no },
    tab = { '<Tab>', consts.FcitxKey.tab, consts.FcitxKeyState.no },
    stab = { '<S-Tab>', consts.FcitxKey.tab, consts.FcitxKeyState.shift },
  },
  ignore_module_missing_warning = false,
  prev = "<|",
  next = "|>",
  update = 50,
}

You MUST config fcitx to ShareInputState=No and trigger MUST be set to one of [Hotkey/TriggerKeys] in your fcitx config.

`update`

I don't know how to stear a new thread from a lua script. So I use vim's timer to recive dbus signals from fcitx5 daemon. update is the interval of this timer. Default update time is set to 50ms.

Map

This plugin needs you to config some key maps.

Every key in keys is a table contains 3 entries:

keycode, (check :help keycodes), means the key you want to map.
FcitxKey
FcitxKeyState

FcitxKeyState and FcitxKey define the key event you want to send to fcitx.

You can pass config of your own to setup function like this:

local fcitx5 = require("fcitx5-ui")
local consts = require("fcitx5-ui.consts")
fcitx5.setup({
  keys = {
    trigger = {
      '<S-Space>', consts.FcitxKey.space, consts.FcitxKeyState.super,
    },
    up = {'<C-k>', consts.FcitxKey.up, consts.FcitxKeyState.no},
  }
})

Above config means that fcitx5 will recive a up key, when you press <C-k> in insert mode of neovim with input method activating.

You might want to map :lua require"fcitx5-ui".toggle() also, check this.

lualine

local cfg = require('lualine').get_config()
table.insert(
  cfg.sections.lualine_y,
  'require("fcitx5-ui").getCurrentIM()'
)
require('lualine').setup(cfg)

TODO

[ ] fix update client side ui signal issue

Thanks

fcitx5.nvim

lua-dbus_proxy

fcitx.vim

black-desk / fcitx5-ui.nvim

readme