Skip to content

feat: add search root element #171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 25, 2025
Merged

feat: add search root element #171

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
295d102
feat: add search root element
ylc395 Apr 25, 2025
82d3760
chore: mark param as optional in comment
ylc395 Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/text-fragment-utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,14 @@ const parseTextFragmentDirective = (textFragment) => {
* process.
* @param {Document} documentToProcess - document where to extract and mark
* fragments in.
* @param {Element=} root - the root element where to extract and mark
* fragments in.
* @return {{text: Element[]}} `<mark>` elements created to highlight the
* text fragments.
*/
export const processFragmentDirectives =
(parsedFragmentDirectives, documentToProcess = document) => {
(parsedFragmentDirectives, documentToProcess = document,
root = document.body) => {
const processedFragmentDirectives = {};
for (const
[fragmentDirectiveType,
Expand All @@ -131,7 +134,7 @@ export const processFragmentDirectives =
processedFragmentDirectives[fragmentDirectiveType] =
fragmentDirectivesOfType.map((fragmentDirectiveOfType) => {
const result = processTextFragmentDirective(
fragmentDirectiveOfType, documentToProcess);
fragmentDirectiveOfType, documentToProcess, root);
if (result.length >= 1) {
// Per spec, the first matching text on the page should be
// highlighted when multiple segments match.
Expand All @@ -150,6 +153,8 @@ export const processFragmentDirectives =
* @param {TextFragment} textFragment - Text Fragment to highlight.
* @param {Document} documentToProcess - document where to extract and mark
* fragments in.
* @param {Element=} root - the root element where to extract and mark
* fragments in.
* @return {Ranges[]} - Zero or more ranges within the document corresponding
* to the fragment. If the fragment corresponds to more than one location
* in the document (i.e., is ambiguous) then the first two matches will be
Expand All @@ -158,11 +163,11 @@ export const processFragmentDirectives =
*/

export const processTextFragmentDirective =
(textFragment, documentToProcess = document) => {
(textFragment, documentToProcess = document, root = document.body) => {
const results = [];

const searchRange = documentToProcess.createRange();
searchRange.selectNodeContents(documentToProcess.body);
searchRange.selectNodeContents(root);

while (!searchRange.collapsed && results.length < 2) {
let potentialMatch;
Expand Down