Skip to content
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.

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

fix: site example(Search Highlighting) range #5670

Merged
merged 2 commits into from
Jun 28, 2024

Conversation

WindRunnerMax
Copy link
Contributor

Description
When I was testing the 'decorations' feature on the official website (search-highlighting), I noticed that there were some issues with supporting content that had been split into multiple formats.

Issue
none

Example
When I search for "adds", it works pretty well. However, when I perform a search that spans nodes, it doesn't highlight the content very effectively.

20240628191020_rec_

Context
I think it's necessary to tackle this issue. Initially, I planned to start with Range.intersection, by calculating the overlapping ranges at the parent node and judging the intersection of multiple nodes to address this issue. However, I realized that this might impose a burden on the rendering performance of Slate, as it may need to constantly traverse nodes for searching.

Therefore, I resolved this issue here by modifying the example of the site. By clearly identifying the content to be searched and the boundaries of the split nodes to obtain smaller values to form a range, even if the content being searched is very long, it will only save the search content within its own range.

20240628192046_rec_

Additionally, I noticed that there's no option for site changes in the changeset config. Therefore, I believe that this change doesn't require a changeset.

Checks

  • The new code matches the existing patterns and styles.
  • The tests pass with yarn test.
  • The linter passes with yarn lint. (Fix errors with yarn fix.)
  • The relevant examples still work. (Run examples with yarn start.)
  • You've added a changeset if changing functionality. (Add one with yarn changeset add.)

Copy link

changeset-bot bot commented Jun 28, 2024

⚠️ No Changeset found

Latest commit: c350dee

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Collaborator

@dylans dylans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @WindRunnerMax.

I agree with your sentiment as well (updating the example, for now).

@dylans dylans merged commit c46c421 into ianstormtaylor:main Jun 28, 2024
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants