aboutsummaryrefslogtreecommitdiffstats
path: root/zellij-utils/src/plugin_api
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2026-01-20 10:13:37 +0100
committerGitHub <noreply@github.com>2026-01-20 10:13:37 +0100
commit03c86d09cf301db9a62427170f956a632812d67e (patch)
tree5eee73d6201cbe2066ec258a0b7612e84e97aa6d /zellij-utils/src/plugin_api
parentFix: allow 0% coordinate specification for floating panes (#4609) (diff)
downloadsl0ppij-03c86d09cf301db9a62427170f956a632812d67e.tar.gz
sl0ppij-03c86d09cf301db9a62427170f956a632812d67e.tar.xz
sl0ppij-03c86d09cf301db9a62427170f956a632812d67e.zip
Allow toggling pane frames for specific panes (#4615)
* initial implementation * add borderless to edit and plugin cli commands * allow changing existing pane to borderless * allow setting in layouts and keybindings * get to work through the existing plugin api commands * fix when applying (swap) layouts * fix tests * allow setting pane as bordered (borderful?) when changing its coordinates (eg. through the cli) * allow explicitly setting a pane as bordered or borderless without toggling * rustfmt * adjust snapshots * docs(changelog): add PR
Diffstat (limited to 'zellij-utils/src/plugin_api')
-rw-r--r--zellij-utils/src/plugin_api/action.proto10
-rw-r--r--zellij-utils/src/plugin_api/action.rs10
-rw-r--r--zellij-utils/src/plugin_api/plugin_command.proto14
-rw-r--r--zellij-utils/src/plugin_api/plugin_command.rs49
4 files changed, 78 insertions, 5 deletions
diff --git a/zellij-utils/src/plugin_api/action.proto b/zellij-utils/src/plugin_api/action.proto
index 6b899b48..f8061bb6 100644
--- a/zellij-utils/src/plugin_api/action.proto
+++ b/zellij-utils/src/plugin_api/action.proto
@@ -121,6 +121,7 @@ message FloatingPaneLayout {
bool already_running = 9;
optional string pane_initial_contents = 10;
optional uint32 logical_position = 11;
+ optional bool borderless = 12;
}
message SwapTiledLayout {
@@ -230,6 +231,7 @@ message Action {
NewTabPayload new_tab_payload = 51;
NewInPlacePanePayload new_in_place_pane_payload = 52;
OverrideLayoutPayload override_layout_payload = 53;
+ SetPaneBorderlessPayload set_pane_borderless_payload = 54;
}
}
@@ -447,6 +449,7 @@ enum ActionName {
NewBlockingPane = 91;
NewInPlacePane = 92;
OverrideLayout = 93;
+ SetPaneBorderless = 94;
}
message Position {
@@ -477,6 +480,13 @@ message FloatingPaneCoordinates {
optional SplitSize width = 3;
optional SplitSize height = 4;
optional bool pinned = 5;
+ optional bool borderless = 6;
+}
+
+// SetPaneBorderlessPayload specifies the pane and borderless state
+message SetPaneBorderlessPayload {
+ PaneId pane_id = 1;
+ bool borderless = 2;
}
// UnblockCondition specifies when a blocking pane should unblock
diff --git a/zellij-utils/src/plugin_api/action.rs b/zellij-utils/src/plugin_api/action.rs
index 96074948..2253d526 100644
--- a/zellij-utils/src/plugin_api/action.rs
+++ b/zellij-utils/src/plugin_api/action.rs
@@ -1769,6 +1769,8 @@ impl TryFrom<Action> for ProtobufAction {
pane_id: _,
coordinates: _,
}
+ | Action::TogglePaneBorderless { pane_id: _ }
+ | Action::SetPaneBorderless { .. }
| Action::SkipConfirm { action: _ }
| Action::SwitchSession { .. } => Err("Unsupported action"),
}
@@ -2248,6 +2250,7 @@ impl TryFrom<ProtobufFloatingPaneCoordinates> for FloatingPaneCoordinates {
width: protobuf_coords.width.and_then(|w| w.try_into().ok()),
height: protobuf_coords.height.and_then(|h| h.try_into().ok()),
pinned: protobuf_coords.pinned,
+ borderless: protobuf_coords.borderless,
})
}
}
@@ -2261,6 +2264,7 @@ impl TryFrom<FloatingPaneCoordinates> for ProtobufFloatingPaneCoordinates {
width: coords.width.and_then(|w| w.try_into().ok()),
height: coords.height.and_then(|h| h.try_into().ok()),
pinned: coords.pinned,
+ borderless: coords.borderless,
})
}
}
@@ -2802,7 +2806,7 @@ impl TryFrom<ProtobufTiledPaneLayout> for TiledPaneLayout {
children,
split_size,
run,
- borderless: protobuf.borderless,
+ borderless: Some(protobuf.borderless),
focus,
external_children_index: protobuf.external_children_index.map(|i| i as usize),
children_are_stacked: protobuf.children_are_stacked,
@@ -2834,7 +2838,7 @@ impl TryFrom<TiledPaneLayout> for ProtobufTiledPaneLayout {
children,
split_size,
run,
- borderless: internal.borderless,
+ borderless: internal.borderless.unwrap_or(false),
focus,
external_children_index: internal.external_children_index.map(|i| i as u32),
children_are_stacked: internal.children_are_stacked,
@@ -2866,6 +2870,7 @@ impl TryFrom<ProtobufFloatingPaneLayout> for FloatingPaneLayout {
already_running: protobuf.already_running,
pane_initial_contents: protobuf.pane_initial_contents,
logical_position: protobuf.logical_position.map(|p| p as usize),
+ borderless: protobuf.borderless,
})
}
}
@@ -2890,6 +2895,7 @@ impl TryFrom<FloatingPaneLayout> for ProtobufFloatingPaneLayout {
already_running: internal.already_running,
pane_initial_contents: internal.pane_initial_contents,
logical_position: internal.logical_position.map(|p| p as u32),
+ borderless: internal.borderless,
})
}
}
diff --git a/zellij-utils/src/plugin_api/plugin_command.proto b/zellij-utils/src/plugin_api/plugin_command.proto
index 0a0ad2b0..9c529013 100644
--- a/zellij-utils/src/plugin_api/plugin_command.proto
+++ b/zellij-utils/src/plugin_api/plugin_command.proto
@@ -176,6 +176,8 @@ enum CommandName {
RenameLayout = 181;
GetLayoutDir = 182;
GetFocusedPaneInfo = 183;
+ TogglePaneBorderless = 184;
+ SetPaneBorderless = 185;
}
message PluginCommand {
@@ -301,6 +303,8 @@ message PluginCommand {
GetLayoutDirPayload get_layout_dir_payload = 132;
DumpSessionLayoutPayload dump_session_layout_payload = 133;
GetFocusedPaneInfoPayload get_focused_pane_info_payload = 134;
+ TogglePaneBorderlessPayload toggle_pane_borderless_payload = 135;
+ SetPaneBorderlessPayload set_pane_borderless_payload = 136;
}
}
@@ -432,6 +436,15 @@ message SetFloatingPanePinnedPayload {
bool should_be_pinned = 2;
}
+message TogglePaneBorderlessPayload {
+ PaneId pane_id = 1;
+}
+
+message SetPaneBorderlessPayload {
+ PaneId pane_id = 1;
+ bool borderless = 2;
+}
+
message ChangeHostFolderPayload {
string new_host_folder = 1;
}
@@ -711,6 +724,7 @@ message FloatingPaneCoordinates {
optional FixedOrPercentValue width = 3;
optional FixedOrPercentValue height = 4;
optional bool pinned = 5;
+ optional bool borderless = 6;
}
message FixedOrPercentValue {
diff --git a/zellij-utils/src/plugin_api/plugin_command.rs b/zellij-utils/src/plugin_api/plugin_command.rs
index d26ab7ec..da0f4599 100644
--- a/zellij-utils/src/plugin_api/plugin_command.rs
+++ b/zellij-utils/src/plugin_api/plugin_command.rs
@@ -46,9 +46,10 @@ pub use super::generated_api::api::{
RunActionPayload, RunCommandPayload, SaveLayoutPayload,
SaveLayoutResponse as ProtobufSaveLayoutResponse, ScrollDownInPaneIdPayload,
ScrollToBottomInPaneIdPayload, ScrollToTopInPaneIdPayload, ScrollUpInPaneIdPayload,
- SetFloatingPanePinnedPayload, SetSelfMouseSelectionSupportPayload, SetTimeoutPayload,
- ShowCursorPayload, ShowPaneWithIdPayload, StackPanesPayload, SubscribePayload,
- SwitchSessionPayload, SwitchTabToPayload, TogglePaneEmbedOrEjectForPaneIdPayload,
+ SetFloatingPanePinnedPayload, SetPaneBorderlessPayload,
+ SetSelfMouseSelectionSupportPayload, SetTimeoutPayload, ShowCursorPayload,
+ ShowPaneWithIdPayload, StackPanesPayload, SubscribePayload, SwitchSessionPayload,
+ SwitchTabToPayload, TogglePaneBorderlessPayload, TogglePaneEmbedOrEjectForPaneIdPayload,
TogglePaneIdFullscreenPayload, UnsubscribePayload, WebRequestPayload,
WriteCharsToPaneIdPayload, WriteToPaneIdPayload,
},
@@ -117,6 +118,7 @@ impl Into<FloatingPaneCoordinates> for ProtobufFloatingPaneCoordinates {
}
}),
pinned: self.pinned,
+ borderless: self.borderless,
}
}
}
@@ -169,6 +171,7 @@ impl Into<ProtobufFloatingPaneCoordinates> for FloatingPaneCoordinates {
None => None,
},
pinned: self.pinned,
+ borderless: self.borderless,
}
}
}
@@ -1682,6 +1685,29 @@ impl TryFrom<ProtobufPluginCommand> for PluginCommand {
_ => Err("Mismatched payload for ChangeFloatingPanesCoordinates"),
}
},
+ Some(CommandName::TogglePaneBorderless) => match protobuf_plugin_command.payload {
+ Some(Payload::TogglePaneBorderlessPayload(toggle_payload)) => {
+ match toggle_payload.pane_id {
+ Some(pane_id) => {
+ Ok(PluginCommand::TogglePaneBorderless(pane_id.try_into()?))
+ },
+ None => Err("Malformed TogglePaneBorderless payload"),
+ }
+ },
+ _ => Err("Mismatched payload for TogglePaneBorderless"),
+ },
+ Some(CommandName::SetPaneBorderless) => match protobuf_plugin_command.payload {
+ Some(Payload::SetPaneBorderlessPayload(payload)) => {
+ match (payload.pane_id, payload.borderless) {
+ (Some(pane_id), borderless) => Ok(PluginCommand::SetPaneBorderless(
+ pane_id.try_into()?,
+ borderless,
+ )),
+ _ => Err("Malformed SetPaneBorderless payload"),
+ }
+ },
+ _ => Err("Mismatched payload for SetPaneBorderless"),
+ },
Some(CommandName::OpenCommandPaneNearPlugin) => match protobuf_plugin_command.payload {
Some(Payload::OpenCommandPaneNearPluginPayload(command_to_run_payload)) => {
match command_to_run_payload.command_to_run {
@@ -3067,6 +3093,23 @@ impl TryFrom<PluginCommand> for ProtobufPluginCommand {
},
)),
}),
+ PluginCommand::TogglePaneBorderless(pane_id) => Ok(ProtobufPluginCommand {
+ name: CommandName::TogglePaneBorderless as i32,
+ payload: Some(Payload::TogglePaneBorderlessPayload(
+ TogglePaneBorderlessPayload {
+ pane_id: Some(pane_id.try_into()?),
+ },
+ )),
+ }),
+ PluginCommand::SetPaneBorderless(pane_id, borderless) => Ok(ProtobufPluginCommand {
+ name: CommandName::SetPaneBorderless as i32,
+ payload: Some(Payload::SetPaneBorderlessPayload(
+ SetPaneBorderlessPayload {
+ pane_id: Some(pane_id.try_into()?),
+ borderless,
+ },
+ )),
+ }),
PluginCommand::OpenCommandPaneNearPlugin(command_to_run, context) => {
let context: Vec<_> = context
.into_iter()