# Regle

> Headless form validation for Vue.js

Type safe, model-based and intuitive API.
The perfect evolution of Vuelidate.

## Table of Contents

### Getting Started

- [Introduction](/introduction.md)
- [Installation](/introduction/installation.md)
- [Devtools](/introduction/devtools.md): Debug your validation tree with Regle devtools
- [Comparison with other form libraries](/introduction/comparisons.md)
- [Migrate from Vuelidate](/introduction/migrate-from-vuelidate.md): Migrate to Regle with ease

### Core concepts

- [useRegle](/core-concepts.md)
- [Validation properties](/core-concepts/validation-properties.md): Validation properties are computed values or methods available for every nested rule status
- [Displaying errors](/core-concepts/displaying-errors.md)
- [Modifiers](/core-concepts/modifiers.md): Modifiers allow you to control the behavior and settings of validation rules in your application

#### Rules

- [Rules](/core-concepts/rules.md): Rules are the building blocks of validation in Regle. Learn how to create reusable and inline rules.
- [Reusable rules](/core-concepts/rules/reusable-rules.md): Create reusable, type-safe validation rules with createRule — supporting parameters, reactivity, async logic, and metadata.
- [Built-in rules](/core-concepts/rules/built-in-rules.md): Reference for all built-in validation rules available in the @regle/rules package.
- [Rule properties](/core-concepts/rules/rules-properties.md): Rule properties are computed values or methods available in every nested rule status
- [Rule wrappers](/core-concepts/rules/rule-wrappers.md): Rule wrappers let you customize or upgrade your rules by injecting or replacing some properties.
- [Rules operators](/core-concepts/rules/rules-operators.md): Regle provides tools to combine and operate on different rules
- [Validations helpers](/core-concepts/rules/validations-helpers.md): Utility functions for writing custom rules — type guards, size helpers, and value coercion.

### Integrations

- [Nuxt](/integrations/nuxt.md): Enhance the Regle experience with the Nuxt module
- [Schemas libraries](/integrations/schemas-libraries.md)
- [Regle MCP server](/integrations/mcp-server.md): Integrate Regle MCP with your favorite AI assistant
- [Agent Skills](/integrations/agent-skills.md): Install Regle Agent Skills for your AI coding agent

### Common Usages

- [Working with arrays - Declaring rules](/common-usage/collections.md): API usage of $each
- [Usage with Pinia](/common-usage/usage-with-pinia.md): Since Regle is headless, you can use it anywhere in your app
- [Async validations](/common-usage/async-validation.md)
- [Reset forms](/common-usage/reset-form.md): How to reset forms and fields
- [Standard Schema](/common-usage/standard-schema.md): Use Regle as a Standard Schema library
- [Server errors](/common-usage/external-errors.md): Handle server side errors with Regle

### Advanced Usage

- [Rules metadata](/advanced-usage/rule-metadata.md): Rule validator functions can return more than just a boolean
- [Global configuration](/advanced-usage/global-config.md)
- [Object self validation](/advanced-usage/self-validation.md): Validate objects directly using $self to apply rules at the object level
- [Variants](/advanced-usage/variants.md): Define variants rules for your discriminated unions
- [Scoped validation](/advanced-usage/scoped-validation.md): Scoped validation in Regle is made to port Vuelidate's nested component validation
- [Extend properties](/advanced-usage/extend-properties.md): Regle offers a way to extend the default validation properties with defineRegleConfig
- [Merge multiple Regles](/advanced-usage/merge-regles.md)
- [markStatic](/advanced-usage/immutable-constructors.md): Use markStatic to handle immutable constructors

### Typescript

- [Type safe output](/typescript/type-safe-output.md)
- [Typing props](/typescript/typing-props.md)
- [Typing rules](/typescript/typing-rules.md)

### Examples

- [Cheat Sheet](/cheat-sheet.md): Quick reference for common Regle patterns and usage scenarios

#### Complete

- [Simple demo](/examples/simple.md)
- [Advanced demo](/examples/advanced.md)

#### Specific

- [Custom Rules](/examples/custom-rules.md)
- [Conditional Rules](/examples/conditional-rules.md)
- [Collections](/examples/collections.md)
- [Server Validation](/examples/server-validation.md)
- [Required Indicators](/examples/required-indicators.md)

### Troubleshooting

- [Reactivity caveats](/troubleshooting/reactivity.md)

### Other

- [Examples](/examples.md)
- [Untitled](/parts/DisplayingErrors.md)
- [Untitled](/parts/QuickUsage.md)