yiisoft/yii-bulma

Bulma CSS 框架组件集合。

1.0.0 2022-04-01 15:37 UTC

README

Yii 框架 Bulma 集成


Latest Stable Version Total Downloads Build status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

Yii 框架 包封装了 Bulma 组件和插件,以 Yii 小部件的形式提供,从而使得在 Yii 应用程序中使用 Bulma 组件/插件变得方便。

要求

  • PHP 8.0 或更高版本。

安装

可以使用 Composer 安装此包。

composer require yiisoft/yii-bulma

安装资源文件

有几种方式可以安装资源文件,包括以下几种:

  1. 使用 AssetPackagist 包管理器。

在 composer.json 文件中添加以下内容:

{
    "require": {
        "npm-asset/bulma": "^0.9.3",
        "npm-asset/bulma-helpers": "^0.4.2",
        "npm-asset/vizuaalog--bulmajs": "^0.12.1",
        "oomphinc/composer-installers-extender": "^2.0.0",
    },
    "extra": {
        "installer-types": [
            "npm-asset"
        ],
        "installer-paths": {
            "./node_modules/{$name}": [
                "type:npm-asset"
            ]
        }
    },
    "repositories": [
        {
            "type": "composer",
            "url": "https://asset-packagist.org"
        }
    ]
}

一旦做出更改,您可以使用以下命令安装资源文件:

composer update
  1. 使用 npm-asset 包管理器。

在应用程序的根目录中运行以下命令:

npm i bulma
npm i @vizuaalog/bulmajs
npm i bulma-helpers

使用资源文件

Bulma 是一个 CSS 框架,提供了所有 CSS 和 SASS 文件来定制您的应用程序,默认情况下,小部件不注册任何资源,因此您必须将它们注册到您的应用程序中才能使用,您可以使用默认的 CSS 文件布局,或者构建您自己的自定义 CSS。

提供了三种资源文件

  • BulmaAsset: CSS,SASS 文件,Bulma CSS 框架,不包含 JS 代码。
  • BulmaHelperAsset: CSS,SASS,MIXINS,是一个辅助库,为 Bulma CSS 框架提供文件辅助工具。
  • BulmaJsAsset: Vizuaalog/BulmaJs,是一个辅助库,包含 Bulma CSS 框架中使用的所有 JS,您可以决定使用此库,或者编写自己的 JS 代码。

仅使用小部件时,注册 BulmaAsset::class,以下将解释如何以几种方式完成此操作。

在视图布局或单个视图中注册资源

通过在 resources/layout/main.php 中注册资源,它将对所有视图可用。如果您只需要在单个视图中注册(例如 resources/views/site/contact.php),则在该视图中注册。

use  Yiisoft\Yii\Bulma\Asset\BulmaAsset;

/**
 * @var Yiisoft\Assets\AssetManager $assetManager
 * @var Yiisoft\View\WebView $this
 */

$assetManager->register(BulmaAsset::class);

$this->setCssFiles($assetManager->getCssFiles());
$this->setJsFiles($assetManager->getJsFiles());

在应用程序参数中注册资源

您可以在资源参数中注册资源(默认情况下,这是 config/packages/yiisoft/assets/params.php)。资源将对此应用程序的所有视图可用。

use Yiisoft\Yii\Bulma\Asset\BulmaAsset;

'yiisoft/asset' => [
    'assetManager' => [
        'register' => [
            BulmaAsset::class,
        ],
    ],
],

然后在 resources/layout/main.php 中:

/* @var Yiisoft\View\WebView $this */

$this->setCssFiles($assetManager->getCssFiles());
$this->setJsFiles($assetManager->getJsFiles());

文档

如果您需要帮助或有疑问,Yii 论坛 是一个不错的选择。您还可以查看其他 Yii 社区资源

许可证

Yii 框架 Bulma 集成是免费软件。它根据 BSD 许可协议发布。请参阅 LICENSE 以获取更多信息。

Yii 软件 维护。

支持项目

Open Collective

关注更新

Official website Twitter Telegram Facebook Slack