docs: document sash.store one-way-seed intent and tech debt#58
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Expands the comment on
Sash.store(src/sash.js) from a one-liner into a/* */block documenting its intended design and a known tech-debt gap.Why
storeis meant to be a one-way construction seed — config props flow from the top-level API into pane/glass construction, then stop. Data exchange for moves (attach/detach/swap) happens at the DOM layer, which is visible and debuggable in the browser.But the code doesn't fully honor that yet:
onDrop(droppable.js) is read at drop time andresizable(muntin.js) when a pane is split — both long after construction. So anyone who tries to clearstoreinonPaneCreate(a reasonable thing to attempt) would silently break per-paneonDropcallbacks andresizable-on-split.The comment now records:
storecan't be cleared untilonDrop/resizableare moved onto the DOM/closures at build time.Scope
Comment only — no behavior change.