@contractspec/lib.accessibility 3.7.5 → 3.7.7

package/README.md

@@ -1,79 +1,67 @@
 # @contractspec/lib.accessibility
 
-Website: https://contractspec.io/
+Website: https://contractspec.io
 
+**WCAG compliance utilities and validators.**
 
-Stable exports of accessibility primitives for LSSM web apps, ensuring WCAG compliance and inclusive design.
+## What It Provides
 
-## Purpose
-
-To provide a standardized set of accessibility components and hooks that handle focus management, screen reader announcements, and motion preferences across Next.js and React applications.
+- **Layer**: lib.
+- **Consumers**: design-system, example apps.
+- Related ContractSpec packages include `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit`, `@contractspec/lib.ui-kit-web`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
+- Related ContractSpec packages include `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit`, `@contractspec/lib.ui-kit-web`, `@contractspec/tool.bun`, `@contractspec/tool.typescript`.
 
 ## Installation
 
-```bash
-npm install @contractspec/lib.accessibility
-# or
-bun add @contractspec/lib.accessibility
-```
+`npm install @contractspec/lib.accessibility`
 
-## Key Concepts
+or
 
-- **Focus Management**: Automatically handle focus transitions on route changes.
-- **Live Regions**: reliably announce dynamic content updates to screen readers.
-- **Reduced Motion**: Respect user system preferences for animation.
-- **Hidden Content**: Visually hide content while keeping it available for assistive technology.
+`bun add @contractspec/lib.accessibility`
 
-## Exports
+## Usage
 
-- `SkipLink`: A link to skip navigation, visible on focus.
-- `VisuallyHidden`: Component to hide content from sighted users but keep it for screen readers.
-- `SRLiveRegionProvider`, `useSRLiveRegion`: Context and hook for managing live region announcements.
-- `RouteAnnouncer`: Component that announces page title/path changes on navigation.
-- `FocusOnRouteChange`: Component that resets focus to body or main content on navigation.
-- `useReducedMotion`: Hook to detect if the user prefers reduced motion.
+Import the root entrypoint from `@contractspec/lib.accessibility`, or choose a documented subpath when you only need one part of the package surface.
 
-## Usage
+## Architecture
+
+- `src/AccessibilityPanel.tsx` is part of the package's public or composition surface.
+- `src/AccessibilityProvider.tsx` is part of the package's public or composition surface.
+- `src/index.ts` is the root public barrel and package entrypoint.
+- `src/nativewind-env.d.ts` is part of the package's public or composition surface.
+- `src/next-route-announcer.tsx` is part of the package's public or composition surface.
+- `src/preferences.tsx` is part of the package's public or composition surface.
+- `src/styles.css` is part of the package's public or composition surface.
+
+## Public Entry Points
+
+- Export `.` resolves through `./src/index.ts`.
+- Export `./AccessibilityPanel` resolves through `./src/AccessibilityPanel.tsx`.
+- Export `./AccessibilityProvider` resolves through `./src/AccessibilityProvider.tsx`.
+- Export `./nativewind-env.d` resolves through `./src/nativewind-env.d.ts`.
+- Export `./next-route-announcer` resolves through `./src/next-route-announcer.tsx`.
+- Export `./preferences` resolves through `./src/preferences.tsx`.
+
+## Local Commands
+
+- `bun run dev` — contractspec-bun-build dev
+- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
+- `bun run lint` — bun lint:fix
+- `bun run lint:check` — biome check .
+- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
+- `bun run typecheck` — tsc --noEmit
+- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
+- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
+- `bun run clean` — rimraf dist .turbo
+- `bun run build:bundle` — contractspec-bun-build transpile
+- `bun run build:types` — contractspec-bun-build types
+- `bun run prebuild` — contractspec-bun-build prebuild
+
+## Recent Updates
+
+- Replace eslint+prettier by biomejs to optimize speed.
+
+## Notes
 
-### App Setup
-
-Wrap your application (e.g., in `layout.tsx` or `_app.tsx`) with the necessary providers and components:
-
-```tsx
-import {
-  SRLiveRegionProvider,
-  RouteAnnouncer,
-  SkipLink,
-} from '@contractspec/lib.accessibility';
-
-export default function RootLayout({ children }) {
-  return (
-    <html lang="en">
-      <body>
-        <SRLiveRegionProvider>
-          <SkipLink />
-          <RouteAnnouncer />
-          <main id="main-content">{children}</main>
-        </SRLiveRegionProvider>
-      </body>
-    </html>
-  );
-}
-```
-
-### Announcing Dynamic Changes
-
-```tsx
-import { useSRLiveRegion } from '@contractspec/lib.accessibility';
-
-export function TodoList() {
-  const { announce } = useSRLiveRegion();
-
-  const addTodo = () => {
-    // ... add logic
-    announce('Todo added successfully', 'polite');
-  };
-
-  return <button onClick={addTodo}>Add Todo</button>;
-}
-```
+- WCAG compliance standards must be preserved; changes affect all UI surfaces.
+- Do not weaken or remove existing validators without coordinating with design-system consumers.

package/dist/AccessibilityPanel.js

@@ -128,6 +128,7 @@ function a11yRootClassName() {
 }
 
 // src/AccessibilityPanel.tsx
+import { Button } from "@contractspec/lib.design-system";
 import {
   Dialog,
   DialogClose,
@@ -137,8 +138,6 @@ import {
   DialogTitle,
   DialogTrigger
 } from "@contractspec/lib.ui-kit-web/ui/dialog";
-import { Button } from "@contractspec/lib.design-system";
-import { Switch } from "@contractspec/lib.ui-kit-web/ui/switch";
 import { Label } from "@contractspec/lib.ui-kit-web/ui/label";
 import {
   Select,
@@ -147,6 +146,7 @@ import {
   SelectTrigger,
   SelectValue
 } from "@contractspec/lib.ui-kit-web/ui/select";
+import { Switch } from "@contractspec/lib.ui-kit-web/ui/switch";
 import { cn } from "@contractspec/lib.ui-kit-web/ui/utils";
 import { jsxDEV as jsxDEV2 } from "react/jsx-dev-runtime";
 "use client";
@@ -168,11 +168,11 @@ function AccessibilityPanel({ className }) {
             className: "fixed inset-0 z-50 bg-black/40"
           }, undefined, false, undefined, this),
           /* @__PURE__ */ jsxDEV2(DialogContent, {
-            className: cn("bg-background focus-visible:ring-ring max-w-md p-6 shadow-lg outline-hidden focus-visible:ring-2", className),
+            className: cn("max-w-md bg-background p-6 shadow-lg outline-hidden focus-visible:ring-2 focus-visible:ring-ring", className),
             "aria-describedby": "a11y-panel-desc",
             children: [
               /* @__PURE__ */ jsxDEV2(DialogTitle, {
-                className: "text-lg font-semibold",
+                className: "font-semibold text-lg",
                 children: "Accessibility settings"
               }, undefined, false, undefined, this),
               /* @__PURE__ */ jsxDEV2("p", {

package/dist/AccessibilityProvider.js

@@ -128,8 +128,8 @@ function a11yRootClassName() {
 }
 
 // src/next-route-announcer.tsx
-import * as React2 from "react";
 import { usePathname } from "next/navigation";
+import * as React2 from "react";
 import { jsxDEV as jsxDEV2 } from "react/jsx-dev-runtime";
 "use client";
 function NextRouteAnnouncer() {

package/dist/browser/AccessibilityPanel.js

@@ -127,6 +127,7 @@ function a11yRootClassName() {
 }
 
 // src/AccessibilityPanel.tsx
+import { Button } from "@contractspec/lib.design-system";
 import {
   Dialog,
   DialogClose,
@@ -136,8 +137,6 @@ import {
   DialogTitle,
   DialogTrigger
 } from "@contractspec/lib.ui-kit-web/ui/dialog";
-import { Button } from "@contractspec/lib.design-system";
-import { Switch } from "@contractspec/lib.ui-kit-web/ui/switch";
 import { Label } from "@contractspec/lib.ui-kit-web/ui/label";
 import {
   Select,
@@ -146,6 +145,7 @@ import {
   SelectTrigger,
   SelectValue
 } from "@contractspec/lib.ui-kit-web/ui/select";
+import { Switch } from "@contractspec/lib.ui-kit-web/ui/switch";
 import { cn } from "@contractspec/lib.ui-kit-web/ui/utils";
 import { jsxDEV as jsxDEV2 } from "react/jsx-dev-runtime";
 "use client";
@@ -167,11 +167,11 @@ function AccessibilityPanel({ className }) {
             className: "fixed inset-0 z-50 bg-black/40"
           }, undefined, false, undefined, this),
           /* @__PURE__ */ jsxDEV2(DialogContent, {
-            className: cn("bg-background focus-visible:ring-ring max-w-md p-6 shadow-lg outline-hidden focus-visible:ring-2", className),
+            className: cn("max-w-md bg-background p-6 shadow-lg outline-hidden focus-visible:ring-2 focus-visible:ring-ring", className),
             "aria-describedby": "a11y-panel-desc",
             children: [
               /* @__PURE__ */ jsxDEV2(DialogTitle, {
-                className: "text-lg font-semibold",
+                className: "font-semibold text-lg",
                 children: "Accessibility settings"
               }, undefined, false, undefined, this),
               /* @__PURE__ */ jsxDEV2("p", {

package/dist/browser/AccessibilityProvider.js

@@ -127,8 +127,8 @@ function a11yRootClassName() {
 }
 
 // src/next-route-announcer.tsx
-import * as React2 from "react";
 import { usePathname } from "next/navigation";
+import * as React2 from "react";
 import { jsxDEV as jsxDEV2 } from "react/jsx-dev-runtime";
 "use client";
 function NextRouteAnnouncer() {

package/dist/browser/next-route-announcer.js

@@ -1,6 +1,6 @@
 // src/next-route-announcer.tsx
-import * as React from "react";
 import { usePathname } from "next/navigation";
+import * as React from "react";
 import { jsxDEV } from "react/jsx-dev-runtime";
 "use client";
 function NextRouteAnnouncer() {

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-export { SkipLink } from '@contractspec/lib.ui-kit-web/ui/skip-link';
-export { VisuallyHidden } from '@contractspec/lib.ui-kit-web/ui/visually-hidden';
+export { FocusOnRouteChange } from '@contractspec/lib.ui-kit-web/ui/focus-on-route-change';
 export { SRLiveRegionProvider, useSRLiveRegion, } from '@contractspec/lib.ui-kit-web/ui/live-region';
 export { RouteAnnouncer } from '@contractspec/lib.ui-kit-web/ui/route-announcer';
-export { FocusOnRouteChange } from '@contractspec/lib.ui-kit-web/ui/focus-on-route-change';
+export { SkipLink } from '@contractspec/lib.ui-kit-web/ui/skip-link';
 export { useReducedMotion } from '@contractspec/lib.ui-kit-web/ui/use-reduced-motion';
-export { A11YPreferencesProvider, useA11YPreferences, type AccessibilityPreferences, } from './preferences';
+export { VisuallyHidden } from '@contractspec/lib.ui-kit-web/ui/visually-hidden';
+export { A11YPreferencesProvider, type AccessibilityPreferences, useA11YPreferences, } from './preferences';
 import './styles.css';
 export { AccessibilityPanel } from './AccessibilityPanel';
 export { AccessibilityProvider } from './AccessibilityProvider';

package/dist/next-route-announcer.js

@@ -1,7 +1,7 @@
 // @bun
 // src/next-route-announcer.tsx
-import * as React from "react";
 import { usePathname } from "next/navigation";
+import * as React from "react";
 import { jsxDEV } from "react/jsx-dev-runtime";
 "use client";
 function NextRouteAnnouncer() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contractspec/lib.accessibility",
-  "version": "3.7.5",
+  "version": "3.7.7",
   "description": "WCAG compliance utilities and validators",
   "keywords": [
     "contractspec",
@@ -19,25 +19,25 @@
     "dev": "contractspec-bun-build dev",
     "clean": "rimraf dist .turbo",
     "lint": "bun lint:fix",
-    "lint:fix": "eslint src --fix",
-    "lint:check": "eslint src",
+    "lint:fix": "biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .",
+    "lint:check": "biome check .",
     "prebuild": "contractspec-bun-build prebuild",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@contractspec/lib.design-system": "3.7.5",
-    "@contractspec/lib.ui-kit": "3.7.5",
-    "@contractspec/lib.ui-kit-web": "3.7.5"
+    "@contractspec/lib.design-system": "3.8.0",
+    "@contractspec/lib.ui-kit": "3.8.0",
+    "@contractspec/lib.ui-kit-web": "3.8.0"
   },
   "devDependencies": {
-    "@contractspec/tool.typescript": "3.7.5",
+    "@contractspec/tool.typescript": "3.7.6",
     "react-native-css": "^3.0.4",
     "typescript": "^5.9.3",
-    "@contractspec/tool.bun": "3.7.5"
+    "@contractspec/tool.bun": "3.7.6"
   },
   "peerDependencies": {
     "react": "19.2.0",
-    "next": "16.1.6"
+    "next": "16.2.0"
   },
   "type": "module",
   "types": "./dist/index.d.ts",