Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(ux): pin floating panes #3876

Merged
merged 15 commits into from
Dec 16, 2024
Merged

feat(ux): pin floating panes #3876

merged 15 commits into from
Dec 16, 2024

Conversation

imsnif
Copy link
Member

@imsnif imsnif commented Dec 16, 2024

2024-12-16.15-09-57.mp4

With this change, user can now "pin" floating panes - meaning set them as "always on top" relative to the tiled pane surface. So that they will appear even if the floating pane surface is toggled off.

This can be done:

  1. With a mouse-click as shown in the video
  2. With a keyboard shortcut (by default i in Pane mode, so by default: Ctrl p + i)
  3. Through the command line (zellij action toggle-pane-pinned)
  4. From a plugin with the new set_floating_pane_pinned API

Pinned panes are also available in layouts for floating panes and will be respected when resurrecting sessions.

These can be very useful for long running commands that have helpful immediate feedback (eg. logs, compiler output, network device traffic, resource monitors such as htop, etc.)

@imsnif imsnif merged commit dd291e2 into main Dec 16, 2024
6 checks passed
imsnif added a commit to AutumnMeowMeow/zellij that referenced this pull request Dec 31, 2024
* working

* ui indication

* add keybinding

* add to plugin panes

* fix with multiple cursors

* toggle with the mouse

* fix e2e tests and add new one

* some cleanups

* add to layouts

* make mouse click more lenient

* allow setting a new floating pane as pinned

* make toggle work throughthe command line

* add to plugin api

* get tests to pass

* style(fmt): rustfmt
imsnif added a commit that referenced this pull request Jan 14, 2025
* Switch to multi-valued mouse buttons and stub for remembering old mouse button state

* Stubs for passing all mouse events from user-facing terminal to server
side terminal(s) in, including protobuf.

Removed "held" mouse actions.

Currently commented out calls to left/middle/right-click/release --
need to fix this though, as selection/copy-paste are broken too.

cargo build/test/run works OK.

cargo xtask build/test/run fails, unable to find crate input::mouse.

* 'cargo xtask build' working using refactored functions.

* fix(plugins): various cwd fixes (#3545)

* fix(plugins): various cwd fixes

* fix tests

* docs(changelog): floating_panes cwd fix

* feat(plugins): rerun_command_pane API (#3546)

* feat(plugins): rerun_command_pane API

* fix tests

* docs(changelog): rerun command pane plugin API

* feat(plugins): command pane re-run event (#3553)

* docs(changelog): CommandPaneReRun plugin event

* feat(ux): first run setup-wizard (#3556)

* separate saved/runtime structure, kind of working

* serializing config

* work

* work

* save config through the configuration screen

* work

* startup wizard

* style(code): cleanups

* fix(session): reload config from disk when switching sessions

* style(fmt): rustfmt

* fix(config): propagate cli config options to screen

* style(fmt): rustfmt

* docs(changelog): first run setup wizard

* feat(ux): reload config at runtime (#3558)

* feat(ux): reload config at runtime

* style(fmt): rustfmt

* docs(changelog): reload config at runtime

* feat(ux): change themes at runtime (#3559)

* docs(changelog): change themes at runtime

* feat(plugins): API to temporarily bind keys to send a message to a specific plugin id (#3561)

* docs(changelog): message to specific plugins API

* feat(ux): reload config options at runtime (#3564)

* change simplified_ui at runtime

* change default_shell at runtime

* change pane_frames (from config) at runtime

* all other options

* some refactoring

* style(fmt): rustfmt

* docs(changelog): reload config options at runtime

* feat(plugins): add plugin APIs to affect other panes (#3576)

* resize_pane_with_id and close_pane_with_id

* focus_pane_with_id and edit_scrollback_for_pane_with_id

* write_to_pane_id and write_chars_to_pane_id

* lots more commands

* style(fmt): rustfmt

* docs(changelog): new plugin apis

* docs(readme): update sponsors

* feat(plugins): APIs to break multiple panes into a new tab or an existing tab (#3610)

* feat(plugins): break multiple panes to a new tab

* fix(layouts): properly ignore run instructions when breaking panes

* feat(plugins): break multiple panes to existing tab

* feat(apis): allow these methods to also specify whether they want focus changed to the tab

* various fixes

* allow specifying name for the new tab when breaking out panes

* style(fmt): rustfmt

* docs(changelog): break multiple panes APIs

* feat(config): allow loading background plugins on startup (#3616)

* remove old partial implementation

* feat(plugins): allow loading background plugins on startup

* add e2e test

* update config

* udpate config merging

* style(fmt): rustfmt

* docs(changelog): background plugins

* feat(ui): built-in plugin manager (#3633)

* add plugin list to session info

* feat(plugins): new_plugin and reload_plugin API commands

* feat(plugins): built-in plugin manager

* style(fmt): rustfmt

* update plugins

* docs(changelog): plugin-manager

* fix(resurrection): various serialization issues (#3636)

* fix(serialization): use kdl-rs for serialization

* style(fmt): remove dead code

* tests(serialization): update snapshots

* style(fmt): rustfmt

* docs(changelog): resurrection fixes

* fix(http): web requests (#3643)

* docs(changelog): http fix

* feat(cli): make --layout idempotent(-ish) (#3650)

* feat(cli): if inside a session, apply --layout to the session

* fix(screen): some focusing races when switching tab focus

* style(fmt): rustfmt

* docs(changelog): improve --layout flag

* fix(plugins): handle race when setting plugin selectable (#3651)

* docs(changelog): plugin selectable race

* feat(cli): show CACHE_DIR in `zellij setup --check` (#3652)

* docs(changelog): add cache dir to setup

* fix(ui): various pane name fixes (#3653)

* docs(changelog): pane name fixes

* fix(ux): only damage the relevant swap layout layer when resizing panes (#3654)

* docs(changelog): swap layout damage fix

* fix(ui): set background color for UI components according to theme (#3658)

* docs(changelog): ui component fix

* fix(tab): recover from crash when resizing panes (#3659)

* chore(git): Add plugin’s issue templates (#3621)

Co-authored-by: Zykino <[email protected]>

* fix(ux): make sure esc works as expected in unlock-first (#3660)

* fix(ux): make sure esc always drops us back to base mode

* fix(ux): add locked

* fix(plugins): handle concurrent http downloads (#3664)

* docs(changelog): concurrent http plugin downloads

* fix(plugins): various plugin api and other fixes (#3665)

* fix(plugins): do not allow focusing an unselectable pane

* fix(folders): make sure config and cache folders exist on app start

* docs(changelog): plugin fixes

* fix(plugins): force use curl system lib on macOS (#3668)

* docs(changelog): fix http requests for macos

* fix(resurrection): plugin alias resurrection (#3673)

* fix(resurrection): make sure plugin aliases are serialized properly

* style(fmt): rustfmt

* docs(changelog): resurrection alias fix

* fix(plugins): do not allow attaching to the same session (#3674)

* docs(changelog): fix plugins attaching to same session

* fix(plugins): allow switching to a new session with cwd without specifying a layout (#3676)

* docs(changelog): switch_session_with_cwd plugin api

* fix(config): watch/update config given with --config when appropriate (#3678)

* docs(changelog): reload config flag fix

* feat(plugins): rebind keys api (#3680)

* feat(plugins): add API to explicitly unbind/rebind specific keys in specific modes

* style(fmt): rustfmt

* docs(changelog): rebind keys plugin api

* fix(client): repeat retry screen instruction (#3570)

* docs(changelog): sixel fix

* feat(ui): rebind keys UI (#3686)

* rebind action working

* functional ui

* responsive ui

* some refactoring

* properly reset ui state

* minor fixes

* style(fmt): rustfmt

* style(fmt): remove dead code

* chore(deps): update to Wasmtime 21.0.2 (#3685)

This fixes a race condition which causes occasional crashes and may
enable a sandbox escape:

<GHSA-7qmx-3fpx-r45m>

* docs(changelog): wasmtime patch upgrade

* feat(plugins): add API to list clients, their focused panes and running commands/plugins (#3687)

* fix(list-clients): properly show client info after a tab was closed

* feat(plugins): add API to list clients, their focused panes and running commands/plugins

* style(fmt): rustfmt

* docs(changelog): list-clients plugin api

* docs(changelog): rebind keys UI

* feat(ui): bring back fullscreen indication (#3688)

* feat(ui): bring back fullscreen indication

* fix e2e tests

* docs(changelog): bring back fullscreen indication

* fix(ux): new interface/configuration touch-ups (#3691)

* fix(ui): copy to clipboard in new ui

* fix(ux): allow navigating out of scrolled pane

* style(fmt): rustfmt

* docs(changelog): ui touch-ups

* fix(plugins): rebind insert (#3692)

* fix(tab): recover from closing a pane outside the viewport

* remap insert in plugin manager

* fix(plugins): remap insert key

* style(fmt): rustfmt

* docs(changelog): insert rebind

* fix(plugins): make sure to always render on first resize (#3693)

* fix(plugins): make sure to always render on first resize

* style(fmt): rustfmt

* fix tests

* docs(changelog): plugins first-render fix

* fix(terminal): recover from partial line drop (#3695)

* docs(changelog): grid fix

* fix(configuration): leave notification up when base mode changes (#3696)

* fix(layouts): suspend commands in remote layouts (#3697)

* fix(layouts): suspend commands in remote layouts

* style(fmt): rustfmt

* docs(changelog): suspend commands in remote layouts

* feat(plugins): add configurable black background for ui components (#3681)

* feat(plugins): add transparent background for text and nested_list

* chore: fix formatting issue

* feat: invert flag behaviour

* feat: implement bg_black handling for table cells

* fix: order of selected and bg_black in protocol

* chore: rename from bg_black to opaque

* fix: explicit selected, if opaque and selected for text

* chore: fix formatting issues

* feat: opaque tab-bar

* feat: opaque session-manager bars

* feat: opaque ribbon in plugin manager

* feat: opaque one-line ui

* feat: opaque tab-bar in configuration plugin

* style(fmt): various cleanups (#3698)

* fix(configuration): rounding error in ui

* style(fmt): remove warnings

* style(fmt): rustfmt

* docs(changelog): ui components bg fix

* feat(theme): add theme ao (#3478)

* feat(themes): add atelier sulphurpool theme (#3596)

* feat(themes): added ayu mirage, light, and dark themes (#3567)

Co-authored-by: Evan Lauer <[email protected]>

* feat(themes): add Vesper theme (#3443)

* feat(themes): add night-owl theme (#3393)

Co-authored-by: Bruno Mesquita <[email protected]>

* feat: add iceberg dark/light themes (#3323)

* theme: add onedark theme to the available themes (#3313)

Onedark is a popular theme from Atom text editor. 

I've used these sources as the reference for implementing the theme in zellij.
https://github.com/joshdick/onedark.vim
https://www.figma.com/community/file/1137445418485757476/atom-one-dark-color-palette

* feat(themes): add basic ANSI theme (#3308)

* fix(theme): fix for gruvbox light and dark (#3255)

the previous themes do not have the correct colors and aren't great
for the eyes. when selecting e.g. to copy text, it uses
red for light theme and the same bg for dark theme.

the previous light theme is not even a light theme so I also
fixed that as well.

Signed-off-by: Soc Virnyl Estela <[email protected]>

* feat(themes): create lucario.kdl (#3030)

* docs(changelog): new themes

* style(fmt): remove warnings (#3701)

* fix: (tabs) move to next tab if moving to next pane from fullscreen pane (#3498)

Co-authored-by: Vasilis Manolopoulos <[email protected]>

* docs(changelog): MoveFocusOrTab fullscreen awareness

* docs(readme): add https to curl download

* fix(ux): configuration fixes (#3713)

* fix(startup): try create config folder if it doesn't exist

* fix(configuration): tab bar ui

* fix(configuration): rebind ctrl-s to ctrl-a

* fix(configuration): remove extra rebinding leaders screen

* docs(changelog): configuration fixes

* fix(ux): forward keys to pane in locked mode and base mode rather than hard-coded normal mode (#3715)

* fix(keybindings): only forward clear keys in locked mode and default mode

* style(fmt): rustfmt

* docs(changelog): base mode keybindings fix

* chore(release): v0.41.0

* HOTFIX: default plugins generic compilation issue

* HOTFIX: patch version

* chore(release): v0.41.1

* chore(repo): bump development version

* fix(input): remove support for extra modifiers (#3725)

* docs(changelog): kitty input fix

* fix(input): refix ctrl-j (#3746)

* fix(input): refix ctrl-j

* fix e2e tests

* docs(changelog): refix ctrl-j

* fix(plugins): cwd and usability fixes (#3749)

* fix(plugins): maintain cwd between plugin reloads

* fix(plugin-manager): default to loading plugins in the foreground and allow sending space in configuration

* docs(changelog): plugin fixes

* fix(output-buffer): truncate grid height when not rendering it fully (#3750)

* fix(output-buffer): truncate grid height when not rendering it fully

* also fix for cases where the changed lines are not contiguous

* docs(changelog): output-buffer fix

* fix(tabs): maintain event order for MoveTab (#3758)

* fix(tabs): maintain event order for MoveTab

* style(fmt): rustfmt

* docs(changelog): event ordering fix

* fix(plugins): do not open extra instances of aliases (#3759)

* docs(changelog): do not duplicate built-in plugins

* fix(terminal): reset kitty keyboard support when resetting terminal state (#3760)

* docs(changelog): kitty reset fix

* fix(config): crash if unable to watch config folder (#3761)

* docs(changelog): config dir crash fix

* fix(statup): slow startup on some occasions (#3767)

* add debug logs

* add log messages

* some more logs and possible fix?

* remove logs

* style(fmt): rustfmt

* remove comment

* docs(changelog): occasional slow startup fix

* fix(panes): handle various invalid state situations (#3776)

* docs(changelog): invalid state handling

* chore: add vendored_curl feature (#3766)

* docs(changelog): vendored curl option

* fix(ux): change plugin manager shortcut (#3779)

* docs(changelog): shortcut change

* fix(screen): send PaneClosed event to plugins also when closing the whole tab (#3781)

* docs(changelog): pane-closed event

* feat(plugins): add /cache folder (#3787)

* feat(plugins): add /cache folder

* style(fmt): rustfmt

* docs(changelog): plugin cache folder

* docs(changelog): plugin cache folder url

* chore(package): vendor common_path (#3780)

* vendoring common_path

* add original license to common_path

* Clarify license scope

* refactor: remove rand dependency

---------

Co-authored-by: Aram Drevekenin <[email protected]>

* docs(changelog): vendor common_path

* fix(plugins): derive hash and ord for PaneId (#3790)

* docs(changelog): derive hash and ord for paneid

* style(fmt): remove warnings

* chore(version): set patch version

* chore(release): v0.41.2

* chore(repo): bump development version

* chore(repo): fix typo in lock file

* fix(plugins): properly focus pane after tab was closed (#3797)

* fix(plugins): properly focus pane after tab was closed

* style(fmt): rustfmt

* docs(changelog): focus_pane_with_id fix

* fix(plugins): properly pad UI elements when they have a background (#3806)

* fix(plugins): mark selected background up until component width

* style(fmt): rustfmt

* docs(changelog): ui component padding

* feat(plugins): allow changing the plugin's `/host` folder (under a new permission) (#3827)

* working without notifying plugins

* permissions and events

* cleanups and formatting

* style(fmt): rustfmt

* docs(changelog): allow plugins to change host folder

* chore(repo): add funding.json (#3838)

* chore(repo): add funding.json

* update funding json url

* fix(plugins): do not detach if using a slash in a session name (#3839)

* docs(changelog): slash detach fix

* fix(plugins): properly focus plugin after it was hidden (#3841)

* docs(changelog): plugin hidden focus fix

* fix(screen): off by 1 error when focusing layout tab (#3844)

* docs(changelog): layout tab focus fix

* fix(multiuser): properly clear fake cursors (#3845)

* docs(changelog): multiplayer cursor fix

* feat(ux): pin floating panes (#3876)

* working

* ui indication

* add keybinding

* add to plugin panes

* fix with multiple cursors

* toggle with the mouse

* fix e2e tests and add new one

* some cleanups

* add to layouts

* make mouse click more lenient

* allow setting a new floating pane as pinned

* make toggle work throughthe command line

* add to plugin api

* get tests to pass

* style(fmt): rustfmt

* docs(changelog): pin floating panes

* fix(layout-applier): logical index pane sorting (#3893)

* initial draft

* working with floating panes as well

* use the same method for applying an initial layout to tiled panes

* some refactoring

* all code paths working with logical positioning fallback!

* get tests to compile

* get e2e tests to pass

* fix e2e remote runner

* breadth-first layout sorting

* fix some bugs

* style(fmt): rustfmt

* style(fmt): remove comments

* docs(changelog): logical index pane sorting

* fix(terminal): mode 2026 feature detection response (#3884)

The response to the 2026 mode query was missing a `?` character.

The response should be of the format `CSI ? 2026 ; N $ y` where N can
be any value in the range 0-4 inclusive.

References:

https://gist.github.com/christianparpart/d8a62cc1ab659194337d73e399004036
https://vt100.net/docs/vt510-rm/DECRPM.html

* docs(changelog): synchronized rendering query response

* fix(terminal): cursor overflow (#3894)

* docs(changelog): cursor overflow fix

* fix(ux): make the Zellij mouse interaction work

* fix(rendering): only render if selection/floating-pane position was changed

* do not clear copied to clipboard message on mouse motion

* various functionality fixes

* fix tests

* fixes and cleanups

* style(fmt): rustfmt

* fix(mouse): only report state to plugins when it changed

* fix(plugins): send mouse clicks to inactive panes

* tests: any event tracking in panes

* style(fmt): rustfmt

* style: remove unused stuff

---------

Signed-off-by: Soc Virnyl Estela <[email protected]>
Co-authored-by: Autumn Lamonte <[email protected]>
Co-authored-by: Aram Drevekenin <[email protected]>
Co-authored-by: Zykino <[email protected]>
Co-authored-by: Zykino <[email protected]>
Co-authored-by: Daniel Jankowski <[email protected]>
Co-authored-by: Manuel de Prada Corral <[email protected]>
Co-authored-by: bjorn3 <[email protected]>
Co-authored-by: Michael Jones <[email protected]>
Co-authored-by: carl <[email protected]>
Co-authored-by: Evthestrike <[email protected]>
Co-authored-by: Evan Lauer <[email protected]>
Co-authored-by: Rafael Bardini <[email protected]>
Co-authored-by: Bruno Mesquita <[email protected]>
Co-authored-by: Bruno Mesquita <[email protected]>
Co-authored-by: Chromo-residuum-opec <[email protected]>
Co-authored-by: Shone Binu <[email protected]>
Co-authored-by: Mike Greiling <[email protected]>
Co-authored-by: Soc Virnyl S. Estela <[email protected]>
Co-authored-by: Eric Raio <[email protected]>
Co-authored-by: Vasileios Manolopoulos <[email protected]>
Co-authored-by: Vasilis Manolopoulos <[email protected]>
Co-authored-by: tranzystorekk <[email protected]>
Co-authored-by: s1syph0s <[email protected]>
Co-authored-by: Darren Burns <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant