Skip to content

6 zjframes

Daniel Jankowski edited this page Nov 16, 2024 · 1 revision

zjframes is an additional plugin, based on zjstatus hide frames features, that runs in the background. It just controls pane frames based on certain conditions for users, who want to user other status bars, but display frames based on different conditions.

Important

zjframes is only supported for zellij 0.41.0 or higher!

📦 Installation

zjframes has to be installed either as a file or via https locations within the config.kdl.

// Plugins to load in the background when a new session starts
load_plugins {
    "file:./path/to/zjframes.wasm" {
        hide_frame_for_single_pane       "false"
        hide_frame_except_for_search     "true"
        hide_frame_except_for_fullscreen "true"
    }

    // or

    "https://github.com/dj95/zjstatus/releases/latest/download/zjframes.wasm" {
        hide_frame_for_single_pane       "false"
        hide_frame_except_for_search     "true"
        hide_frame_except_for_fullscreen "true"
    }
}

⚙️ Configuration

Configuration is done in the block ({ ... }) behind the location in the config.kdl. Options can also be combined.

// Plugins to load in the background when a new session starts
load_plugins {
    "https://github.com/dj95/zjstatus/releases/latest/download/zjframes.wasm" {
        hide_frame_for_single_pane       "false"
        hide_frame_except_for_search     "true"
        hide_frame_except_for_fullscreen "true"
    }
}

Hide pane frames for tabs single panes

The option hide_frame_for_single_pane will toggle the pane frames depending on how many panes (not plugin panes) are shown. This will effectively hide the frame border, when only one pane, like an editor, is shown. Pane frames are toggled as soon as there is another pane created.

Hide pane frames except for search

The option hide_frame_except_for_search will toggle the pane frames only on, when search mode is enabled. Otherwise it will toggle the pane frames off.

Hide pane frames except for fullscreen

The option hide_frame_except_for_fullscreen will toggle the pane frames only to on, when the current active pane is in fullscreen mode. Otherwise the frames are off.