adnzaki / simple-tag-bootstrap
Bootstrap v5 组件适配器,适用于 PHP
Requires
- php: ^7.4 || ^8.0
This package is auto-updated.
Last update: 2024-09-06 08:11:40 UTC
README
Bootstrap v5 组件适配器,适用于 PHP
什么是 SimpleTagBootstrap?
SimpleTagBootstrap 是一个使用 SimpleTag 库编写的面向对象的 Bootstrap v5 组件适配器。它的目标是简化在使用大量 PHP 代码时对 Bootstrap 组件的使用。就像旨在使 HTML 可编程的 SimpleTag 一样,这个库旨在使 Bootstrap 的使用更加简单,当然,也可以通过 PHP 进行编程。
安装
Composer
我们建议您通过 Composer 安装 SimpleTagBootstrap,因为它将使您更容易更新它。除此之外,如果您已经通过 Composer 安装了其他库,您将获得自动加载的优点,这不需要您每次都包含 "wrapper.php"。只需输入以下命令即可安装
composer require adnzaki/simple-tag-bootstrap
或者如果您有一个 composer.json
文件,只需将指向包名的需求添加进去
"require": {
"adnzaki/simple-tag-bootstrap": "^0.1.0",
}
如果您考虑获取最新源代码,将 "^0.1.0" 改为 "dev-master",这样它将下载 SimpleTagBootstrap 的未发布版本。
然后只需运行 composer update
来安装。
手动下载
您可以直接从这个仓库手动下载 SimpleTagBootstrap。只需指向 "代码" 菜单并选择 "下载 ZIP" 以下载最新的源代码,或者转到 "发布" 菜单并找到最新的稳定版本。
功能
使用 SimpleTagBootstrap,我们试图涵盖 Bootstrap 组件可以做的所有内容。例如,在 <input>
元素中,Bootstrap 有许多选项是开发者构建输入表单时所需的,因此我们采用了这些选项,以便在 SimpleTagBootstrap 中使用。
它是如何工作的?
SimpleTagBootstrap 随带许多类,包含大多数 Bootstrap 组件。这是一个基于 SimpleTag 的库,通过将它们转换为 SimpleTag 格式来简化 Bootstrap 组件的编写。因此,您只需调用已提供的类中的任何组件即可。
我是否需要学习 SimpleTag?
不,您有两个选项将您的 HTML 元素传递到 SimpleTagBootstrap 类方法中;使用 SimpleTag 格式或单独的 HTML 文件。但在某些情况下,您需要一些基本的 SimpleTag 使用,它允许您在不编写任何 HTML 代码的情况下完全编写 Bootstrap 组件。
示例在哪里?
只需打开此仓库中的 components
目录,并深入了解提供的每个组件。在那里,您将看到每个组件的示例。
"包装" 文件
激活 SimpleTagBootstrap 的关键是调用您的 PHP 代码顶部的包装文件。查看 index.php
文件以查看开始使用 SimpleTagBootstrap 的完整代码示例。在深入研究源代码之前,查看我们下面的 SimpleTagBootstrap 目录结构。
\bootstrap
\css
\icons
\js
\components
.... the components folder
\custom-slots
\simple-tag
.... SimpleTag library located here
\test
wrapper.php
index.php
.... and so on.
Bootstrap 文件
我们已包括必要的 Bootstrap 文件,以便在您使用 SimpleTagBootstrap 时更加方便。这种方法使您具有以下优点:
- 保持 Bootstrap 最新
- 保持 Bootstrap 版本与 SimpleTagBootstrap 中的版本相同。
- 无需在外部下载 Bootstrap
- 只需一步即可更新整个 SimpleTagBootstrap
初始化函数
SimpleTagBootstrap中定义的每个组件都在一个类中,但您不必为每个组件创建对象,因为我们有“初始化函数”已经为您完成了这项工作。这个函数的名称与其组件类名相同,例如Accordion
类有一个名为accordion()
的初始化函数。因此,您可以直接调用该类中的方法,而无需先创建对象,例如使用accordion()->open()
来创建手风琴打开标签。这些函数位于它们的类文件中,并在包装文件中一起封装。
BaseClass
类
SimpleTagBootstrap有一个名为BaseClass
的类,它共享HTML元素上的常用功能。它有以下方法可用于所有组件
BaseClass::slot(string|array $slots)
用于将插槽插入组件中,它可以是一个字符串或数组,并且应采用SimpleTag接受的格式。BaseClass::addClass(string|array $class)
用于向组件添加自定义类BaseClass::id(string $id)
用于为组件创建一个IDBaseClass::attr(array $attributes = [])
用于存储元素的额外属性。额外的属性通常用于定义事件处理,但在其他情况下,它可以用于任何高级HTML选项,例如Vue的自定义HTML属性,例如v-model
、v-bind
、v-if
等。我们还在内部使用此方法构建SimpleTagBootstrap组件。
查看每个组件的示例,了解如何使用它们。BaseClass::preventBrowserOutput()
用于防止SimpleTag的render()
函数直接将输出发送到浏览器。通过运行此方法,您在调用组件的渲染方法时必须使用echo
语句。BaseClass::position(string $positionStart, string $positionEnd, string $translate = '')
用于设置元素的位置。点击这里了解更多详情。BaseClass::positionType(string $value)
用于设置位置值,如静态、相对、绝对、固定和粘性。