Repository navigation
Add lineBreak: 'whitespace' to wrap lines only at spaces - #1814
Merged
Merged
Conversation
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.
What kind of change does this PR introduce?
A feature. It adds a new value for the existing
lineBreakoption.pdfkit can break a line after a hyphen or a slash, not just at a space. That's correct by the Unicode line breaking rules, but it splits words and links that should stay whole. A tool that reads text back out of the PDF then gets them wrong. Résumé parsers, search, and copy and paste all do this.
Example 1: a hyphenated word
a design-systemdesignsystemlineBreak: 'whitespace'adesign-systemdesign-systemExample 2: a URL
see https://github.com/foliojs/pdfkithttps://github.com/foliojs/, then the wordpdfkitlineBreak: 'whitespace'seehttps://github.com/foliojs/pdfkitThere is no way around this in pdfkit today. The standard 14 fonts have no non-breaking hyphen (see #1040, where
‑renders as blank space), andlineBreak: falsemeans writing your own line wrapping.What the option does
With
lineBreak: 'whitespace', a line breaks only at:), which still shows a hyphen at the line end)A word longer than the whole line is still split where the line ends, as it is today. The default behavior doesn't change. The option also works on a
continuedsegment.The option's type becomes
boolean | 'whitespace'. If this PR is accepted, I'll update@types/pdfkitto match.This PR doesn't fix #956, where the boundary between two
continuedsegments is always a break point.Checklist:
continuedsegmentdocs/text.md