Better control over DOM changes that trigger searches

Breaking Changes

• Previously you could pass findAndReplaceDOMText options directly, now they must be in a sub object called passThrough.
  • v1.3.0 - findInNw.initialize({ preset: 'prose' });
  • v2.0.0 - findInNw.initialize({ passThrough: { preset: 'prose' } });

Features

• The search re-runs if the DOM changes, but that isn't always desirable. You can now pass in a list of classes or ID's that should not trigger re-running the search if they change in the DOM.
• There is also a verbose option that can be enabled to see a list of all DOM elements that changed, triggering a re-run of the search function

Special thanks to @DavidAccola for the feature request (#23)

Maintenance

• Updated documentation

Code Changes

• v1.3.0...v2.0.0
• v1.2.0...v2.0.0
• v1.1.3...v2.0.0
• v1.1.1...v2.0.0
• v1.1.0...v2.0.0
• v1.0.0...v2.0.0

Update results on DOM changes, don't show hidden results

Bug Fixes

• Search results now no longer include non-visible text (display: none, font-size: 0, visibility: hidden, etc)

Features

• The search results now update after any DOM change

Special thanks to @DavidAccola for the feature request (#23)

Maintenance

• Updated dependencies

Code Changes

• v1.2.0...v1.3.0
• v1.1.3...v1.3.0
• v1.1.1...v1.3.0
• v1.1.0...v1.3.0
• v1.0.0...v1.3.0

Case Sensitivy and Options pass-thru

Features

• Added a button to toggle Case Sensitive or Case Insensitive search
• API now lets you pass in an options object for findAndReplaceDOMText

Special thanks to @DavidAccola for the feature request (#21)

Maintenance

• Updated dependencies

Code Changes

• v1.1.3...v1.2.0
• v1.1.1...v1.2.0
• v1.1.0...v1.2.0
• v1.0.0...v1.2.0

Search starts with visible matches, excludes search box

Bug fixes

• No longer matches against the contents of the searchbox itself

Features

• When searching it sets the "current" matching token to the first match within view at the current scroll location.

Special thanks to @suziwen for the pull request (#14)

Maintenance

• Updated dependencies

Code Changes

• v1.1.1...v1.1.3
• v1.1.0...v1.1.3
• v1.0.0...v1.1.3

Auto-Search highlight text, retain last searched

Bug fixes

• None

Features

• When you highlight text, then press CTRL+F, it will display a search box and automatically place that text in the box and perform a search.
• When you close the search box and reopen it later, it will retain the last searched value and perform a search instantly.

Special thanks to @suziwen for the pull request (#11).

Maintenance

• Updated dependencies

Code Changes

• v1.1.0...v1.1.1
• v1.0.0...v1.1.1

Next/Previous match

Bug fixes

• There was a bug where the total count could be off. This is fixed.

Features

• There are now previous/next buttons
• Clicking them will highlight the next (or previous) matching item, and will scroll it into position
• Pressing ENTER after typing will do the same as hitting next

Special thanks to @suziwen for the feature request (#6).

Maintenance

• Updated dependencies
• Updated documentation
• Created a new demo gif
• Added a Code of Conduct

Code Changes

• v1.0.0...v1.1.0

Initial Release

Features:

• CTRL+F to show search box
• ESC to hide search box
• Find as you type
• DOM is not mangled during search
• Uglified/Minified all-in-one build file, so no additional dependencies are required