Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 2.44 KB

README.md

File metadata and controls

95 lines (64 loc) · 2.44 KB
Raw

build status

Bearhug

Bearhug wraps text patterns with configurable html tags. It's fast, flexible, and best of all, has no dependencies.

Download

Usage

Options

The available options that can be passed to window.bearhug.

  • node – The element to wrap patterns within. Required.

  • pattern – A pattern or an array of patterns that bearhug will wrap. Required.

  • tagName – The tag name of the element matched patterns will be wrapped in. Defaults to strong.

  • className – The class of the element matched patterns will be wrapped in.

  • wordsOnly – If true, only whole words will be matched and wrapped. Defaults to false.

  • caseSensitive – If true, pattern matching will be case sensitive. Defaults to false.

Example

<!DOCTYPE html>
<html>
  <head>
    <script src="/bearhug.js"></script>
  </head>
  <body>
    <article id="hipster-ipsum">
      <p>Craft beer cardigan trust fund, swag tumblr pork belly kale chips
      vegan plaid ethical artisan. Mumblecore wolf leggings cornhole before
      they sold out trust fund. Keffiyeh shabby chic pug Pinterest
      letterpress.<p>
    </article>

    <script>
      var node = document.getElementById('hipster-ipsum');

      bearhug({ node: node, pattern: ['beer', 'wolf'], className: 'stuff' })
    </script>
  </body>
</hmtl>

Testing

Tests are written using Jasmine and ran with Karma. To run Bearhug's test suite with PhantomJS, run npm test.

Issues

Found a bug? Create an issue on GitHub.

https://github.com/jharding/bearhug/issues

Versioning

For transparency and insight into the release cycle, releases will be numbered with the follow format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backwards compatibility bumps the major
  • New additions without breaking backwards compatibility bumps the minor
  • Bug fixes and misc changes bump the patch

For more information on semantic versioning, please visit http://semver.org/.

License

Copyright (c) 2013 Jake Harding
Licensed under the MIT License.