Skip to content

README.md

Latest commit

 

History

History
79 lines (57 loc) · 4.42 KB

README.md

File metadata and controls

79 lines (57 loc) · 4.42 KB

ChampionForms Documentation

Welcome to the ChampionForms documentation! This directory contains comprehensive guides and references for building forms with ChampionForms.

Table of Contents

Getting Started

  • Main README - Quick start, installation, and basic usage
  • CHANGELOG - Version history and release notes

Feature Guides

Custom Fields (v0.6.0+)

Migration Guides

API Reference

  • Form Controller - State management and controller methods (Coming Soon)
  • Field Types - Built-in field types and their properties (Coming Soon)
  • Validation - Validation system and built-in validators (Coming Soon)

Theming

Quick Links

For New Users

  1. Start with the Main README for installation and basic usage
  2. Learn about Compound Fields for reusable field groups (NameField, AddressField)
  3. Review Field Types to understand available widgets (Coming Soon)
  4. Explore Custom Field Cookbook for advanced use cases

For v0.5.x Users Upgrading to v0.6.0

  1. Read First: Migration Guide: v0.5.x → v0.6.0
  2. Review Custom Field Cookbook for updated examples
  3. Reference FieldBuilderContext API for new API

For Compound Field Users

  1. Compound Fields Guide - Complete guide to using and creating compound fields
  2. Try the interactive demo in the example app
  3. Review built-in examples: NameField and AddressField

For Custom Field Developers

  1. Custom Field Cookbook - Start here with practical examples
  2. StatefulFieldWidget Guide - Learn the base class pattern
  3. FieldBuilderContext API Reference - Deep dive into the context API
  4. Converters Guide - Type conversion patterns

What's New in v0.6.0

ChampionForms v0.6.0 introduces Compound Fields and dramatically simplifies custom field creation by reducing boilerplate from 120-150 lines to 30-50 lines (60-70% reduction).

New Features

  • Compound Fields: Reusable composite fields (NameField, AddressField) with automatic ID prefixing and controller transparency
  • FieldBuilderContext: Bundles 6 parameters into one clean context object
  • StatefulFieldWidget: Abstract base class with automatic lifecycle management
  • Converter Mixins: Reusable type conversion logic
  • Simplified FormFieldRegistry: Static registration methods

Breaking Changes

⚠️ This is a breaking change release for custom field implementations. Built-in fields (TextField, OptionSelect, etc.) continue to work without changes, but if you've created custom fields, you'll need to migrate them.

See the v0.6.0 Migration Guide for details.

Contributing

Contributions are welcome! If you find errors in the documentation or have suggestions for improvements, please open an issue or pull request on GitHub.

License

ChampionForms is released under the MIT License. See LICENSE for details.