clroma/bootstrap-4-form

此软件包已被弃用,不再维护。没有建议的替代软件包。

Laravel 的 Bootstrap 4 表单包装器。

1.2.3 2019-09-10 08:41 UTC

README

这是一个基于 Dwight Watson 的 Bootstrap 3 表单构建器的分支,经过更新/重新设计,以在 Laravel 5 应用程序中使用 Bootstrap 4 类等。它扩展了 Laravel Collective 表单构建器,为您提供了带有标签、错误消息和适当类使用的水平表单组。

Total Downloads Monthly Downloads License

简介

当您想生成 Bootstrap 4 表单组时,只需在 Form 门面处使用 BootstrapForm 门面。如果您使用以下别名,它将看起来像这样:BootForm::open() 等。

BootForm::text('username');

您将获得以下内容

<div class="form-group">
    <label for="username" class="form-control-label col-md-2">Username</label>
    <div class="col-md-10">
        <input type="text" name="username" class="form-control">
    </div>
</div>

当然,如果有该字段的错误,它甚至会填充它们。

<div class="form-group has-error">
    <label for="username" class="form-control-label col-md-2">Username</label>
    <div class="col-md-10">
        <input type="text" name="username" class="form-control">
        <span class="help-block">The username field is required.</span>
    </div>
</div>

如果您熟悉 Dwight Watson 的 Bootstrap 3 表单包,这基本上是同一件事情,但针对 Bootstrap 4 表单。

安装

首先,使用 Composer 安装此软件包。

composer require clroma/bootstrap-4-form

现在,将这些服务提供者添加到您的 config/app.php 文件中(如果您已经添加了 HtmlServiceProvider,则无需再次添加)。

Collective\Html\HtmlServiceProvider::class,
Clroma\BootstrapForm\BootstrapFormServiceProvider::class,

最后,将这些添加到别名数组中(注意:Form 和 Html 必须在 BootstrapForm 之前列出)

'Form'     => Collective\Html\FormFacade::class,
'HTML'     => Collective\Html\HtmlFacade::class,
'BootForm' => Clroma\BootstrapForm\Facades\BootstrapForm::class,

配置

BootstrapForm 有许多配置选项。运行以下 Artisan 命令将配置选项发布到您的 config 目录

php artisan vendor:publish

然后只需向下滚动到该软件包。

水平表单大小

当使用水平表单时,您可以在此处指定左右列的默认大小。注意,您可以为每个列指定任意多个类,以改善移动响应性,例如

col-md-3 col-sm-6 col-xs-12

显示错误

默认情况下,此软件包将只显示每个字段的第一个验证错误。如果您想列出字段的全部验证错误,只需将此配置选项设置为 true。

用法

打开表单

BootstrapForm 改进了打开表单的过程,在提供 Bootstrap 类以及管理基于模型的表单模型方面都得到了改进。

// Passing an existing, persisted model will trigger a model
// binded form.
$user = User::whereEmail('example@example.com')->first();

// Named routes
BootForm::open(['model' => $user, 'store' => 'users.store', 'update' => 'users.update']);

// Controller actions
BootForm::open(['model' => $user, 'store' => 'UsersController@store', 'update' => 'UsersController@update']);

如果将模型传递给 open 方法,则它将配置为使用 update 路由和 PUT 方法。否则,它将指向 store 方法作为 POST 请求。这样,您可以使用相同的打开标签处理创建和保存。

// Passing a model that hasn't been saved or a null value as the
// model value will trigger a `store` form.
$user = new User;

BootForm::open()

表单变体

有几个助手可以帮助打开不同类型的 Bootstrap 表单。默认情况下,open() 将使用配置文件中设置的表单样式。这些助手使用与 open() 方法相同的输入。

// Open a vertical Bootstrap form.
BootForm::vertical();

// Open an inline Bootstrap form.
BootForm::inline();

// Open a horizontal Bootstrap form.
BootForm::horizontal();

如果您想更改配置文件中设置的表单列,您也可以通过$options数组来设置。

BootForm::open(['left_column_class' => 'col-md-2', 'left_column_offset_class' => 'col-md-offset-2', 'right_column_class' => 'col-md-10']);

文本输入

以下是文本输入的各种方法。请注意,方法签名与Laravel表单生成器提供的方法相对接近,但需要提供一个表单标签参数。

// The label will be inferred as 'Username'.
BootForm::text('username');

// The field name by default is 'email'.
BootForm::email();

BootForm::textarea('profile');

// The field name by default is 'password'.
BootForm::password();

复选框和单选按钮输入

复选框和单选按钮(待办)略有不同,生成的标记也不同。

查看配置选项的方法签名。

// A checked checkbox.
BootForm::checkbox('interests[]', 'Laravel', 'laravel', true);

单选按钮尚未启用... 应该很快更新。

//BootForm::radio('gender', 'Male', 'male');

多个复选框和单选按钮

只需传递一个包含值/标签对的数组,您就可以轻松生成一组复选框或单选按钮。

$label = 'this is just a label';

$interests = [
    'laravel' => 'Laravel',
    'react'   => 'React',
    'vue'     => 'Vue'
];

// Checkbox inputs with Laravel and Rails selected.
BootForm::checkboxes('interests[]', $label, $interests, ['laravel', 'rails']);

$genders = [
    'male'   => 'Male',
    'female' => 'Female'
];

// Gender inputs inline, 'Gender' label inferred.
BootForm::radios('gender', null, $genders, null, true);

// Gender inputs with female selected.
BootForm::radios('gender', 'Gender', $genders, 'female');

提交按钮

// Pretty simple.
BootForm::submit('Login');

关闭表单

// Pretty simple.
BootForm::close();

标签

隐藏标签

通过将值设置为false,您可能隐藏元素的标签。

// An input with no label.
BootForm::text('username', false);

带有HTML的标签

在标签内包含HTML代码

// A label with HTML code using array notation
BootForm::text('username', ['html' => 'Username <span class="required">*</span>']);

// A label with HTML code using HtmlString object
BootForm::text('username', new Illuminate\Support\HtmlString('Username <span class="required">*</span>'));

帮助文本

您可以向任何字段传递help_text选项,以便将Bootstrap帮助文本附加到渲染的表单组。

表单输入组(后缀和前缀)

向任何输入添加前缀和/或后缀 - 您可以添加文本、图标和按钮。

// Suffix button with 'Call' as label and success class to button
{!! BootForm::text('tel', 'Phone', null, ['suffix' => BootForm::addonButton('Call', ['class' => 'btn-success'])] ) !!}

// Prefix button with 'Call' as label and success class to button
{!! BootForm::text('tel', 'Phone', null, ['prefix' => BootForm::addonButton('Call', ['class' => 'btn-success'])] ) !!}

// Prefix icon (I put second parameter after <i class="fa fa-SECOND_PARAMETER"></i>) with 'dollar' as icon
{!! BootForm::text('tel', 'Phone', null, ['prefix' => BootForm::addonIcon('dollar')] ) !!}

// Prefix and suffix as text
{!! BootForm::text('tel', 'Phone', null, ['prefix' => BootForm::addonText('1-'), 'suffix' => BootForm::addonIcon('phone')] ) !!}

// Prefix and suffix with button
{!! BootForm::text('tel', 'Phone', null, ['suffix' => BootForm::addonButton('Boom!', ['class' => 'btn-danger']), 'prefix' => BootForm::addonButton('Call', ['class' => 'btn-success'])] ) !!}

Dwight Watson的原始Bootstrap 3表单生成器

这是此优秀包的分支,略微调整以使用Bootstrap 4。