regular-layout 0.2.1 → 0.3.0

package/src/layout/insert_child.ts

@@ -9,7 +9,7 @@
 // ┃  *  [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). *  ┃
 // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
-import type { Layout } from "./types.ts";
+import type { Layout, LayoutPathTraversal } from "./types.ts";
 
 /**
  * Inserts a new child panel into the layout tree at a specified location.
@@ -28,32 +28,32 @@ import type { Layout } from "./types.ts";
 export function insert_child(
 	panel: Layout,
 	child: string,
-	path: number[],
+	path: LayoutPathTraversal,
 	orientation?: "horizontal" | "vertical",
 ): Layout {
 	const createChildPanel = (childId: string): Layout => ({
-		type: "child-panel",
-		child: [childId],
+		type: "tab-layout",
+		tabs: [childId],
 	});
 
 	if (path.length === 0) {
 		// Insert at root level
-		if (panel.type === "child-panel") {
-			// Add to existing child-panel as a tab
+		if (panel.type === "tab-layout") {
+			// Add to existing tab-layout as a tab
 			return {
-				type: "child-panel",
-				child: [child, ...panel.child],
+				type: "tab-layout",
+				tabs: [child, ...panel.tabs],
 			};
 		} else if (orientation) {
 			// When inserting at edge of root, wrap the entire panel in a new split
 			return {
-				type: "split-panel",
+				type: "split-layout",
 				orientation: orientation,
 				children: [createChildPanel(child), panel],
 				sizes: [0.5, 0.5],
 			};
 		} else {
-			// Append to existing split-panel
+			// Append to existing split-layout
 			const newChildren = [...panel.children, createChildPanel(child)];
 			const newSizes = [...panel.sizes, 1 / (newChildren.length - 1)];
 			return {
@@ -69,8 +69,8 @@ export function insert_child(
 
 	// Special case: when orientation is provided and restPath is empty, handle edge insertion
 	if (orientation && restPath.length === 0) {
-		// If panel is a split-panel with the same orientation, insert into its children
-		if (panel.type === "split-panel" && panel.orientation === orientation) {
+		// If panel is a split-layout with the same orientation, insert into its children
+		if (panel.type === "split-layout" && panel.orientation === orientation) {
 			const newChildren = [...panel.children];
 			newChildren.splice(index, 0, createChildPanel(child));
 			const newSizes = [...panel.sizes];
@@ -89,14 +89,14 @@ export function insert_child(
 				: [panel, createChildPanel(child)];
 
 		return {
-			type: "split-panel",
+			type: "split-layout",
 			orientation: orientation,
 			children,
 			sizes: [0.5, 0.5],
 		};
 	}
 
-	if (panel.type === "child-panel") {
+	if (panel.type === "tab-layout") {
 		// Stack into child array only when ALL of these conditions are met:
 		// 1. Path has exactly one element (restPath is empty)
 		// 2. Orientation was NOT explicitly provided (orientation is undefined)
@@ -105,19 +105,19 @@ export function insert_child(
 			restPath.length === 0 &&
 			orientation === undefined &&
 			index >= 0 &&
-			index <= panel.child.length
+			index <= panel.tabs.length
 		) {
-			const newChild = [...panel.child];
+			const newChild = [...panel.tabs];
 			newChild.splice(index, 0, child);
 			return {
 				...panel,
-				child: newChild,
+				tabs: newChild,
 			};
 		}
 
 		// Otherwise, wrap in a split panel and recurse
 		const newPanel: Layout = {
-			type: "split-panel",
+			type: "split-layout",
 			orientation: orientation || "horizontal",
 			children: [panel],
 			sizes: [1],
@@ -130,7 +130,7 @@ export function insert_child(
 		if (orientation && panel.children[index]) {
 			// When inserting at an edge, create a split panel with the new child and existing child
 			const newSplitPanel: Layout = {
-				type: "split-panel",
+				type: "split-layout",
 				orientation: orientation,
 				children: [createChildPanel(child), panel.children[index]],
 				sizes: [0.5, 0.5],
@@ -159,9 +159,9 @@ export function insert_child(
 
 	const targetChild = panel.children[index];
 
-	// Determine the orientation to pass down when navigating into a child-panel
+	// Determine the orientation to pass down when navigating into a tab-layout
 	const childOrientation =
-		targetChild.type === "child-panel" &&
+		targetChild.type === "tab-layout" &&
 		restPath.length > 0 &&
 		orientation !== undefined
 			? panel.orientation === "horizontal"

package/src/layout/redistribute_panel_sizes.ts

@@ -10,7 +10,7 @@
 // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
 import { DEFAULT_PHYSICS } from "./constants.ts";
-import type { Layout } from "./types.ts";
+import type { Layout, LayoutPathTraversal } from "./types.ts";
 
 /**
  * Adjusts panel sizes during a drag operation on a divider.
@@ -31,8 +31,8 @@ import type { Layout } from "./types.ts";
  */
 export function redistribute_panel_sizes(
 	panel: Layout,
-	path: number[],
-	delta: number,
+	path: LayoutPathTraversal,
+	delta: number | undefined,
 	physics = DEFAULT_PHYSICS,
 ): Layout {
 	// Clone the entire panel structure
@@ -41,27 +41,31 @@ export function redistribute_panel_sizes(
 	// Find the orientation of the insertion panel,
 	// and scale the delta on the respective axis if aligned.
 	let current: Layout = result;
-	const deltas = { horizontal: delta, vertical: delta };
+	const deltas = { horizontal: delta || 0, vertical: delta || 0 };
 	for (let i = 0; i < path.length - 1; i++) {
-		if (current.type === "split-panel") {
+		if (current.type === "split-layout") {
 			deltas[current.orientation] /= current.sizes[path[i]];
 			current = current.children[path[i]];
 		}
 	}
 
 	// Apply the redistribution at the final path index
-	if (current.type === "split-panel") {
-		const delta = deltas[current.orientation];
-		const index = path[path.length - 1];
+	if (current.type === "split-layout") {
+		if (delta === undefined) {
+			current.sizes = current.sizes.map((_) => 1 / current.sizes.length);
+		} else {
+			const delta = deltas[current.orientation];
+			const index = path[path.length - 1];
 
-		// It would be fun to remove this condition.
-		if (index < current.sizes.length - 1) {
-			current.sizes = add_and_redistribute(
-				physics,
-				current.sizes,
-				index,
-				delta,
-			);
+			// It would be fun to remove this condition.
+			if (index < current.sizes.length - 1) {
+				current.sizes = add_and_redistribute(
+					physics,
+					current.sizes,
+					index,
+					delta,
+				);
+			}
 		}
 	}
 

package/src/layout/remove_child.ts

@@ -25,15 +25,15 @@ import { EMPTY_PANEL } from "./types.ts";
  */
 export function remove_child(panel: Layout, child: string): Layout {
 	// If this is a child panel, handle tab removal
-	if (panel.type === "child-panel") {
-		if (panel.child.includes(child)) {
-			const newChild = panel.child.filter((c) => c !== child);
+	if (panel.type === "tab-layout") {
+		if (panel.tabs.includes(child)) {
+			const newChild = panel.tabs.filter((c) => c !== child);
 			if (newChild.length === 0) {
 				return structuredClone(EMPTY_PANEL);
 			}
 			return {
-				type: "child-panel",
-				child: newChild,
+				type: "tab-layout",
+				tabs: newChild,
 			};
 		}
 
@@ -45,8 +45,8 @@ export function remove_child(panel: Layout, child: string): Layout {
 
 	// Try to remove the child from this split panel's children
 	const index = result.children.findIndex((p) => {
-		if (p.type === "child-panel") {
-			return p.child.includes(child);
+		if (p.type === "tab-layout") {
+			return p.tabs.includes(child);
 		}
 
 		return false;
@@ -54,7 +54,7 @@ export function remove_child(panel: Layout, child: string): Layout {
 
 	if (index !== -1) {
 		const tab_layout = result.children[index] as TabLayout;
-		if (tab_layout.child.length === 1) {
+		if (tab_layout.tabs.length === 1) {
 			// Found the child at this level - remove it
 			const newChildren = result.children.filter((_, i) => i !== index);
 			const newSizes = remove_and_redistribute(result.sizes, index);
@@ -67,10 +67,10 @@ export function remove_child(panel: Layout, child: string): Layout {
 			result.children = newChildren;
 			result.sizes = newSizes;
 		} else {
-			tab_layout.child.splice(tab_layout.child.indexOf(child), 1);
+			tab_layout.tabs.splice(tab_layout.tabs.indexOf(child), 1);
 			if (
 				tab_layout.selected &&
-				tab_layout.selected >= tab_layout.child.length
+				tab_layout.selected >= tab_layout.tabs.length
 			) {
 				tab_layout.selected--;
 			}
@@ -82,7 +82,7 @@ export function remove_child(panel: Layout, child: string): Layout {
 	// Child not found at this level - recursively search children
 	let modified = false;
 	const newChildren = result.children.map((p) => {
-		if (p.type === "split-panel") {
+		if (p.type === "split-layout") {
 			const updated = remove_child(p, child);
 			if (updated !== p) {
 				modified = true;

package/src/layout/types.ts

@@ -34,7 +34,6 @@ export interface ViewWindow {
 	col_end: number;
 }
 
-
 /**
  * A split panel that divides space among multiple child layouts
  * .
@@ -48,7 +47,7 @@ export interface ViewWindow {
  * opposite `orientation` as its parent.
  */
 export interface SplitLayout {
-	type: "split-panel";
+	type: "split-layout";
 	children: Layout[];
 	sizes: number[];
 	orientation: Orientation;
@@ -58,33 +57,34 @@ export interface SplitLayout {
  * A leaf panel node that contains a single named child element.
  */
 export interface TabLayout {
-	type: "child-panel";
-	child: string[];
+	type: "tab-layout";
+	tabs: string[];
 	selected?: number;
 }
 
+/**
+ * Represents a panel location relative to a `Layout` struct.
+ */
+export type LayoutPathTraversal = number[];
+
 /**
  * Represents a draggable divider between two panels in the layout.
  *
  * Used for hit detection.
  */
 export interface LayoutDivider {
-	path: number[];
+	path: LayoutPathTraversal;
 	view_window: ViewWindow;
 	type: Orientation;
 }
 
 /**
  * Represents a panel location result from hit detection.
- *
- * Contains both the panel identifier and its grid position in relative units.
- * The generic parameter `T` allows DOM-only properties (e.g. `DOMRect`) to be
- * shared in this cross-platform module.
  */
-export interface LayoutPath<T = undefined> {
+export interface LayoutPath {
 	type: "layout-path";
 	slot: string;
-	path: number[];
+	path: LayoutPathTraversal;
 	view_window: ViewWindow;
 	column: number;
 	row: number;
@@ -92,14 +92,14 @@ export interface LayoutPath<T = undefined> {
 	row_offset: number;
 	orientation: Orientation;
 	is_edge: boolean;
-	layout: T;
+	layout: Layout;
 }
 
 /**
  * An empty `Layout` with no panels.
  */
 export const EMPTY_PANEL: Layout = {
-	type: "split-panel",
+	type: "split-layout",
 	orientation: "horizontal",
 	sizes: [],
 	children: [],

package/src/regular-layout-frame.ts

@@ -9,7 +9,7 @@
 // ┃  *  [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). *  ┃
 // ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
 
-import type { Layout, LayoutPath } from "./layout/types.ts";
+import type { LayoutPath } from "./layout/types.ts";
 import type { RegularLayoutEvent } from "./extensions.ts";
 import type { RegularLayout } from "./regular-layout.ts";
 import type { RegularLayoutTab } from "./regular-layout-tab.ts";
@@ -29,6 +29,8 @@ const HTML_TEMPLATE = `
 	<slot part="container"></slot>
 `;
 
+type DragState = { moved?: boolean; path: LayoutPath };
+
 /**
  * A custom element that represents a draggable panel within a
  * `<regular-layout>`.
@@ -55,29 +57,31 @@ const HTML_TEMPLATE = `
  * ```
  */
 export class RegularLayoutFrame extends HTMLElement {
-	private _shadowRoot: ShadowRoot;
-	private _container_sheet: CSSStyleSheet;
+	private _shadowRoot!: ShadowRoot;
+	private _container_sheet!: CSSStyleSheet;
 	private _layout!: RegularLayout;
 	private _header!: HTMLElement;
-	private _drag_state: LayoutPath<Layout> | null = null;
-	private _drag_moved: boolean = false;
+	private _drag: DragState | null = null;
 	private _tab_to_index_map: WeakMap<RegularLayoutTab, number> = new WeakMap();
-	constructor() {
-		super();
-		this._container_sheet = new CSSStyleSheet();
-		this._container_sheet.replaceSync(CSS);
-		this._shadowRoot = this.attachShadow({ mode: "open" });
-		this._shadowRoot.adoptedStyleSheets = [this._container_sheet];
-	}
 
+	/**
+	 * Initializes this elements. Override this method and
+	 * `disconnectedCallback` to modify how this subclass renders the Shadow
+	 * DOM and registers events.
+	 */
 	connectedCallback() {
+		this._container_sheet ??= new CSSStyleSheet();
+		this._container_sheet.replaceSync(CSS);
+		this._shadowRoot ??= this.attachShadow({ mode: "open" });
+		this._shadowRoot.adoptedStyleSheets = [this._container_sheet];
 		this._shadowRoot.innerHTML = HTML_TEMPLATE;
 		this._layout = this.parentElement as RegularLayout;
 		this._header = this._shadowRoot.children[0] as HTMLElement;
 		this._header.addEventListener("pointerdown", this.onPointerDown);
-		this._header.addEventListener("pointermove", this.onPointerMove);
-		this._header.addEventListener("pointerup", this.onPointerUp);
-		this._header.addEventListener("lostpointercapture", this.onPointerLost);
+		this.addEventListener("pointermove", this.onPointerMove);
+		this.addEventListener("pointerup", this.onPointerUp);
+		this.addEventListener("pointercancel", this.onPointerCancel);
+		this.addEventListener("lostpointercapture", this.onPointerLost);
 		this._layout.addEventListener("regular-layout-update", this.drawTabs);
 		this._layout.addEventListener(
 			"regular-layout-before-update",
@@ -85,11 +89,15 @@ export class RegularLayoutFrame extends HTMLElement {
 		);
 	}
 
+	/**
+	 * Destroys this element.
+	 */
 	disconnectedCallback() {
 		this._header.removeEventListener("pointerdown", this.onPointerDown);
-		this._header.removeEventListener("pointermove", this.onPointerMove);
-		this._header.removeEventListener("pointerup", this.onPointerUp);
-		this._header.removeEventListener("lostpointercapture", this.onPointerLost);
+		this.removeEventListener("pointermove", this.onPointerMove);
+		this.removeEventListener("pointerup", this.onPointerUp);
+		this.removeEventListener("pointercancel", this.onPointerUp);
+		this.removeEventListener("lostpointercapture", this.onPointerLost);
 		this._layout.removeEventListener("regular-layout-update", this.drawTabs);
 		this._layout.removeEventListener(
 			"regular-layout-before-update",
@@ -100,75 +108,52 @@ export class RegularLayoutFrame extends HTMLElement {
 	private onPointerDown = (event: PointerEvent): void => {
 		const elem = event.target as RegularLayoutTab;
 		if (elem.part.contains("tab")) {
-			this._drag_state = this._layout.calculateIntersect(
-				event.clientX,
-				event.clientY,
-			);
-
-			if (this._drag_state) {
-				this._header.setPointerCapture(event.pointerId);
+			const path = this._layout.calculateIntersect(event);
+			if (path) {
+				this._drag = { path };
+				this.setPointerCapture(event.pointerId);
 				event.preventDefault();
+			} else {
+				this._drag = null;
 			}
 		}
 	};
 
 	private onPointerMove = (event: PointerEvent): void => {
-		if (this._drag_state) {
+		if (this._drag) {
 			const physics = this._layout.savePhysics();
-
-			// Only initiate a drag if the cursor has moved sufficiently.
-			if (!this._drag_moved) {
-				const [current_col, current_row, box] =
-					this._layout.relativeCoordinates(event.clientX, event.clientY);
-
-				const dx = (current_col - this._drag_state.column) * box.width;
-				const dy = (current_row - this._drag_state.row) * box.height;
-				if (Math.sqrt(dx * dx + dy * dy) <= physics.MIN_DRAG_DISTANCE) {
+			if (!this._drag.moved) {
+				const diff = this._layout.diffCoordinates(event, this._drag.path);
+				if (diff <= physics.MIN_DRAG_DISTANCE) {
 					return;
 				}
 			}
 
-			this._drag_moved = true;
-			this._layout.setOverlayState(
-				event.clientX,
-				event.clientY,
-				this._drag_state,
-				physics.OVERLAY_CLASSNAME,
-			);
+			this._drag.moved = true;
+			this._layout.setOverlayState(event, this._drag.path);
 		}
 	};
 
 	private onPointerUp = (event: PointerEvent): void => {
-		if (this._drag_state && this._drag_moved) {
-			this._layout.clearOverlayState(
-				event.clientX,
-				event.clientY,
-				this._drag_state,
-			);
+		if (this._drag?.moved) {
+			this._layout.clearOverlayState(event, this._drag.path);
 		}
-
-		// TODO This may be handled by `onPointerLost`, not sure if this is
-		// browser-specific behavior ...
-		this._header.releasePointerCapture(event.pointerId);
-		this._drag_state = null;
-		this._drag_moved = false;
 	};
 
-	private onPointerLost = (event: PointerEvent): void => {
-		if (this._drag_state) {
-			this._layout.clearOverlayState(-1, -1, this._drag_state);
+	private onPointerCancel = (_: PointerEvent): void => {
+		if (this._drag?.moved) {
+			this._layout.clearOverlayState(null, this._drag.path);
 		}
+	};
 
-		this._header.releasePointerCapture(event.pointerId);
-		this._drag_state = null;
-		this._drag_moved = false;
+	private onPointerLost = (event: PointerEvent): void => {
+		this.releasePointerCapture(event.pointerId);
+		this._drag = null;
 	};
 
 	private drawTabs = (event: RegularLayoutEvent) => {
-		const slot = this.getAttribute(
-			this._layout.savePhysics().CHILD_ATTRIBUTE_NAME,
-		);
-
+		const attr = this._layout.savePhysics().CHILD_ATTRIBUTE_NAME;
+		const slot = this.getAttribute(attr);
 		if (!slot) {
 			return;
 		}
@@ -177,13 +162,13 @@ export class RegularLayoutFrame extends HTMLElement {
 		let new_tab_panel = this._layout.getPanel(slot, new_panel);
 		if (!new_tab_panel) {
 			new_tab_panel = {
-				type: "child-panel",
-				child: [slot],
+				type: "tab-layout",
+				tabs: [slot],
 				selected: 0,
 			};
 		}
 
-		for (let i = 0; i < new_tab_panel.child.length; i++) {
+		for (let i = 0; i < new_tab_panel.tabs.length; i++) {
 			if (i >= this._header.children.length) {
 				const new_tab = document.createElement("regular-layout-tab");
 				new_tab.populate(this._layout, new_tab_panel, i);
@@ -195,7 +180,7 @@ export class RegularLayoutFrame extends HTMLElement {
 			}
 		}
 
-		const last_index = new_tab_panel.child.length;
+		const last_index = new_tab_panel.tabs.length;
 		for (let j = this._header.children.length - 1; j >= last_index; j--) {
 			this._header.removeChild(this._header.children[j]);
 		}

package/src/regular-layout-tab.ts

@@ -40,11 +40,11 @@ export class RegularLayoutTab extends HTMLElement {
 				(index === this._tab_panel?.selected);
 
 			const index_changed =
-				tab_changed || this._tab_panel?.child[index] !== tab_panel.child[index];
+				tab_changed || this._tab_panel?.tabs[index] !== tab_panel.tabs[index];
 
 			if (index_changed) {
 				const selected = tab_panel.selected === index;
-				const slot = tab_panel.child[index];
+				const slot = tab_panel.tabs[index];
 				this.children[0].textContent = slot;
 
 				if (selected) {
@@ -56,7 +56,7 @@ export class RegularLayoutTab extends HTMLElement {
 				}
 			}
 		} else {
-			const slot = tab_panel.child[index];
+			const slot = tab_panel.tabs[index];
 			const selected = tab_panel.selected === index;
 			const parts = selected ? "active-close close" : "close";
 			this.innerHTML = `<div part="title"></div><button part="${parts}"></button>`;
@@ -78,7 +78,7 @@ export class RegularLayoutTab extends HTMLElement {
 
 	private onTabClose = (_: Event) => {
 		if (this._tab_panel !== undefined && this._index !== undefined) {
-			this._layout?.removePanel(this._tab_panel.child[this._index]);
+			this._layout?.removePanel(this._tab_panel.tabs[this._index]);
 		}
 	};
 
@@ -90,7 +90,7 @@ export class RegularLayoutTab extends HTMLElement {
 		) {
 			const new_layout = this._layout?.save();
 			const new_tab_panel = this._layout?.getPanel(
-				this._tab_panel.child[this._index],
+				this._tab_panel.tabs[this._index],
 				new_layout,
 			);