Add snapshot canvas theme sidecar support#273
Merged
Conversation
6 tasks
mtopo27
pushed a commit
to getsentry/sentry-docs
that referenced
this pull request
Jul 9, 2026
## DESCRIBE YOUR PR Documents the new `canvas_theme` snapshot metadata introduced in [SnapshotPreviews#273](getsentry/SnapshotPreviews#273). The field sets the light or dark canvas Sentry renders behind a snapshot image in the web UI — it's display metadata only and doesn't change the rendered image. - Add `canvas_theme` to the platform-agnostic sidecar schema (JSON example + field table) in `uploading-snapshots` - Add the `.snapshotCanvasTheme(...)` modifier and `canvas_theme` sidecar field to the Apple SnapshotPreviews metadata doc (example, modifier table, sidecar JSON) ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [x] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) Co-authored-by: Claude <noreply@anthropic.com>
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
2 participants
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.
Adds support for a new metadata property,
canvas_themethat can be associated with a snapshot image. When set, the value is respected by the Sentry web UI and renders the image background according to thelightordarkvalue specified. Expose a view modifier and preference that allows clients to control this value, analogous to the way other image metadata is specified.Refs: EME-1225