@servicetitan/anvil2-ext-common 0.3.19 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @servicetitan/anvil2-ext-common
 
+## 0.4.0
+
+### Minor Changes
+
+- [#2393](https://github.com/servicetitan/hammer/pull/2393) [`fa64efa`](https://github.com/servicetitan/hammer/commit/fa64efa889ee2571504fe5ade2dbffc702132c80) Thanks [@pbuckingham-st](https://github.com/pbuckingham-st)! - [Form] Add formstate field-state wrappers (`A2InputFieldState`, `SelectableOptionsFieldState`) and a `Form.*` namespace of `observer` binding components for Anvil2 input fields (TextField, Textarea, NumberField, DateFieldSingle/Range/Yearless/YearlessRange, TimeField, beta Select/MultiSelect/TreeSelect, and RadioGroup/CheckboxGroup). Checkbox/radio are provided as the group wrappers only.
+
+### Patch Changes
+
+- Updated dependencies [[`5e46d4f`](https://github.com/servicetitan/hammer/commit/5e46d4f7760c8f4c3374523f9777f34b61f72270), [`f13b003`](https://github.com/servicetitan/hammer/commit/f13b0036669dc8ba3e566de88374b4487bb9891b), [`f8e27ae`](https://github.com/servicetitan/hammer/commit/f8e27ae598b1a2c4900cd2dc16e6efcb3a11fbb9)]:
+  - @servicetitan/anvil2@3.1.0
+
+## 0.3.20
+
+### Patch Changes
+
+- Updated dependencies [[`168c5ce`](https://github.com/servicetitan/hammer/commit/168c5ced0505d26de116340a7a799563bacc8be9), [`48c651d`](https://github.com/servicetitan/hammer/commit/48c651d42661d7e760a70ec651d2c12790239302), [`48c651d`](https://github.com/servicetitan/hammer/commit/48c651d42661d7e760a70ec651d2c12790239302), [`bd7c4c5`](https://github.com/servicetitan/hammer/commit/bd7c4c5e7f6e1715c80b1fbc7b894e7a8ea8bead), [`7401759`](https://github.com/servicetitan/hammer/commit/74017590bbe5ef4e62771816c2e3701e16800bbb), [`a0223e7`](https://github.com/servicetitan/hammer/commit/a0223e78626edcdeaf9587131ccabe152f109484), [`ba729d3`](https://github.com/servicetitan/hammer/commit/ba729d32d866bf535246917e00698ded0f31356e), [`16ac423`](https://github.com/servicetitan/hammer/commit/16ac4232438c06e2462bbb4be4bf681441d4a9fb)]:
+  - @servicetitan/anvil2@3.0.9
+
 ## 0.3.19
 
 ### Patch Changes

package/README.md

@@ -25,6 +25,33 @@ Components and hooks can be imported as named exports from the package root:
 import { useConfirmDialog } from "@servicetitan/anvil2-ext-common";
 ```
 
+### Form field-state wrappers (`Form.*`)
+
+`Form.*` components bind Anvil2 fields to a `formstate`-based `A2InputFieldState`, eliminating boilerplate for value, onChange, error, and warning wiring.
+
+**Quick example:**
+
+```tsx
+import { A2InputFieldState } from "@servicetitan/anvil2-ext-common";
+import { Form } from "@servicetitan/anvil2-ext-common";
+
+const name = new A2InputFieldState("");
+
+<Form.TextField fieldState={name} label="Name" />;
+```
+
+Available wrappers: `Form.TextField`, `Form.Textarea`, `Form.NumberField`, `Form.DateFieldSingle`, `Form.DateFieldRange`, `Form.DateFieldYearless`, `Form.DateFieldYearlessRange`, `Form.TimeField`, `Form.Select`, `Form.MultiSelect`, `Form.TreeSelect`, `Form.RadioGroup`, `Form.CheckboxGroup`.
+
+Checkbox and radio inputs are provided as the **group** wrappers (`Form.RadioGroup`, `Form.CheckboxGroup`) only. A standalone Anvil2 `Checkbox`/`Radio` exposes a boolean error (styling) with no message area, so it can't surface validation errors/warnings — the group is the form pattern that renders a `FieldMessage`.
+
+`Form.Select`, `Form.MultiSelect`, and `Form.TreeSelect` wrap the beta Anvil2 components and are exported from the package root alongside the rest of the `Form.*` namespace. `Form.Select` and `Form.MultiSelect` support all loader modes (eager, page-lazy, offset-lazy, group-lazy) — pass a `loadOptions` function appropriate to your loader strategy.
+
+**Known limitations:**
+
+- Single checkbox/radio inputs have no standalone wrapper — use `Form.CheckboxGroup` / `Form.RadioGroup` (the Anvil2 group is the component that renders validation messages).
+- `updateMode` is primarily meaningful for value-update controls (TextField, Textarea, NumberField).
+- The following Anvil2 input types have no `Form.*` wrapper: SearchField, InputMask, Switch, ButtonToggle, SelectCard, Combobox, SegmentedControl, RichTextEditor.
+
 <br />
 
 # Contribution Guide