npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-highlight-hooks

v1.1.0

Published

A React hook to highlight words.

Downloads

18

Readme

Travis build status Codecov branch npm downloads MIT License

gzip size size

Maintainability PRs Welcome

react-highlight-hooks

A React hook to highlight words.

Inspired by react-highlight-words

Getting started

npm install --save react-highlight-hooks

import React from "react";
import { useHighlighter } from "react-highlight-hooks";

function App() {
    const {
        textToSearch,
        setTextToSearch,
        searchTerms,
        setSearchTerms,
        activeIndex,
        setActiveIndex,
        totalHighlights,
        chunks,
    } = useHighlighter({
        textToSearch: "Hello World",
        searchTerms: "hello",
    });

    // ...
}

API

useHighlighter is a React hook that returns the following:

| Name | Description | Type | | --- | --- | --- | | textToSearch | This is the body of text that you will be highlighting words from | String | | setTextToSearch | This is a function to update textToSearch | Function | | searchTerms | This is a space-separated list of words that you are searching for in the textToSearch | String | | setSearchTerms | This is a function to update searchTerms | Function | | activeIndex | This is the index of the currently-active highlighted word | Number | | setActiveIndex | This is a function to update activeIndex | Function | | totalHighlights | This is the number of words highlighted in textToSearch | Number | | chunks | This is an array of object which describe the matches found | Array |

Chunks

chunks is an array of object which describes the matches found. The objects have the following keys:

| Name | Description | Type | | --- | --- | --- | | active | If this item is highlighted and is active, this is true | Boolean | start | This is the index from the textToSearch where this chunk of text begins | Number | | end | This is the index from the textToSearch where this chunk of text ends | Number | | highlight | If this chunk of text is highlighted, this is true | Boolean | | text | This is the chunk of text, which can be derived from the start and end indexes | String |

Example chunks

import React from "react";
import { useHighlighter } from "react-highlight-hooks";

function App() {
    const { chunks } = useHighlighter({
        textToSearch: "Hello World",
        searchTerms: "hello",
    });

    console.log(chunks);
    /*
    [
        {
            highlight: true,
            active: true,
            start: 0,
            end: 5,
            text: 'Hello'
        },
        {
            highlight: false,
            active: false,
            start: 5,
            end: 11,
            text: ' world'
        }
    ]
    */
}