Merged
Conversation
Document Prism's current runtime contract more explicitly. What changed: - Clarify that onPaint() and onUpdate() are additive callbacks. - Document manual vs automatic invalidation. - Document repeated registerSurface() behavior for the same element/runtime. - Document wrong-runtime surface behavior. - Clarify that runtime.destroy() disposes registered surfaces. - Document disposed surface behavior. - Clarify paintOnce() behavior without start(), concurrent waiters, inside-paint calls, and pending waiter rejection. - Document that Prism does not expose a general event system or unsubscribe API today. Verification: - pnpm --filter @prism/docs build - pnpm lint - pnpm typecheck - pnpm test
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
1 participant
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.
Summary
Clarifies Prism’s current runtime semantics in the README and docs.
This is a docs-only change that makes callback, invalidation, surface lifecycle,
paintOnce(), and error behavior explicit before the technical preview announcement.Changes
Updated:
README.mdapps/docs/content/docs/explanation/canvas-runtime.mdxapps/docs/content/docs/explanation/invalidation.mdxapps/docs/content/docs/explanation/register-surface.mdxapps/docs/content/docs/explanation/canvas-surface.mdxapps/docs/content/docs/explanation/paint-once.mdxapps/docs/content/docs/reference/api.mdxCovered
onPaint()andonUpdate()are additive callbacks.registerSurface()behavior for the same element/runtime.runtime.destroy().paintOnce()behavior:start()onPaint()wait for the next passVerification
Passed:
pnpm --filter @prism/docs buildpnpm lintpnpm typecheckpnpm testNotes