diff --git a/.docs/README.md b/.docs/README.md deleted file mode 100644 index 4744313..0000000 --- a/.docs/README.md +++ /dev/null @@ -1,58 +0,0 @@ -# Contributte\Form-multiplier - -## Content - -- [Usage - how use it](#usage) - - [Register extension](#register-extension) - - [Basic usage](#basic-usage) - - [Adding multiple containers](#adding-multiple-containers) - - [Macros](#macros) - -## Usage - -### Register extension - -```neon -extensions: - - Contributte\FormMultiplier\DI\MultiplierExtension -``` - -### Basic usage - -```php -$form = new Nette\Forms\Form; -$copies = 1; -$maxCopies = 10; - -$multiplier = $form->addMultiplier('multiplier', function (Nette\Forms\Container $container, Nette\Forms\Form $form) { - $container->addText('text', 'Text') - ->setDefaultValue('My value'); -}, $copies, $maxCopies); - -$multiplier->addCreateButton('Add') - ->addClass('btn btn-primary'); -$multiplier->addRemoveButton('Remove') - ->addClass('btn btn-danger'); -``` - -### Adding multiple containers - -```php -$multiplier->addCreateButton('Add'); // add one container -$multiplier->addCreateButton('Add 5', 5); // add five containers -``` - -### Macros - -```latte -{form multiplier} -
- - {multiplier:remove class: myClass} -
- - {multiplier:add multiplier class: myClass} - {multiplier:add multiplier:5} -{/form} -``` - diff --git a/README.md b/README.md index b9ec99d..5aa44e9 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,33 @@ ![](https://heatbadger.now.sh/github/readme/contributte/forms-multiplier/)

- - - - + + + +

- - - - - + + + + +

- Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte + Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

-## Usage +Multiplier containers for Nette Forms, including create/remove buttons and Latte macros. + +## Versions + +| State | Version | Branch | PHP | +|--------|---------|----------|---------| +| dev | `^4.1` | `master` | `>=8.1` | +| stable | `^4.0` | `v4` | `>=8.0` | + +## Installation To install latest version of `contributte/forms-multiplier` use [Composer](https://getcomposer.org). @@ -26,28 +35,64 @@ To install latest version of `contributte/forms-multiplier` use [Composer](https composer require contributte/forms-multiplier ``` -## Documentation +## Usage + +### Register Extension -For details on how to use this package, check out our [documentation](.docs). +```neon +extensions: + - Contributte\FormMultiplier\DI\MultiplierExtension +``` +### Basic Usage -## Versions +```php +$form = new Nette\Forms\Form; +$copies = 1; +$maxCopies = 10; -| State | Version | Branch | PHP | -|-------------|---------|----------|---------| -| dev | `^4.1` | `master` | `>=8.1` | -| stable | `^4.0` | `v4` | `>=8.0` | +$multiplier = $form->addMultiplier('multiplier', function (Nette\Forms\Container $container, Nette\Forms\Form $form) { + $container->addText('text', 'Text') + ->setDefaultValue('My value'); +}, $copies, $maxCopies); + +$multiplier->addCreateButton('Add') + ->addClass('btn btn-primary'); +$multiplier->addRemoveButton('Remove') + ->addClass('btn btn-danger'); +``` + +### Adding Multiple Containers + +```php +$multiplier->addCreateButton('Add'); // add one container +$multiplier->addCreateButton('Add 5', 5); // add five containers +``` + +### Macros + +```latte +{form multiplier} +
+ + {multiplier:remove class: myClass} +
+ + {multiplier:add multiplier class: myClass} + {multiplier:add multiplier:5} +{/form} +``` ## Development See [how to contribute](https://contributte.org) to this package. This package is currently maintained by these authors. - + - + -----