docs/widgets/README.md
You want to launch Navi with a shortcut?
Widgets are here for you!
Widgets are 3rd-party contributions and integrates Navi with 3rd-party software such as shells.
| Shell | Navi support |
|---|---|
| Bash | :white_check_mark: |
| Fish | |
| Zsh | |
| NuShell | :white_check_mark: |
| PowerShell | :white_check_mark: |
Remove-Module navi.plugin
If you want to install it, add this line to your .bashrc-like file:
# bash
eval "$(navi widget bash)"
# zsh
eval "$(navi widget zsh)"
# fish
navi widget fish | source
# elvish
eval (navi widget elvish | slurp)
# xonsh
# xpip install xontrib-navi # ← run in your xonsh session to install xontrib
xontrib load navi # ← add to your xonsh run control file
Due to Nushell's unique design, it is not possible to eval a piece of code dynamically like in other shells therefore the integration process is a bit more involved. Here is an example:
^navi widget nushell | save ($nu.default-config-dir | path join "navi-integration.nu")config.nu:
source ($nu.default-config-dir | path join "navi-integration.nu")
By default, Ctrl+G is assigned to launching navi (in xonsh can be customized with $X_NAVI_KEY, see xontrib-navi for details).
There's currently no way to customize the widget behavior out-of-the-box. If you want to change the keybinding or the navi flags used by the widget, please:
navi widget bash in your terminal.bashrc-like file