API Reference

Welcome to the Graneet Form API documentation. This section provides comprehensive reference for all components, hooks, and types.

Form Hooks

useForm

Main hook for creating and managing form instances

useFormStatus

Hook for monitoring form validation status

useFieldsWatch

Hook for watching form field values with granular subscriptions

useValidations

Hook for watching form field validation states

useFormContext

Hook for accessing form context within components

Wizard Hooks

useWizard

Main hook for creating multi-step wizard workflows

useStepForm

Hook for integrating forms within wizard steps

useStepStatus

Hook for monitoring current wizard step status

useWizardContext

Hook for accessing wizard context within components

Components & Types

Components

Form, Field, Rule, and Step components

Types & Interfaces

TypeScript definitions and type reference

Key Concepts

The Graneet Form API is built around these core concepts:

Form Instance: Created by useForm, manages all form state
Field Registration: Fields register themselves and subscribe to changes
Granular Subscriptions: Only affected components re-render
Validation System: Built-in validation with custom rules
Wizard Support: Native multi-step form functionality

Getting Started

If you're new to Graneet Form, start with our Quick Start Guide to learn the basics, then dive into the specific API documentation you need.

For a comparison with other form libraries, see our Comparison Guide.

API Overview