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

@utilityjs/use-hash

v1.0.0

Published

A React hook that helps to sync and modify browser's location hash.

Downloads

1

Readme

A React hook that helps to sync and modify browser's location hash.

license npm latest package npm downloads types

npm i @utilityjs/use-hash | yarn add @utilityjs/use-hash

Usage

import * as React from "react";
import useHash from "@utilityjs/use-hash";

const App: React.FC = () => {
  const hashConsumer = useHash();

  const [key, setKey] = React.useState("");
  const [value, setValue] = React.useState("");

  const addParam = () => {
    hashConsumer.addParam(key, value);
    setKey("");
    setValue("");
  };

  const deleteParam = () => {
    hashConsumer.deleteParam(key);
    setKey("");
    setValue("");
  };

  const deleteValue = () => {
    hashConsumer.deleteParamValue(key, value);
    setKey("");
    setValue("");
  };

  return <div className="app">
    <div>Hash: {hashConsumer.hash}</div>
    <div>Params: {JSON.stringify(hashConsumer.getParams(), null, 2)}</div>
    <br />
    <fieldset>
      <label htmlFor="param-key">Key</label>{" "}
      <input
        value={key}
        type="text"
        name="param:key"
        id="param-key"
        onChange={e => setKey(e.target.value)}
      />
      <br />
      <label htmlFor="param-val">Value</label>{" "}
      <input
        value={value}
        type="text"
        name="param:val"
        id="param-val"
        onChange={e => setValue(e.target.value)}
      />
      <br />
      <br />
      <button onClick={() => void addParam()}>Add Param</button>
      <button onClick={() => void deleteParam()}>Delete Param</button>
      <button onClick={() => void deleteValue()}>Delete Value</button>
      <button onClick={() => void hashConsumer.setHash(value)}>
        Set Hash State
      </button>
    </fieldset>
  </div>;
};

export default App;

API

useHash()

interface HashConsumer {
  /** The hash state. */
  hash: string;

  /** The hash state updater function. */
  setHash: React.Dispatch<React.SetStateAction<string>>;

  /** Returns a boolean value indicating if such a given parameter exists. */
  hasParam: (key: string) => boolean;

  /** Returns all parameters as key/value pairs. */
  getParams: () => Record<string, string | string[]>;

  /** Adds a specified key/value pair as a new parameter. */
  addParam: (key: string, value: string) => void;

  /**
   * Sets the value associated with a given parameter to the given value.
   * If there are several values, the others are deleted.
   */
  setParam: (key: string, value: string) => void;

  /** Deletes the given parameter, and its associated value. */
  deleteParam: (key: string) => void;

  /** Returns the values associated with a given parameter. */
  getParamValue: (key: string) => string | string[] | null;
  
  /**
   * Deletes the value associated with a given parameter.
   * If there aren't several values, the parameter is deleted.
   */
  deleteParamValue: (key: string, value: string) => void;
}

declare const useHash: () => HashConsumer;