Document webframe page and visitor context#1249
Merged
gregberge merged 1 commit intoJul 17, 2026
Merged
Conversation
Document the contextual `state` GitBook injects into an integration block
webframe: `state.page` ({ id, path, title }, always available) and
`state.visitor` (visitor claims, with the site:visitor:claims scope), and
restore the site:visitor:claims scope in the configuration reference.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
commit: |
taranvohra
approved these changes
Jul 17, 2026
gregberge
deleted the
greg/rnd-12101-allow-webframe-in-integration-block-to-be-aware-of-the-full
branch
July 17, 2026 08:33
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.
What
Document the contextual
stateGitBook injects into an integration block webframe, alongside the values bound through thedataprop:state.page— the current page as{ id, path, title }. Always available.state.visitor— the visitor claims, when the integration has thesite:visitor:claimsscope.Also restores the
site:visitor:claimsscope entry in the configuration reference.Why
RND-12101 — an integration's webframe needs to be aware of the page it is rendered on. Frontend implementation: GitbookIO/gitbook#4411.
Changes
contentkit/interactivity.md+guides/interactivity.md: new "Page and visitor context" section.development/contentkit/reference.md: notestate.page/state.visitorin thewebframereference.configurations.md: restore thesite:visitor:claimsscope.Docs-only; no changeset (docs are not a versioned package in this repo).
🤖 Generated with Claude Code