feat: rename BOXED_TEXT tool type to COMB_TEXT#35
Merged
Conversation
"Comb" is the Acrobat / PDF-spec term for box-per-character fields (IBAN, dates, CERFA). The react SDK ToolType now exposes COMB_TEXT instead of BOXED_TEXT, and the copilot, docs, and examples use COMB_TEXT throughout. Runtime stays backwards-compatible: the editor still accepts the legacy BOXED_TEXT value, so already-deployed embeds keep working; only the TypeScript type changes. Ships as a major changeset for @simplepdf/react-embed-pdf. Also fixes the pre-existing copilot biome check failures (formatting + useOptionalChain) and adds two justified biome-ignores, so check is green.
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.
Background
The editor renamed its
BOXED_TEXTcomb-field type toCOMB_TEXT("comb" is the Acrobat / PDF-spec term for box-per-character fields like IBAN, dates, CERFA). The embed artifacts still referenced the old name. The editor accepts both values at runtime, so this is a type/naming change, not a runtime break.Changes
BOXED_TEXTwithCOMB_TEXTin the reactToolType(README + test updated)@simplepdf/react-embed-pdfboxedText->combText, en label "Comb text")documentation/IFRAME.mdand thewith-custom-sidebarexamplebiome checkfailures (formatting +useOptionalChain) and add two justifiedbiome-ignores socheckis greenNotes
Runtime is backwards-compatible: the editor still accepts
BOXED_TEXT, so already-deployed embeds keep working; only the TypeScript type changes.