[foxnne]

On Zig 0.17: main (with #575, the SDK 0.2.30 release #580, and #560) is merged in, and every gate passes on the 0.17 toolchain.

Part of fizzyedit/work#33

What changes

A plugin can put its view away, not only show it, so a button can toggle a panel:

pub fn hideSurface(self: *Host, id: []const u8) bool

if (!host.hideSurface(id)) _ = host.revealSurface(id); // a toggle

hideSurface undoes revealSurface the way the user would. It returns true when the view was in sight and is not now. It returns false, changing nothing, when the view was not in sight: another view is its place's selection, its place or the tray round it is shut or folded, or no place shows it.

• In a tray (Region.tray: the shape's sidebar or bottom panel), or in a place the user split off one, the tray shuts with whatever else it holds, as its rail icon would shut it. revealSurface opens it again at the size the user left it.
• Anywhere else (Main or a place split off it, a plugin's document pane, a dockspace cell), nothing happens and it returns false.
• In a float, only this view goes back to the place it floated out of, as closing the float would send it (float_rules.goHome). The float's other views stay where the user put them, and the float closes only if this was its last view.
  • If the view lands in sight in a tray, the tray shuts.
  • If it lands in sight anywhere else, it is in sight, and the answer is false though it left the float.

Layout changes it needs

• A hide or reveal asked mid-frame waits, in order. A button in a floating view calls hideSurface while the shape and the floats walk the very lists a hide changes. Mid-frame, hideSurface and revealSurface both queue (Layout.hideLater, revealLater, one queue), and the frame applies them in the order asked once the shape, floats, drag overlay and picker have drawn (Layout.applyLater). A hide then a reveal in one frame ends with the view shown.
  • Each answers as it would between frames. For a float view, hideLater also predicts where the view lands (ViewDrag.floatHomeFor): landing in sight where nothing shuts gives false, as hide does. Tested.
  • Between frames a hide applies at once.
  • markWindowRatiosDirty now reads extents_changed after all of this, which also closes the old gap where the picker's late changes were missed.
• Floats. ViewDrag.floatViewHome is withdraw plus goHome, where goHome is sendHome's per-view step pulled out. It only goes ahead if canFloatViewHome holds: the float is there and not closing, it holds the view, it can let go of it (withdraw's closable rule), and somewhere in the main window will show it (homeLanding, float_rules.goHome asked before anything moves).
  • If nowhere would show the view (its home is gone and no place takes it), it stays in the float and the answer is false, so reveal still finds it. Tested on the endless shape.
  • A float that is already closing has nothing left to put away (locate(.open), used only by hide), but reveal still finds a view not home yet.
  • A home tray where the view lands as the selection is shut even when folded, so it doesn't come back as the window widens.
• Two questions about the explorer, kept apart. Toggle Explorer, its menu title and a rail tap (Sidebar.pickAction) all use inSight, so label and action agree.
  • Explorer.isShut(editor): the user or a plugin shut the sidebar region; folding doesn't count, and no sidebar means not shut. It is what the menu title, the explorer_focused keybind context (true when there's no sidebar, as before) and demo snapshots and their fingerprint read, so none of them change with the window's width.
  • Explorer.inSight(editor): neither shut nor folded. Only Toggle Explorer uses it, so a folded explorer opens in one press. hide and reveal count folded as out of sight the same way.
  • Both are plain functions over the sidebar region. Explorer.closed is gone.
• Split.close(id, fallback: ?f32), the root fix, for trays only. A tray that keeps no size (left empty and folded away) is shut as though it had been open at fallback, with nothing sliding. Without a fallback (anything that isn't a tray), an unsized region is left as it was, as before. Region.close passes a fallback only for trays.
  • Nothing is retained past a region's life. A tray declared but not drawn (the hide_when_empty path) reads its _size/_open/_shown each frame, so dvui keeps them exactly as long as the place is declared.
  • Every caller passes the size to reopen to: Region.close (rail, Toggle Explorer, hide), the picker, and ViewDrag.
  • A Split unit test covers both: with a fallback, shut and reopened at it; without one, nothing written.
• Never reopening at 1pt. Region.reopen_extent is filled in State.registerRegion: the user's persisted extent, else default_extent. The tray's declared default, padding and border included, is worked out once in Region.init, before the hide_when_empty early return, and initTree uses the same value.
• Region.tray is decided in one place: Region's register, as resize and !forget_when_empty and !State.isMinted(name). A place that forgets itself when empty couldn't be reopened once forgotten. A place a runtime split made is no tray, so hiding never collapses a user's split pane, and no extra option is needed. fillInBox (regionIn, dockspace cells) registers no tray, because the cell and its size belong to the dockspace. A test checks hide there does nothing.
• Layout.locate: one pass finds the place; its tray is the place itself or, by name, the place it was split from (SplitTree.Forest.rootOf → ViewDrag.regionNamed). reveal opens that tray too.
• One contract. docs/PLUGINS.md §3.1.2, "Showing and putting away", is the authoritative description. Host.hideSurface and Layout.hide point to it.
• One helper for both calls between frames: Editor.onLayout runs reveal or hide on last frame's regions and forwards extents_changed.

Boundary: EditorAPI.VTable.hideSurface(ctx, id) plus the Host/EditorAPI calls. Docs: docs/PLUGINS.md §3.1.2, "Showing and putting away". Corner-button code (#555) is untouched, but Region.zig gains the tray/split_part lines, so a rebase may touch them.

SDK impact

• None
• Core-only or additive: reaches plugins at the next SDK release
• Fingerprint moved: recorded in sdk/src/version.zig (0x5cf2c503df2d415d: the combined value, with main and sdk: a plugin has a data folder of its own #560 merged in), sdk_version untouched, PR labelled sdk
• SDK release: bumps sdk_version, lists the sdk PRs since the last sdk-v* tag

Verified

• macOS: all gates (scripts/check-fmt.sh, zig build, test, test-integration, check-web, test-sdk-version, check-tests-reached, scripts/check-examples.sh). Tests on the layout harnesses (ManyPanelCase, SplitCase), through shared helpers (hideView, revealView, isShut over ViewDrag.regionNamed):

  • a view in sight shuts its tray, reveal reopens it, a second hide is false, an unknown id is false, and Main doesn't shut;
  • a view behind another tab is not hidden, and the one showing is;
  • a floating view goes home and its tray shuts, and the toggle goes round: hide → reveal → hide → reveal;
  • one view of a two-view float goes home alone, the float keeps the other, and the tray shuts;
  • a place split off Main does not shut, and nothing changes;
  • a place in a dockspace cell (regionIn, endless shape) does not shut, and nothing changes;
  • a view in a place split off the panel shuts the panel, a second hide is false, and reveal reopens it;
  • a tray widened to 300, its only view floated out and then hidden, reopens at 300;
  • a view in a float that asks to be hidden from inside its own draw: the answer is true, nothing changes until the frame ends, then it is home and its tray shut;
  • a floating view nowhere in the main window would show (endless shape, home gone): hide is false, it stays in its float, and reveal finds it;
  • a hide and then a reveal asked in one frame end with the view shown;
  • a floating view landing in sight in Main: hideLater and hide both answer false.

  In the whole-editor headless test: Host.hideSurface on Output in the real bottom panel, and hiding the sidebar's view followed by a single Toggle Explorer press that opens it.

• Windows:

• Linux:

• Web: builds (check-web)

Follow-ups

• Workspaces.layoutOf builds a between-frames Layout too, and also drops extents_changed. Left as is here.
• Shapes whose splits come from a seeded dock tree (State.dock) are not covered by trayOf, which reads the split forest.
• devtools' "Show Profiler" could become a toggle with this.
• The rest of fizzyedit/work#33: timed recents, a home surface, and the scrolls_itself warning.

🤖 Generated with Claude Code

[foxnne]

Closing in favour of a narrowed rebuild from current main: hideSurface acts only on a tray's shown view or a float's only view, deferred mid-frame, and leaves the explorer state, Split.close and revealSurface unchanged. This PR grew into reworking those, and kept bringing regressions. The new PR will link here. Its branch is kept for reference.

[foxnne]

Superseded by #593: narrowed to trays and lone floats.