useid-polyfill 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dermot Hughes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# useid-polyfill
+
+A React `useId` polyfill for React 16 and 17, with SSR support.
+
+React 18 introduced `useId()` for generating unique, stable IDs — critical for accessibility (ARIA attributes, label associations). This package detects React 18+ and delegates to the native `useId`. On React 16/17, it provides a fallback that avoids hydration mismatches.
+
+## Installation
+
+```bash
+npm install useid-polyfill
+```
+
+## Usage
+
+```tsx
+import { useId } from 'useid-polyfill';
+
+function FormField({ label }: { label: string }) {
+  const id = useId();
+
+  return (
+    <div>
+      <label htmlFor={id}>{label}</label>
+      <input id={id} />
+    </div>
+  );
+}
+```
+
+## API
+
+### `useId(): string | undefined`
+
+Returns a unique, stable ID string. On React 18+, delegates to the native `React.useId()`.
+
+On React 16/17 during SSR, returns `undefined` on the initial server render and hydration pass, then resolves to a string ID after a layout effect. This avoids hydration mismatches.
+
+## SSR Caveats
+
+On React 16/17, the fallback returns `undefined` during server rendering and the hydration pass. The ID is set synchronously before paint via `useLayoutEffect`. This means:
+
+- Elements will briefly have no ID during hydration
+- After the first client-side effect cycle, IDs are assigned immediately (no `undefined` phase)
+- On React 18+, the native `useId` is used and there are no caveats
+
+If you conditionally apply the ID to DOM attributes, handle the `undefined` case:
+
+```tsx
+const id = useId();
+return <input id={id ?? undefined} aria-describedby={id ? `${id}-help` : undefined} />;
+```
+
+## How It Works
+
+1. **React 18+ detection**: If `React.useId` exists, it is used directly
+2. **Fallback (React 16/17)**:
+   - Server: `useState` initializes with `undefined` (no ID in HTML)
+   - Hydration: also `undefined` (matches server output — no mismatch)
+   - `useLayoutEffect` fires before paint, sets the ID via `genId()`
+   - `useEffect` marks handoff complete so subsequent mounts get IDs immediately
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+declare const useId: () => string | undefined;
+
+export { useId };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare const useId: () => string | undefined;
+
+export { useId };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var a=Object.create;var d=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var m=Object.getOwnPropertyNames;var I=Object.getPrototypeOf,g=Object.prototype.hasOwnProperty;var l=(e,t)=>{for(var n in t)d(e,n,{get:t[n],enumerable:!0})},r=(e,t,n,i)=>{if(t&&typeof t=="object"||typeof t=="function")for(let s of m(t))!g.call(e,s)&&s!==n&&d(e,s,{get:()=>t[s],enumerable:!(i=p(t,s))||i.enumerable});return e};var x=(e,t,n)=>(n=e!=null?a(I(e)):{},r(t||!e||!e.__esModule?d(n,"default",{value:e,enumerable:!0}):n,e)),y=e=>r(d({},"__esModule",{value:!0}),e);var $={};l($,{useId:()=>c});module.exports=y($);var E=x(require("react")),o=require("react"),R={...E},h=0,w=Math.random().toString(36).slice(2,6),u=()=>`uid-${w}${h++}`,L=typeof window!="undefined"?o.useLayoutEffect:o.useEffect,f=!1;function S(){let[e,t]=(0,o.useState)(()=>f?u():void 0);return L(()=>{e===void 0&&t(u())},[]),(0,o.useEffect)(()=>{f||(f=!0)},[]),e}var c=R.useId||S;0&&(module.exports={useId});

package/dist/index.mjs

@@ -0,0 +1 @@
+import*as d from"react";import{useState as f,useEffect as o,useLayoutEffect as i}from"react";var r={...d},u=0,c=Math.random().toString(36).slice(2,6),n=()=>`uid-${c}${u++}`,a=typeof window!="undefined"?i:o,e=!1;function p(){let[t,s]=f(()=>e?n():void 0);return a(()=>{t===void 0&&s(n())},[]),o(()=>{e||(e=!0)},[]),t}var m=r.useId||p;export{m as useId};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "useid-polyfill",
+  "version": "1.0.0",
+  "description": "React useId polyfill for React 16/17 with SSR support",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^18.3.28",
+    "@types/react-dom": "^18.3.7",
+    "jsdom": "^28.1.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  },
+  "keywords": [
+    "react",
+    "useId",
+    "polyfill",
+    "accessibility",
+    "a11y",
+    "ssr"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dermothughes/useid-polyfill.git"
+  }
+}