@page-speed/forms 0.8.0 → 0.8.2

package/README.md

@@ -1,12 +1,16 @@
-# ⌨️ `@page-speed/forms`
+# @page-speed/forms
+
+## Type-safe, high-performance React form state and input components. Utilized by the [OpenSite Semantic UI](https://opensite.ai) website platform
 
 ![Page Speed React Forms](https://octane.cdn.ing/api/v1/images/transform?url=https://cdn.ing/assets/i/r/286339/nwqgw37pigfluhcmmjmpql3yj9y4/github.png&f=webp&q=90)
 
-> Type-safe, high-performance React form state and input components for OpenSite/DashTrack workloads.
+<br />
 
-[![npm version](https://img.shields.io/npm/v/@page-speed/forms?style=flat-square)](https://www.npmjs.com/package/@page-speed/forms)
-[![npm downloads](https://img.shields.io/npm/dm/@page-speed/forms?style=flat-square)](https://www.npmjs.com/package/@page-speed/forms)
-[![License](https://img.shields.io/npm/l/@page-speed/forms?style=flat-square)](./LICENSE)
+[![npm version](https://img.shields.io/npm/v/@page-speed/forms?style=for-the-badge)](https://www.npmjs.com/package/@page-speed/forms)
+[![npm downloads](https://img.shields.io/npm/dm/@page-speed/forms?style=for-the-badge)](https://www.npmjs.com/package/@page-speed/forms)
+[![License](https://img.shields.io/npm/l/@page-speed/forms?style=for-the-badge)](./LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=for-the-badge)](./tsconfig.json)
+[![Tree-Shakeable](https://img.shields.io/badge/Tree%20Shakeable-Yes-brightgreen?style=for-the-badge)](#tree-shaking)
 
 ## Highlights
 
@@ -26,7 +30,8 @@ pnpm add @page-speed/forms
 npm install @page-speed/forms
 ```
 
-Peer dependencies:
+### Peer dependencies:
+
 - `react >= 16.8.0`
 - `react-dom >= 16.8.0`
 
@@ -43,7 +48,7 @@ import {
 
 const fields: FormFieldConfig[] = [
   {
-    name: "fullName",
+    name: "full_name",
     type: "text",
     label: "Full Name",
     required: true,
@@ -65,7 +70,7 @@ const fields: FormFieldConfig[] = [
     columnSpan: 6,
   },
   {
-    name: "message",
+    name: "content",
     type: "textarea",
     label: "Message",
     required: true,
@@ -205,40 +210,49 @@ function ContactBlock({ formEngineSetup }: { formEngineSetup?: FormEngineSetup }
 ## Package Entry Points
 
 ### Main
+
 - `@page-speed/forms`
 
-Exports:
+#### Exports:
+
 - `useForm`, `useField`, `Form`, `Field`, `FormContext`
 - Core form/types interfaces
 
 ### Integration (Recommended)
+
 - `@page-speed/forms/integration`
 
-Exports:
+#### Exports:
+
 - `FormEngine`, `FormEngineSetup`, `FormEngineProps`
 - `FormFieldConfig`, `FormEngineStyleRules`, `FormEngineLayoutSettings`
 - `DynamicFormField`, `useContactForm`, `useFileUpload`
 
 ### Inputs
+
 - `@page-speed/forms/inputs`
 
-Exports:
+#### Exports:
+
 - `TextInput`, `TextArea`, `Checkbox`, `CheckboxGroup`, `Radio`
 - `Select`, `MultiSelect`, `DatePicker`, `DateRangePicker`, `TimePicker`
 - `FileInput`
 
 ### Validation
+
 - `@page-speed/forms/validation`
 - `@page-speed/forms/validation/rules`
 - `@page-speed/forms/validation/utils`
 - `@page-speed/forms/validation/valibot`
 
 ### Upload
+
 - `@page-speed/forms/upload`
 
 ## Input Notes
 
 ### `TimePicker`
+
 `TimePicker` uses a native `input[type="time"]` UX internally.
 
 - Accepts controlled values in `HH:mm` (24-hour) or `h:mm AM/PM` (12-hour)
@@ -246,11 +260,13 @@ Exports:
 - Emits `h:mm AM/PM` when `use24Hour` is `false`
 
 ### `DatePicker` and `DateRangePicker`
+
 - Calendar popovers close on outside click
 - Compact month/day layout using tokenized Tailwind classes
 - `DateRangePicker` renders two months and highlights endpoints + in-range dates
 
 ### `Select` and `MultiSelect`
+
 - Close on outside click
 - Search support
 - Option groups
@@ -289,6 +305,7 @@ See `INPUT_AUTOFILL_RESET_CLASSES` in `src/utils.ts`.
 ### Token requirements
 
 Ensure your app defines semantic tokens used in classes such as:
+
 - `background`, `foreground`, `border`, `input`, `ring`
 - `primary`, `primary-foreground`
 - `muted`, `muted-foreground`
@@ -336,6 +353,7 @@ function CustomForm() {
 ## Validation Utilities
 
 Use built-in rules:
+
 - `required`, `email`, `url`, `phone`
 - `minLength`, `maxLength`, `min`, `max`
 - `pattern`, `matches`, `oneOf`
@@ -343,6 +361,7 @@ Use built-in rules:
 - `compose`
 
 Use utilities from `/validation/utils`:
+
 - `debounce`, `asyncValidator`, `crossFieldValidator`, `when`
 - `setErrorMessages`, `getErrorMessage`, `resetErrorMessages`
 
@@ -351,6 +370,7 @@ Use utilities from `/validation/utils`:
 `FileInput` and `FormEngine` support validation, drag/drop, preview, and crop workflows.
 
 For full two-phase upload patterns and serializer usage, see:
+
 - [`docs/FILE_UPLOADS.md`](./docs/FILE_UPLOADS.md)
 - `@page-speed/forms/integration`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@page-speed/forms",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Ultra-high-performance React form library with field-level reactivity and tree-shakable architecture",
   "keywords": [
     "react",
@@ -22,7 +22,7 @@
     "url": "https://github.com/opensite-ai/page-speed-forms/issues"
   },
   "author": "OpenSite AI (https://opensite.ai)",
-  "license": "MIT",
+  "license": "BSD-3-Clause",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",