1.0.1 • Published 2 years ago

react-incremental-id v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

react-incremental-id

Create customizable incremental string IDs.

Installation

npm add --save react-incremental-id

yarn add react-incremental-id

Usage

react-incremental-id uses a context provider to setup the ID prefix and initial value.

Multiple providers can be used once but nesting them might lead to unpredictable behavior.

import { IncrementalProvider } from "react-incremental-id";

// ...

return (
  <IncrementalProvider>
    {/* Your App */}
  </IncrementalProvider>
);

Then, you can query the next ID using the utility hook useId.

import { useId } from "react-incremental-id";

const Component = () => {
  const titleId = useId();

  return (
    <h1 id={titleId}>Example</h1>
  );
};

Configuration

IncrementalProvider props:

PropDefaultComment
intialVaue0Internal counter initial value. The first invocation of useId will use this value.
prefix""Prefix to add to every generated ID.