Skip to content

docs: document sash.store one-way-seed intent and tech debt #58

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.

Sign up for GitHub

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

Merged
ohxyz merged 1 commit into from
Jun 11, 2026
Merged

docs: document sash.store one-way-seed intent and tech debt #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion src/sash.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,20 @@ export class Sash {
this.minWidth = minWidth;
this.minHeight = minHeight;
this.resizeStrategy = resizeStrategy;
// Store non-core props from `ConfigNode` e.g. content, title, tabs, actions, etc
/*
* Stores non-core props from `ConfigNode` e.g. content, title, tabs, actions, event
* handlers (e.g. `onDrop`).
*
* RATIONAL: `store` is meant as a one-way seed — it carries these from the
* top-level API into pane/glass construction, then should stop. It is NOT a live
* model: moves like attach/detach/swap exchange data through the DOM, not here,
* because the DOM is visible and easy to debug in the browser.
*
* TECH DEBT: not yet a pure seed — `onDrop` (droppable.js) is read at drop time
* and `resizable` (muntin.js) when a pane is split, both long after construction.
* Until those are moved onto the DOM/closures at build time, `store` can't be
* cleared in `onPaneCreate` without breaking them.
*/
this.store = store;
}

Expand Down