Crate zellij_tile

The zellij-tile crate acts as the Rust API for developing plugins for Zellij.

To read more about Zellij plugins: https://zellij.dev/documentation/plugins

Interesting things in this libary:

• The ZellijPlugin trait for implementing plugins combined with the register_plugin! macro to register them.
• The list of commands representing what a plugin can do.
• The list of Events a plugin can subscribe to
• The ZellijWorker trait for implementing background workers combined with the register_worker! macro to register them

Full Example and Development Environment

For a working plugin example as well as a development environment, please see: https://github.com/zellij-org/rust-plugin-example

Modules

prelude

shim

ui_components

Macros

register_plugin

Used to register a plugin implementing the ZellijPlugin trait.

register_worker

Used to register a plugin worker implementing the ZellijWorker trait.

Constants

PLUGIN_MISMATCH

Traits

ZellijPlugin

This trait should be implemented - once per plugin - on a struct (normally representing the plugin state). This struct should then be registered with the register_plugin! macro.

ZellijWorker

This trait is used to create workers. Workers can be used by plugins to run longer running background tasks without blocking their own rendering (eg. and showing some sort of loading indication in part of the UI as needed while waiting for the task to complete).