Skip to content
This repository was archived by the owner on Jan 2, 2024. It is now read-only.

Commit 3c4338b

Browse files
committed
Update README.md
1 parent a2e5bee commit 3c4338b

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
# [WIP] Laravel Form Components
1+
# Laravel Form Components
22

33
[![Latest Version on Packagist](https://img.shields.io/packagist/v/protonemedia/laravel-form-components.svg?style=flat-square)](https://packagist.org/packages/protonemedia/laravel-form-components)
44
[![Build Status](https://img.shields.io/travis/pascalbaljetmedia/laravel-form-components/master.svg?style=flat-square)](https://travis-ci.org/pascalbaljetmedia/laravel-form-components)
55
[![Quality Score](https://img.shields.io/scrutinizer/g/pascalbaljetmedia/laravel-form-components.svg?style=flat-square)](https://scrutinizer-ci.com/g/pascalbaljetmedia/laravel-form-components)
66
[![Total Downloads](https://img.shields.io/packagist/dt/protonemedia/laravel-form-components.svg?style=flat-square)](https://packagist.org/packages/protonemedia/laravel-form-components)
7+
[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/pascalbaljetmedia/laravel-form-components)
8+
9+
A set of Blade components to rapidly build forms with [Tailwind CSS Custom Forms](https://tailwindcss-custom-forms.netlify.app). It uses the default styling from the plugin and is still fully customizable!
710

811
## Features
912

1013
* Components for input, textarea, select, multi-select, checkbox and radio elements
1114
* Support for [Tailwind CSS Custom Forms](https://tailwindcss-custom-forms.netlify.app)
12-
* Re-populate form with [old input](https://laravel.com/docs/master/requests#old-input)
13-
* Validation errors
1415
* Bind a target to a form (or a set of elements) to provide default values
1516
* Support for Spatie's [laravel-translatable](https://github.com/spatie/laravel-translatable)
17+
* Re-populate forms with [old input](https://laravel.com/docs/master/requests#old-input)
18+
* Validation errors
1619
* Components classes and Blade views fully customizable
1720
* Support for prefixing the components
18-
* Prepared for other CSS frameworks as well (future release)
21+
* Prepared for other CSS frameworks as well (in a future release)
1922

2023
## Requirements
2124

@@ -29,6 +32,8 @@ You can install the package via composer:
2932
composer require protonemedia/laravel-form-components
3033
```
3134

35+
Make sure the [Tailwind plugin](https://github.com/tailwindcss/custom-forms#install) is installed and added to your `tailwind.config.js` file. If you're starting a new project, you can use the [Frontend preset for Tailwind CSS](https://github.com/laravel-frontend-presets/tailwindcss) which includes the Custom Forms plugin as well.
36+
3237
## Configuration
3338

3439
There is no configuration needed unless you want to [customize the Blade views and components](#customize-the-blade-views).
@@ -207,7 +212,7 @@ You can group checkbox and radio elements on the same horizontal row by adding a
207212

208213
### Old input data
209214

210-
When a validation errors occurs, and Laravel redirects you back, the form will be re-populated with the old input data. This old data will override any binding or default value.
215+
When a validation errors occurs and Laravel redirects you back, the form will be re-populated with the old input data. This old data will override any binding or default value.
211216

212217
### Handling translations
213218

@@ -237,7 +242,7 @@ You can find the Blade views in the `resources/views/vendor/form-components` fol
237242

238243
### Customize the components
239244

240-
You can bind your own component classes to any of the elements. In the `form-components.php` configuration file, you can change the class *per* component. As the logic for the components is quite complex, it is strongly recommended to duplicate the default component as a starting point, and start editing from there. You'll find the default component classes in the `vendor/protonemedia/laravel-form-components/src/Components` folder.
245+
You can bind your own component classes to any of the elements. In the `form-components.php` configuration file, you can change the class *per* component. As the logic for the components is quite complex, it is strongly recommended to duplicate the default component as a starting point and start editing. You'll find the default component classes in the `vendor/protonemedia/laravel-form-components/src/Components` folder.
241246

242247
### Prefix the components
243248

@@ -286,6 +291,16 @@ Please see [CHANGELOG](CHANGELOG.md) for more information about what has changed
286291

287292
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
288293

294+
## Other Laravel packages
295+
296+
* [`Laravel Analytics Event Tracking`](https://github.com/pascalbaljetmedia/laravel-analytics-event-tracking): Laravel package to easily send events to Google Analytics.
297+
* [`Laravel Blade On Demand`](https://github.com/pascalbaljetmedia/laravel-blade-on-demand): Laravel package to compile Blade templates in memory.
298+
* [`Laravel Cross Eloquent Search`](https://github.com/pascalbaljetmedia/laravel-cross-eloquent-search): Laravel package to search through multiple Eloquent models.
299+
* [`Laravel FFMpeg`](https://github.com/pascalbaljetmedia/laravel-ffmpeg): This package provides an integration with FFmpeg for Laravel. The storage of the files is handled by Laravel's Filesystem.
300+
* [`Laravel Paddle`](https://github.com/pascalbaljetmedia/laravel-paddle): Paddle.com API integration for Laravel with support for webhooks/events.
301+
* [`Laravel Verify New Email`](https://github.com/pascalbaljetmedia/laravel-verify-new-email): This package adds support for verifying new email addresses: when a user updates its email address, it won't replace the old one until the new one is verified.
302+
* [`Laravel WebDAV`](https://github.com/pascalbaljetmedia/laravel-webdav): WebDAV driver for Laravel's Filesystem.
303+
289304
### Security
290305

291306
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
@@ -298,3 +313,7 @@ If you discover any security related issues, please email [email protected] i
298313
## License
299314

300315
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
316+
317+
## Treeware
318+
319+
This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/pascalbaljetmedia/laravel-form-components) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

0 commit comments

Comments
 (0)