Skip to content

docs: align README and roadmap with shipped functionality #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HecFranco merged 1 commit into from
Aug 17, 2026
Merged

docs: align README and roadmap with shipped functionality #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ This bundle is **FrankenPHP worker mode friendly**.
- **FQCN helpers:** `addAutocompleteField()` for Symfony UX Autocomplete types, `addCKEditorField()` when **friendsofsymfony/ckeditor-bundle** is installed; `addDropzone()` / `addCropper()` when the UX packages are installed.
- **Model transformers:** `addSwitchType()`, `addJsonType()`, `addBoolType()`, `addMoneyType()`, `addCsvType()` (same helpers on **FormKitControllerTrait** with `*Type` suffix).
- **Optional types:** FormTypeMap includes core Symfony types (including `search`) plus optional UX (Dropzone, Cropper) and A2lix when installed. Extend via `type_map`.
- **Multi-step wizard:** `MultiStepFormBuilder` for stepped forms (see the Symfony 8 demo).
- **Constraint message convention:** `constraint_message_convention` plus `#[FormKitConfig]` / static field types (`StaticAlertType`, …).
- **CSRF-only / GET filters:** `CsrfOnlyFormFactory`, `AbstractGetFilterType`, `GetFilterFormFactory`, `SearchQueryType`. See [docs/CSRF.md](docs/CSRF.md).
- **Form type extensions:** **InputGroupExtension**, **RequiredLabelSuffixExtension**, **HelpModalExtension**. See [Configuration](docs/CONFIGURATION.md) and [Usage](docs/USAGE.md#help-modal-optional).

Expand Down
3 changes: 3 additions & 0 deletions docs/ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@ This document outlines the planned direction for Form Kit Bundle. Items are grou

## Current state (v2.x)

Current tag **v2.4.1**.

- **Options** strategy (`FormOptionsTrait` + FQCN): primary path; `profiles` / `default_profile`; `by_form`; `constraint_message_convention`; `#[FormKitConfig]`; **bound-builder** / **array-build**.
- **Kit** strategy (`FormKitTrait` / `FormKitAbstractType` + `FormTypeMap`): snake_case types; same merge model.
- **Controller** strategy (`FormKitControllerTrait`) and **Wrapped** strategy (`AbstractFormKitWrappedType`).
- Choice presets, model transformers, help modal, optional UX helpers (Autocomplete, CKEditor, Dropzone, Cropper).
- **Wizard / CSRF-only / GET filters:** `MultiStepFormBuilder`, `CsrfOnlyFormFactory`, `GetFilterFormFactory`, `SearchQueryType`, static field types.
- **Demos**: **demo/symfony8** — see [USAGE — strategies](USAGE.md#usage-strategies) for the naming used in docs.
- **Flex recipe** stub: [RECIPE.md](RECIPE.md).

Expand Down
Loading