go-results-highlighter

3.0.5 • Public • Published

Go Results Highlighter

Highlighter in action

Visit go-results-highlighter's website to see the Highlighter in action and explore more usage scenarios.

About

The goal of this library is to improve readability of Go result tables by highlighting opponent rows for the selected player.

This is the rewritten version of jQuery Table Result for Go. It was created to provide jQuery independent version of the plugin and serve it using popular package managers such as Bower or NPM.

Highlighter Web Component

Version 2.1.0 introduced highlighter as Web Component

Add this script to your side:

<script src="//cdn.jsdelivr.net/npm/go-results-highlighter/dist/component.js"></script>

Then wrap your results with this go-results tag:

<go-results>
  Results - html table or plain text
</go-results>

Installation

You can use NPM or Bower to install Highlighter or you can just grab a copy from GitHub.

Learn more about installation

Usage

Once the script is included to the page, it will automatically search for nodes with data-go-results attribute and make them interactive.

If that's not enough - learn more about the usage

Go Results Highlighter API

The Highlighter not only handle mouse event but also provides easy to use interface allowing developers to programmatically highlight rows with results.

Learn more about API

Common use cases

License

The MIT License (MIT)

Copyright (c) 2023 Artur Barcicki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i go-results-highlighter

Weekly Downloads

211

Version

3.0.5

License

MIT

Unpacked Size

130 kB

Total Files

25

Last publish

Collaborators

  • barcicki