Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
webda2l authored Jul 2, 2024
1 parent 1d60f84 commit 9f7ba8f
Showing 1 changed file with 70 additions and 2 deletions.
72 changes: 70 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,77 @@ Automate form building.
| --- | --- |
| master | [![Build Status][ci_badge]][ci_link] [![Coverage Status][coverage_badge]][coverage_link] |

## Documentation
## Installation

Check out the documentation on the [official website](http://a2lix.fr/bundles/auto-form).
Use composer:

```bash
composer require a2lix/auto-form-bundle
```

After the successful installation, add/check the bundle registration:

```php
// bundles.php is automatically updated if flex is installed.
// ...
A2lix\AutoFormBundle\A2lixAutoFormBundle::class => ['all' => true],
// ...
```

## Configuration

There is no minimal configuration, so this part is optional. Full list:

```yaml
# Create a dedicated a2lix.yaml in config/packages with:

a2lix_auto_form:
excluded_fields: [id, locale, translatable] # [1]
```
1. Optional.
## Usage
### In a classic formType
```php
use A2lix\AutoFormBundle\Form\Type\AutoFormType;
...
$builder->add('medias', AutoFormType::class);
```

### Advanced examples

```php
use A2lix\AutoFormBundle\Form\Type\AutoFormType;
...
$builder->add('medias', AutoFormType::class, [
'fields' => [ // [2]
'description' => [ // [3.a]
'field_type' => 'textarea', // [4]
'label' => 'descript.', // [4]
'locale_options' => [ // [3.b]
'es' => ['label' => 'descripción'] // [4]
'fr' => ['display' => false] // [4]
]
]
],
'excluded_fields' => ['details'] // [2]
]);
```

2. Optional. If set, override the default value from config.yml
3. Optional. If set, override the auto configuration of fields
- [3.a] Optional. - For a field, applied to all locales
- [3.b] Optional. - For a specific locale of a field
4. Optional. Common options of symfony forms (max_length, required, trim, read_only, constraints, ...), which was added 'field_type' and 'display'

## Additional

### Example

See [Demo Bundle](https://github.com/a2lix/Demo) for more examples.

## Contribution help

Expand Down

0 comments on commit 9f7ba8f

Please sign in to comment.