Module lua.ime.nvim.ime

A system IME

Functions

M.IME:new (ime)
M.IME:create_autocmds (augroup_id) create autocmds.
M.IME:get_current_schema () get current schema ID, aka short name
M.IME:get_schema_name () get current schema name

override `IME`

M.IME:set_enabled (is_enabled) modify vim.o.iminsert/vim.o.imsearch: save the flag to use IM in insert mode for each buffer.
M.IME:get_enabled () see :h iminsert/:h imsearch.
M.IME:enable_cb () when InsertLeavePre/CmdlineLeave, disable IME backend and save its enabled flag
M.IME:disable_cb () when InsertEnter/CmdlineEnter, check enabled flag and call


Functions

M.IME:new (ime)

Parameters:

  • ime table?

Returns:

    table ime
M.IME:create_autocmds (augroup_id)
create autocmds.

Parameters:

  • augroup_id integer?
M.IME:get_current_schema ()
get current schema ID, aka short name

Returns:

    string
M.IME:get_schema_name ()
get current schema name

Returns:

    string

override `IME`

M.IME:set_enabled (is_enabled)
modify vim.o.iminsert/vim.o.imsearch: save the flag to use IM in insert mode for each buffer. override self.iminsert because it is global to all buffers. Note: wincmd j trigger BufEnter, still in cmd mode

Parameters:

  • is_enabled boolean luacheck: ignore 212/self
M.IME:get_enabled ()
see :h iminsert/:h imsearch.

Returns:

    boolean luacheck: ignore 212/self
M.IME:enable_cb ()
when InsertLeavePre/CmdlineLeave, disable IME backend and save its enabled flag

Returns:

    function
M.IME:disable_cb ()
when InsertEnter/CmdlineEnter, check enabled flag and call
generated by LDoc 1.5.0 Last updated 2025-12-06 16:06:13