https://github.com/phlowerteam/fragment_highlighter-rails

JavaScript UI library for highlighting text fragments on the page and saving ones into localStorage
https://github.com/phlowerteam/fragment_highlighter-rails

fragments highlight javascript localstorage text

Last synced: about 2 months ago
JSON representation

JavaScript UI library for highlighting text fragments on the page and saving ones into localStorage

• Host: GitHub
• URL: https://github.com/phlowerteam/fragment_highlighter-rails
• Owner: phlowerteam
• License: mit
• Created: 2017-11-09T18:37:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-12-09T09:12:17.000Z (over 7 years ago)
• Last Synced: 2025-10-09T11:58:56.141Z (9 months ago)
• Topics: fragments, highlight, javascript, localstorage, text
• Language: Ruby
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# fragment_highlighter-rails

JavaScript UI library for highlighting text fragments on page and saving ones into localStorage

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'fragment_highlighter-rails'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install fragment_highlighter-rails

## Usage

#application.css

    @import "bootstrap-sprockets";

    @import "bootstrap";

    *= require 'fragment-highlighter'

#application.js

    //= require jquery

    //= require bootstrap-sprockets

    //= require fragment-highlighter/fragment-highlighter.js

    $(function() {

      let options = { allowedPages: ['/articles/'], deniedPages: ['/admin/'] };

      new FragmentHighlighter(options);

    });

## Video Presentation

[![Watch the video](https://img.youtube.com/vi/sHj-CwYDRhU/0.jpg

)](https://www.youtube.com/watch?v=sHj-CwYDRhU)

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/phlowerteam/fragment_highlighter-rails.