Table of contents

• Overview
• Install
• Usage
  • API
• Development

Overview

This library is designed to highlight text. Using it, you can go through all text nodes (from the start node to the final node) and wrap them in a span with the desired class.

Install

npm install @hooked74/highlight

Usage

import Highlight from "@hooked74/highlight";

const hl = new Highlight();
// wrap the range from window.getSelection()
// return the identifier of this highlight
const id = hl.fromSelect();

// remove highlight
hl.remove(id);

API

hl.fromSelect([options])

• options <{id: string, className: string}> id - Identifier of this highlight, which can be used instead of generated. className - class to be used for highlighting. id, className are optional, as options.
• Returns: <string> Identifier of this highlight.

Wrap the range from window.getSelection().

hl.fromRange(range[, options])

• range <window.Range> Range to be wrapped.
• options <{id: string, className: string}> id - Identifier of this highlight, which can be used instead of generated. className - class to be used for highlighting. id, className are optional, as options.
• Returns: <string> Identifier of this highlight.

Wrap the passed range.

hl.fromNodes(startNode, endNode[, startOffset, endOffset, options])

• startNode <Node> Range start node.
• endNode <Node> Range end node.
• startOffset <number> Start node offset.
• endOffset <number> End node offset.
• options <{id: string, className: string}> id - Identifier of this highlight, which can be used instead of generated. className - class to be used for highlighting. id, className are optional, as options.
• Returns: <string> Identifier of this highlight.

Wrap a range of start node and end node.

hl.remove(id)

• id <string> Identifier of this highlight.
• Returns: <void>

Remove highlight.

Development

You can run some built-in commands:

npm run storybook

This command allows you to run a storybook in development mode. By default, it will be launched on http://localhost:9002. The port can be configured in the .env file. Storybook is an open source tool for developing UI components in isolation for React, Vue, and Angular. It makes building stunning UIs organized and efficient.

npm run build

Builds the app for production. Your app is ready to be deployed.

npm run test:watch

Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.

npm run test:browser:open

Runs tests using cypress. Defaults to port 9002. The port can be configured in the .env file.
To run the tests, you need a running server with the base url specified in .env in the variable CYPRESS_BASE_URL.

npm run test:browser

Runs tests using cypress. Defaults to port 9002. The port can be configured in the .env file. Also on the same port a storybook will be launched over which testing will be carried out.