Plugin API
Please also see the Rust-specific documentation: zellij-tile.
The plugin API provides plugins with several capabilities:
- Events - A plugin can subscribe to one or more of these and receive an update whenever they happen.
- Commands - These are functions exported to the plugin, allowing it to affect Zellij and add functionality to it.
- Types - The data types used by commands and events.
- Permissions - Which commands and events need the user's permission.
- Configuration - How plugins receive their configuration.
- Accessing the HD - A plugin can use its development language's own standard library to access the filesystem folder in which Zellij was opened.
- Workers for Async Tasks - A plugin can have multiple workers to which it can offload heavy or long-running tasks without blocking its own rendering.
- Log debug or error messages - A plugin can log messages to STDERR which will in the Zellij logs.
Plugins can also:
- Open popups and ask the user questions with
prompt. - Open Zellij's context menu for a tab or a bar.
- Add an entry to the settings screen that opens their own settings.
- Read and edit the configuration the way the settings screen does.
- Give their space in the layout back while they have nothing to show, with
set_self_collapsed. - Serve many panes from a single instance, as shared plugins.
- Follow the input mode and keybindings of nested sessions.
- Work with panes in other sessions and their attention state, and show a live view of another pane.