@neosh/api 0.3.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,12 +2,23 @@
2
2
  import type { Dock } from "./Dock";
3
3
  import type { FloatConfig } from "./FloatConfig";
4
4
  import type { Gravity } from "./Gravity";
5
+ import type { PaneId } from "./PaneId";
5
6
 
6
7
  /**
7
8
  * Declarative placement for a window. The frontend turns this into a rectangle.
8
9
  */
9
10
  export type WindowLayout = {
10
11
  "kind": "docked";
12
+ /**
13
+ * Which pane's rectangle `dock` is measured against, or the screen's when absent.
14
+ *
15
+ * An `Option` rather than a pane that happens to mean "the whole screen", because the two
16
+ * are different things and one of them outlives the other: a pane is closed when its split
17
+ * is, and a window docked to the screen — the sidebar, the status line — must not go with
18
+ * it. A window naming a pane that has gone is not drawn at all, which is the honest answer
19
+ * and the one the frontend can give without inventing a rectangle.
20
+ */
21
+ pane?: PaneId | null;
11
22
  dock: Dock;
12
23
  /**
13
24
  * Preferred extent along the dock's variable axis.