1.1.2 • Published 3 years ago

@accessible/use-id v1.1.2

Weekly downloads
2,989
License
MIT
Repository
github
Last release
3 years ago

Creates unique deterministic IDs to facilitate WAI-ARIA and server rendering. Forked from @reach/auto-id.

Quick Start

import useId from '@accessible/use-id'

const Component = () => {
  const id = useId()
  return <div id={id} />
  // <div id='A:1'>
}

API

useId(fallbackId?: string | null | 0 | false, prefix?: string): string | undefined

A hook that returns a unique, but deterministic ID once per component

Arguments

ArgumentTypeDefaultRequired?Description
fallbackIdstring | null | 0 | falseundefinedNoAllows you to provide your own id as a fallback
prefixstring🅰NoAllows you to provide a prefix for the id to prevent collisions with other auto id libs

Credit

This library is a fork of @reach/auto-id

Why fork?

Reach UI doesn't use real semantic versioning (each of their packages updates versions at the same time regardless of changes to individual packages... nonsense) so it's possible (and annoyingly so) that you could easily wind up with duplicate version of the auto-id package in your bundle. Lastly, the Reach library throws super annoying warnings in SSR because it uses useLayoutEffect. This library uses @react-hook/passive-layout-effect to avoid that.

LICENSE

MIT