IBus: Difference between revisions

Latest revision as of 01:12, 2 September 2024

IBus is a bus for various input methods.

Installation

Enabling IBus is described in the manual. Mainly, it can be done as follows:

/etc/nixos/configuration.nix

{pkgs, lib, ...}:
{
 i18n.inputMethod = {
  enable = true;
  type = "ibus";
  ibus.engines = with pkgs.ibus-engines; [ /* any engine you want, for example */ anthy ];
 };
}

Tip

In order to affect your NixOS system by your nix-language-specific changes you must first evaluate it:

$ nixos-rebuild switch --use-remote-sudo

After switching, you still need to logout from your session and login again for ibus to work correctly.

For nix version older than 24.11, enabled = "ibus"; is used instead of enable and type

Input methods

To get the list of available engines, you can use the tab completion of nix repl.

$ nix repl
nix-repl> ibus-engines.<Tab>

Custom emojis

Custom emojis can be added to the emoji selection dialog of IBus. This can be used to workaround the fact that GTK does not support compose rules which output more than one unicode codepoint. Here an example Home Manager module:

~/.config/nixpkgs/home.nix

{ pkgs, lib, config, ... }:
let
  /* define here the list of desired favorite emoji */
  fav = {
    shrug = ''¯\_(ツ)_/¯'';
    "markdown-shrug" = ''¯\\\_(ツ)\_/¯'';
    flip = ''(╯°□°）╯︵ ┻━┻'';
  };
in
{
  dconf.settings."desktop/ibus/panel/emoji" = with lib.hm.gvariant; {
    favorite-annotations = mkArray type.string (lib.attrNames fav);
    favorites = mkArray type.string (lib.attrValues fav);
  };
}

Then, typing Ctrl+Shift+e and then shrug, Space and Return will insert ¯\_(ツ)_/¯.

@@ Line 9: / Line 9: @@
 {
   i18n.inputMethod = {
-   enable = "ibus";
+   enable = true;
    type = "ibus";
    ibus.engines = with pkgs.ibus-engines; [ /* any engine you want, for example */ anthy ];
@@ Line 18: / Line 18: @@
 {{Evaluate}}
 After switching, you still need to logout from your session and login again for ibus to work correctly.
+For nix version older than 24.11, <code>enabled = "ibus";</code> is used instead of <code>enable</code> and <code>type</code>
 ==== Input methods ====