summary refs log tree commit diff
path: root/doc/builders/packages/ibus.section.md
blob: 2ce85467bb861945a1c0f976ae8df4c71bf120b7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# ibus-engines.typing-booster {#sec-ibus-typing-booster}

This package is an ibus-based completion method to speed up typing.

## Activating the engine {#sec-ibus-typing-booster-activate}

IBus needs to be configured accordingly to activate `typing-booster`. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the [upstream docs](https://mike-fabian.github.io/ibus-typing-booster/documentation.html).

On NixOS you need to explicitly enable `ibus` with given engines before customizing your desktop to use `typing-booster`. This can be achieved using the `ibus` module:

```nix
{ pkgs, ... }: {
  i18n.inputMethod = {
    enabled = "ibus";
    ibus.engines = with pkgs.ibus-engines; [ typing-booster ];
  };
}
```

## Using custom hunspell dictionaries {#sec-ibus-typing-booster-customize-hunspell}

The IBus engine is based on `hunspell` to support completion in many languages. By default the dictionaries `de-de`, `en-us`, `fr-moderne` `es-es`, `it-it`, `sv-se` and `sv-fi` are in use. To add another dictionary, the package can be overridden like this:

```nix
ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; }
```

_Note: each language passed to `langs` must be an attribute name in `pkgs.hunspellDicts`._

## Built-in emoji picker {#sec-ibus-typing-booster-emoji-picker}

The `ibus-engines.typing-booster` package contains a program named `emoji-picker`. To display all emojis correctly, a special font such as `noto-fonts-emoji` is needed:

On NixOS it can be installed using the following expression:

```nix
{ pkgs, ... }: { fonts.fonts = with pkgs; [ noto-fonts-emoji ]; }
```