Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/form
The package helps with implementing data entry forms
https://github.com/yiisoft/form
form forms hacktoberfest yii3
Last synced: 6 days ago
JSON representation
The package helps with implementing data entry forms
- Host: GitHub
- URL: https://github.com/yiisoft/form
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-04-10T21:30:20.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T08:20:30.000Z (3 months ago)
- Last Synced: 2024-10-29T09:41:20.671Z (3 months ago)
- Topics: form, forms, hacktoberfest, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 1.13 MB
- Stars: 45
- Watchers: 18
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Form
[](https://packagist.org/packages/yiisoft/form)
[](https://packagist.org/packages/yiisoft/form)
[](https://github.com/yiisoft/form/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/form)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/form/master)
[](https://github.com/yiisoft/form/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/form)
[](https://shepherd.dev/github/yiisoft/form)
The package provides a set of widgets to help with dynamic server-side generation of HTML forms.
The following widgets are available out of the box:
- input fields: `Checkbox`, `CheckboxList`, `Date`, `DateTimeLocal`, `Email`, `File`, `Hidden`, `Image`,
`Number`, `Password`, `RadioList`, `Range`, `Select`, `Telephone`, `Text`, `Textarea`, `Time`, `Url`;
- buttons: `Button`, `ResetButton`, `SubmitButton`;
- group widgets: `ButtonGroup`, `Fieldset`.
- other: `ErrorSummary`.
These themes are available out of the box:
- Bootstrap 5 Horizontal,
- Bootstrap 5 Vertical.
## Requirements
- PHP 8.1 or higher.
## Installation
The package could be installed with composer:
```shell
composer require yiisoft/form
```
## General usage
Configure themes (optional):
```php
use Yiisoft\Form\ThemeContainer;
use Yiisoft\Form\ThemePath;
ThemeContainer::initialize(
config: [
'vertical' => require ThemePath::BOOTSTRAP5_VERTICAL,
'horizontal' => require ThemePath::BOOTSTRAP5_HORIZONTAL,
],
defaultConfig: 'vertical',
);
```
... and use `Field` helper to create widgets:
```php
use Yiisoft\Form\PureField\Field;
echo Field::text('firstName', theme: 'horizontal')->label('First Name')->autofocus();
echo Field::text('lastName', theme: 'horizontal')->label('Last Name');
echo Field::select('sex')->label('Sex')->optionsData(['m' => 'Male', 'f' => 'Female'])->prompt('—');
echo Field::number('age')->label('Age')->hint('Please enter your age.');
echo Field::submitButton('Submit')->buttonClass('primary');
```
The result of executing the code above will be:
```html
First Name
Last Name
Sex
—
Male
Female
Age
Please enter your age.
Submit
```
## Documentation
- [Guide](docs/guide/en/README.md)
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for
that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)
## License
The Yii Form is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).