de-swebhosting-flow-package / bootstrap
简化 Bootstrap 框架集成,并提供 JS 加载和资源处理的实用视图助手和类。
Requires
- neos/flow: *
Suggests
- twbs/bootstrap: The output of the view helpers of this package is optimized for the Bootstrap framework (https://bootstrap.ac.cn/).
This package is auto-updated.
Last update: 2022-08-22 22:20:23 UTC
README
此包为 Flow 框架 提供了一些视图助手和实用函数,可以使前端开发更轻松。
视图助手的默认输出已针对与 Bootstrap 框架协同工作进行了优化(因此得名),但也适用于其他框架或自定义样式。
组件
以下是此包提供的组件简要概述。
视图助手
此包包含一系列视图助手,希望能让您的生活更轻松。请记住,如果您想使用它们,请注册命名空间。
{namespace bs=De\SWebhosting\Bootstrap\ViewHelpers}
以下是可用视图助手的简要概述。
名称 | 用途 |
---|---|
form.inlineHelpOrErrors | 显示表单元素的 [内联帮助] (https://bootstrap.ac.cn/css/#forms-help-text) 或错误消息。 |
form.validatedControlGroup | 显示带有 [根据验证错误类] 的表单组。 |
format.trimWhiteSpaceBetweenHtml | 删除 HTML 元素之间的所有空白。 |
javaScript.append | 将内容追加到 JavaScript 容器中,请参阅下文 "JavaScript 容器" 部分。 |
javaScript.render | 渲染 JavaScript 容器的内容,请参阅下文 "JavaScript 容器" 部分。 |
resource.collectionUri | 渲染自定义集合中资源的公共 URI。需要 [TYPO3 Flow 补丁] (https://review.typo3.org/#/c/37686/)! |
widget.autocomplete | 一个启用输入字段的自动完成的部件。需要 [jQuery UI] (https://jqueryui.jqueryjs.cn/autocomplete/)! |
widget.paginate | 具有修改过的类以与 Bootstrap 协同工作的分页部件。 |
menuItem | 一个根据活动控制器/操作改变其类的 HTML 容器(div)。 |
JavaScript 容器
JavaScript 容器的理念是提供一个中央容器,组件可以在此处注册它们需要的 JavaScript 代码,然后模板设计人员可以使用视图助手来渲染这些代码。
您可以将 JavaScript 代码添加到容器中,也可以添加一个应使用 script 标签包含的文件。
还可以管理多个应在不同位置渲染的分区(例如,页眉和页脚)。
资源处理
此包提供了 \De\SWebhosting\Bootstrap\Resource\ReadOnlyDirectoryStorage
。此存储可用于发布任何本地目录,与 \Neos\Flow\Resource\Target\FileSystemSymlinkTarget
一起使用。
创建自定义集合以发布您使用 composer 加载的前端库,并使用 `resource.collectionUri` 视图助手检索匹配的 URL,以便在布局中包含库。
部分
此包目前提供以下部分:
部分 | 用途 |
---|---|
错误列表 | 此部分可用于调试目的。它以扁平列表的形式打印所有验证错误。 |
Flash消息 | 此部分将在Bootstrap兼容的容器/类中渲染所有可用的Flash消息。 |
要在您的应用程序中使用这些部分,您需要将De.SWebhosting.Bootstrap包的部分路径添加到Views.yml
配置文件中。