S

Documentation Status

Checklist of all @saastro/forms features and their documentation status.

Documentation Status

Checklist of all @saastro/forms features, components, and concepts. Use this page to track what’s documented, what needs updating, and what’s missing.

Last full review: 2026-02-25


Summary

CategoryDocumentedNeeds UpdateMissingTotal
Getting Started2002
Guides120012
Field Types210021
Hooks110011
Reference2002
Total480048

Getting Started

#PageStatusLast UpdatedNotes
1IntroductionDocumented2026-02-19Overview, zero-config, builder pattern, features
2InstallationDocumented2026-02-19npm install, peer deps, component setup, next steps

Guides

FormBuilder API — Updated (2026-02-25)

Page: /docs/formbuilder

Covers: FormBuilder.create(), layout methods, addField(), addFields(), addStep(), initialStep(), callbacks (onSuccess, onError, onStepChange), messages, buttons, submit actions, submitAction() signature, submitExecution(), redirect, submitConfirmation(), plugins (.usePlugins(), .useDatabowl()), build validation, complete FieldBuilder reference (~30 methods grouped by category), FormBuilder methods summary, build() vs buildUnsafe() comparison with examples.

Validation — Documented (2026-02-19)

Page: /docs/validation

Covers: Zod schemas (direct), ValidationRules (serializable JSON), full property reference table (required, string, number, array, boolean, date rules), declarative FieldBuilder methods (.required(), .email(), .minLength(), etc.), 19 built-in presets table, custom presets (registerPreset(), getAvailablePresets()), custom validators via plugins, field type to Zod base type mapping table, compilation process, API reference (compileValidationRules, isZodSchema, isValidationRules, resolvePreset).

Multi-Step Forms — Documented (2026-02-19)

Page: /docs/multi-step

Covers: basic multi-step, defaultNext, initialStep(), step navigation (next/prev), step history stack, conditional routing with next conditions, 12 condition operators table, AND/OR grouping, step UI components (StepsNavigation, StepsProgress, StepsAccordion), useFormStepsInfo hook return value, StepInfo properties, per-step validation, complete multi-step onboarding example with conditional routing.

Layout System — Documented (2026-02-19)

Page: /docs/layout

Covers: manual mode (12-column grid, col-span-*, responsive breakpoints), auto mode (minFieldWidth, max columns), gap configuration, when to use each mode, API reference for FormBuilder and FieldBuilder layout methods.

Submit & Actions — Documented (2026-02-19)

Page: /docs/submit

Covers: callbacks (onSuccess/onError), submitActions system, HTTP/webhook/email/custom actions, triggers, conditions, execution modes, field mapping (simple rename, advanced transforms, resolvers, built-in transforms), API reference.

Plugins — Documented (2026-02-19)

Page: /docs/plugins

Covers: PluginManager usage, 6 lifecycle hooks table, transformConfig/transformValues pipelines (now supports async), custom field types via registerFields(), custom validators, all 5 built-in plugins (localStorage, analytics, autosave, databowl, recaptcha), creating custom plugins with definePlugin(), API reference (PluginManager methods, FormPlugin interface, ValidationContext, globalPluginManager).

Styling — Documented (2026-02-19)

Page: /docs/styling

Covers: classNames() method (wrapper, input, label, error, helper), JSON config equivalent, field order, field size, options layout for groups, hiding labels, conditional visibility by breakpoint, complete example, CSS variables, Tailwind integration, dark mode.

Grid layout content (columns, gap, breakpoints) moved to Layout System to eliminate duplication.

Buttons — Documented (2026-02-19)

Page: /docs/buttons

Covers: FormButtons, submit/next/back config, ButtonConfig props (variant, size, label, icon, effects), alignment, inline buttons, multi-step example, custom actions, API reference.

Conditional Logic — Documented (2026-02-19)

Page: /docs/conditional-logic

Covers: hidden/disabled/readOnly state properties, boolean/function/ConditionGroup modes, 12 condition operators table, AND/OR grouping, responsive breakpoint visibility (hidden/visible per breakpoint), function vs declarative comparison, complete registration form example.

Component System — Documented (2026-02-19)

Page: /docs/components

Covers: three injection modes (zero-config, glob auto-discovery, legacy provider), FormComponentsProvider with import.meta.glob, ComponentProvider + createComponentRegistry(), resolution order, full ComponentRegistry (49 slots by category), missing component handling (MissingComponentFallback), hooks (useComponents, usePartialComponents, useHasComponentProvider, useComponentMode), utility functions (mergeComponentRegistries, parseGlobModules, ComponentResolver).

command field — Documented (2026-02-19)

Page: /docs/command

Covers: cmdk-based searchable dropdown, props (options, placeholder, searchPlaceholder, emptyText), command vs combobox comparison, required components, icon support, TypeScript interface.

Utilities — Updated (2026-02-25)

Page: /docs/utilities

Covers: component utilities (getRequiredComponents, getMissingComponents, getInstallCommand, groupMissingByPackage, fieldTypeComponents, coreComponents), Tailwind utilities (getFormGridClass, getFieldClass, getHiddenClasses, pxToRem), test data generation (generateTestData, generateFieldValue, detectLocale — locale-aware, seeded, heuristic-based), field transforms (applyFieldTransforms — per-field transform execution).

Hidden Fields — Documented (2026-02-25)

Page: /docs/hidden-fields

Covers: hidden field concept, 7 built-in resolvers (timestamp, hostname, pageUrl, referrer, userAgent, ip, urlParam), resolver execution flow, useHiddenFieldResolvers hook, resolvers vs field mapping inject comparison, JSON configuration, custom resolvers, TypeScript types (FieldResolver, SerializableFieldResolver, HiddenFieldProps), API reference (resolveValue, resolveValueSync, BUILTIN_RESOLVERS).


Field Types

Text Fields

#FieldStatusPageLast Updated
1textDocumented/docs/text2026-02-19
2emailDocumented/docs/text2026-02-19
3telDocumented/docs/text2026-02-19
4textareaDocumented/docs/textarea2026-02-19
5input-groupDocumented/docs/input-group2026-02-19

Selection Fields

#FieldStatusPageLast Updated
6selectDocumented/docs/select2026-02-19
7comboboxDocumented/docs/combobox2026-02-19
8native-selectDocumented/docs/native-select2026-02-19
9radioDocumented/docs/radio2026-02-19
10button-radioDocumented/docs/button-radio2026-02-19
11commandDocumented/docs/command2026-02-19

Toggle Fields

#FieldStatusPageLast Updated
12checkboxDocumented/docs/checkbox2026-02-19
13switchDocumented/docs/switch2026-02-19
14checkbox-groupDocumented/docs/checkbox-group2026-02-19
15switch-groupDocumented/docs/switch-group2026-02-19
16button-checkboxDocumented/docs/button-checkbox2026-02-19
17button-cardDocumented/docs/button-card2026-02-19

Date Fields

#FieldStatusPageLast Updated
18dateDocumented/docs/date2026-02-19
19daterangeDocumented/docs/daterange2026-02-19

Special Fields

#FieldStatusPageLast Updated
20sliderDocumented/docs/slider2026-02-19
21otpDocumented/docs/otp2026-02-19
22htmlDocumented/docs/html2026-02-19
23hiddenDocumented/docs/hidden2026-02-25

Hooks

All hooks have dedicated documentation pages with signature, parameters, return value, internal logic, and examples.

#HookStatusPageLast Updated
1useFormStateDocumented/docs/use-form-state2026-02-19
2useFormSubmitDocumented/docs/use-form-submit2026-02-19
3useFormStepsDocumented/docs/use-form-steps2026-02-19
4useFormStepsInfoDocumented/docs/use-form-steps-info2026-02-19
5useFormValidationDocumented/docs/use-form-validation2026-02-19
6useFormLayoutDocumented/docs/use-form-layout2026-02-19
7useFormButtonsDocumented/docs/use-form-buttons2026-02-19
8useSubmitActionTriggersDocumented/docs/use-submit-action-triggers2026-02-19
9useSubmitConfirmationDocumented/docs/use-submit-confirmation2026-02-19
10useRecaptchaDeprecated/docs/use-recaptcha2026-02-19
11useHiddenFieldResolversDocumented/docs/use-hidden-field-resolvers2026-02-25

Builders (Fluent API)

#BuilderStatusPage
1FormBuilderDocumented/docs/formbuilder
2FieldBuilderDocumented/docs/formbuilder (reference section)

Reference Pages

#PageStatusLast UpdatedNotes
1Types ReferenceDocumented2026-02-19All 9 type files: common, fields, buttons, steps, submitActions, logic, plugin, components, validation
2UtilitiesDocumented2026-02-25Component utilities + Tailwind + test data generation + field transforms

Types Coverage

All types are exported from @saastro/forms. Every type file now has dedicated documentation.

#Type FileKey ExportsStatus
1types/common.tsFormConfig, FormLayout, SubmitConfirmationConfig, BreakpointTypes Reference + Guides
2types/fields.tsFieldConfig (discriminated union of 21+ types)Types Reference
3types/buttons.tsButtonConfig, FormButtonsTypes Reference + Buttons
4types/steps.tsStep, StepConditionTypes Reference + Multi-Step
5types/submitActions.tsSubmitActionNode, FieldMapping, BuiltinTransformTypes Reference + Submit
6types/logic.tsConditionOperator, Condition, ConditionGroupTypes Reference + Conditional Logic
7types/plugin.tsFormPlugin, definePlugin, ValidationContextTypes Reference + Plugins
8types/components.tsComponentRegistry (49 slots)Types Reference + Component System
9types/validation.tsValidationRules, SchemaTypeTypes Reference + Validation

Changelog

DateChanges
2026-02-25Full audit. Added useHiddenFieldResolvers hook page. Added generateTestData/generateFieldValue/detectLocale + applyFieldTransforms to Utilities. Added build() vs buildUnsafe() to FormBuilder. 48 items total, 0 gaps.
2026-02-25Added hidden field type demo page + Hidden Fields conceptual guide. Covers 7 built-in resolvers, useHiddenFieldResolvers, resolveValue/resolveValueSync, BUILTIN_RESOLVERS.
2026-02-19Documentation complete. Created Conditional Logic, Component System, command field, Utilities, and Types Reference pages. All 45 items documented, 0 missing.
2026-02-19Created recaptchaPlugin (factory). Deprecated useRecaptcha hook. Made transformValues async-compatible. Added recaptcha to Plugins guide.
2026-02-19Created 10 individual hook reference pages. Added “Hooks” sidebar section. Updated summary: 38 documented, 4 missing.
2026-02-19Added Field Mapping section to Submit & Actions (BuiltinTransform, FieldResolver, applyFieldMapping). Created this status page.
2026-02-19Created FormBuilder API, Validation, Multi-Step Forms, and Plugins guide pages. Reorganized sidebar: replaced “Core Concepts” with “Guides” section. Deduplicated Styling/Layout overlap. Fixed Installation dead links.
2026-02-19Initial status audit: 25 items documented, 28 missing.