If you is using Laravel 5.5, the auto discovery feature will make everything for you and your job is done, you can start using now. Else, follow the steps below to install.
Laravel 5.4
Add the service provider to your config/app.php file
// Opening a form using POST method
{!!Form::open()!!}
// ... Form components here
{!!Form::close()!!}
Opening the form will add _token field automatically for you
Inline form
// Making all inputs inline
{!!Form::open()->formInline()!!}
// You can use FALSE to turn off disable form inline
{!!Form::open()->formInline(false)!!}
Fieldset
Param
Type
Default
Description
$legend
string
null
Fieldset Legend
// Example
{!!Form::fieldsetOpen('Legend title')!!}
// ... fieldset content
{!!Form::fieldsetClose()!!}
Basic inputs
Text inputs
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::text('name', 'User name')!!}
Textarea
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::textarea('description', 'Description')!!}
Select
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$options
array
[]
Select options
$default
string
null
Default value
// Example
{!!Form::select('city', 'Choose your city', [1 => 'Gotham City', 2 => 'Springfield'])!!}
Options
Param
Type
Default
Description
$options
iterable
[]
Options list
$valueKey
string
null
key for value
$idKey
string
null
key for id
// Example// With array
{!!Form::select('city', 'Choose your city')->options([1 => 'Gotham City', 2 => 'Springfield'])!!}
// With collection$cities = collect([1 => 'Gotham City', 2 => 'Springfield'])
{!!Form::select('city', 'Choose your city')->options($cities)!!}
// With model collection$cities = \App\City::all();
{!!Form::select('city', 'Choose your city')->options($cities)!!}
// Your model should have id and name attributes. If these keys are different, you can pass second and/or third parameters (you can use the second parameter to access some model acessor, also)$cities = \App\City::all();
{!!Form::select('city', 'Choose your city')->options($cities, 'city_name', 'id_object_field')!!}
// When you are using collections, you can use prepend method (https://laravel.com/docs/5.8/collections#method-prepend) to add an first empty value, like "Choose your city"$cities = \App\City::all();
{!!Form::select('city', 'Choose your city')->options($cities->prepend('Choose your city', ''))!!}
Checkbox
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$value
string
null
Input value
$checked
boolean
null
Default value
// Example
{!!Form::checkbox('orange', 'Orange')!!}
Radio
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$value
string
null
Input value
$checked
boolean
null
Default value
// Example
{!!Form::radio('orange', 'Orange')!!}
File
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
// Example
{!!Form::file('doc', 'Document')!!}
Date inputs
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::date('birthday', 'Birthday')!!}
Tel inputs
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::tel('number', 'Phone number')!!}
Time inputs
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::time('hour', 'Meeting hour')!!}
URL inputs
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::urlInput('website', 'You website')!!}
Range inputs
Param
Type
Default
Description
$name
string
null
Input name
$label
string
null
Input label
$default
string
null
Default value
// Example
{!!Form::range('name', 'User name')!!}
Hidden
Param
Type
Default
Description
$name
string
null
Input name
$default
boolean
null
Default value
// Example
{!!Form::hidden('user_id')!!}
Anchor
Param
Type
Default
Description
$value
string
null
Anchor text
$url
string
null
Anchor url
// Example
{!!Form::anchor("Link via parameter", 'foo/bar')!!}
Buttons
Param
Type
Default
Description
$value
string
null
Button value
$color
string
null
Button color
$size
string
null
button size
Submit
// Example
{!!Form::submit("Send form")!!}
Button
// Example
{!!Form::button("Do something", "warning", "lg")!!}
Reset
// Example
{!!Form::reset("Clear form")!!}
Chainable methods
This package uses chaining feature, allowing easly pass more parameters.
Filling a form
Param
Type
Default
Description
$data
object/array
array
Data fo fill form inputs
// Examples// With initial data using a Model instance$user = User::find(1);
{!!Form::open()->fill($user)!!}
// With initial array data$user = ['name' => 'Jesus', 'age' => 33];
{!!Form::open()->fill($user)!!}
Url
Use in anchors and forms openings
Param
Type
Default
Description
$url
string
null
Url
// Example
{!!Form::anchor("Link via url")->url('foo/bar')!!}
Route
Use in anchors and forms openings
Param
Type
Default
Description
$route
string
null
Route name
// Example
{!!Form::anchor("Link via route")->route('home')!!}
Error Bag
Use if you have more then one form per page. You set an identifier for each form, and the errors will be attached for that specific form
Param
Type
Default
Description
$value
string
null
Error bag name
// Example: attach this form to a error bag called "registerErrorBag"
{!!Form::open()->route('register.post')->errorBag("registerErrorBag")!!}
// ------------------------------------------------------// Now, in your controller (register.post route), you can redirect the user to a form page again, with erros inside a error bag called "registerErrorBag"publicfunctionregister(Request$request)
{
$validator = Validator::make($request->all(), [
// ... rules here
]);
if ($validator->fails()) {
return redirect()
->route('register.form')
->withInput()
->withErrors($validator, 'registerErrorBag');
}
// Proced to register here
}
// ------------------------------------------------------// If your validation is on a Form Request, you can add a protected method "$errorBag" to set a ErrorBag nameclassRegisterRequestextendsFormRequest
{
protected$errorBag = 'registerErrorBag';
publicfunctionauthorize()
{
returntrue;
}
publicfunctionrules()
{
return [
// ... rules here
];
}
}
Errors
Show all errors inside a panel
Param
Type
Default
Description
$title
string
null
Panel title
// Example
{!!Form::errors("The form has errors")!!}
Disable validation messages
Disable success/error status and validation error message
Param
Type
Default
Description
$disabled
boolean
false
Disabled status
// Example
{!!Form::text('username', 'User name')->disableValidation()!!}
// You can use FALSE to turn off disable validation (to enable it)
{!!Form::text('username', 'User name')->disableValidation(false)!!}
Checked
Set the checkbox/radio checked status
Param
Type
Default
Description
$checked
boolean
true
Checked status
// Examples// Using readonly field
{!!Form::checkbox('agree', 'I agree')->checked()!!}
// You can use FALSE to turn off checked status
{!!Form::checkbox('agree', 'I agree')->checked(false)!!}
Inline
Set the checkbox/radio checked status
// Examples
{!!Form::radio('orange', 'Orange')->inline()!!}
{!!Form::checkbox('orange', 'Orange')->inline()!!}
// You can use FALSE to turn off inline status
{!!Form::checkbox('orange', 'Orange')->inline(false)!!}
Placeholder
Param
Type
Default
Description
$placeholder
string
null
Placeholder text
// Example
{!!Form::text('name', 'Name')->placeholder('Input placeholder')!!}