Repository navigation
docs: add framework-agnostic Region & Text Capture concept guide - #350
Merged
Merged
Conversation
Capture (region/square/circle/lasso + text selection) is a headline feature but had no dedicated concept page — only per-framework mentions. Documents the core primitives createAskableRegionCapture and createAskableTextSelectionCapture (shapes, options, handle, SSR-inert behavior), the framework hook table, and the Context-packet output. Wires it into the Concepts sidebar.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
Summary
Adds a dedicated Capture concept guide. Region / square / circle / lasso and text-selection capture is a headline feature, but there was no framework-agnostic concept page for it — only per-framework mentions inside the React/Vue guides.
What's included
site/docs/guide/capture.mddocumenting the core primitives:createAskableRegionCapture(ctx, options)— the four shapes, key options (minSize,once,selectionAffordance,theme, callbacks), and the handle (start/cancel/clearSelection/getSelection/destroy/isActive)createAskableTextSelectionCapture(ctx, options)—captureNow(),minLength,debounce,dedupe, etc.useAskableRegionCapture/useAskableTextSelectionCaptureacross React/Vue/Svelte/Solid) with a React exampleNotes
{ start, active, lastPacket }return shape was verified againstpackages/core/src/capture.ts,selection.ts, and the framework hooks. Docs-only; no code changes.Test plan
vitepress buildclean (no dead links) — the same check the CIpreviewjob runs🤖 Generated with Claude Code
Generated by Claude Code