Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/yii-bulma
Yii Framework Bulma Integration
https://github.com/yiisoft/yii-bulma
bulma hacktoberfest yii3
Last synced: 4 months ago
JSON representation
Yii Framework Bulma Integration
- Host: GitHub
- URL: https://github.com/yiisoft/yii-bulma
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2020-06-23T14:23:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T12:57:33.000Z (over 1 year ago)
- Last Synced: 2024-04-14T02:29:43.461Z (9 months ago)
- Topics: bulma, hacktoberfest, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 601 KB
- Stars: 24
- Watchers: 17
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Framework Bulma Integration
[](https://packagist.org/packages/yiisoft/yii-bulma)
[](https://packagist.org/packages/yiisoft/yii-bulma)
[](https://github.com/yiisoft/yii-bulma/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/yiisoft/yii-bulma/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/yii-bulma/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/yii-bulma/master)
[](https://github.com/yiisoft/yii-bulma/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/yii-bulma)
This [Yii Framework](https://www.yiiframework.com/) package encapsulates [Bulma](https://bulma.io) components
and plugins in terms of Yii widgets, and thus makes using Bulma components/plugins in Yii applications convenient.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/yii-bulma
```
## Install assets
There are several ways to install the assets, they are:
1. Using the [AssetPackagist](https://asset-packagist.org/) package manager.
Add to composer.json file the following:
```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"
}
]
}
```
Once the changes are made, you can install the assets using the following command:
```shell
composer update
```
2. Using the [npm-asset](https://www.npmjs.com/) package manager.
Run the following command at the root directory of your application.
```shell
npm i bulma
npm i @vizuaalog/bulmajs
npm i bulma-helpers
```
## Using assets
Bulma is a CSS framework that provides all the CSS and SASS files to customize your application, the widgets by default
do not register any Asset so you must register them in your application to be used, since you can simply use the
default CSS file layout, or build your own custom CCS.
Three Assets are provided:
- [BulmaAsset](https://bulma.io/): CSS, SASS file bulma css framework without JS code.
- [BulmaHelperAsset](https://github.com/jmaczan/bulma-helpers): CSS, SASS, MIXINS it is an auxiliary library provide
file helpers for Bulma CSS framework.
- [BulmaJsAsset](https://github.com/jgthms/bulma): Vizuaalog/BulmaJs it is an auxiliary library that has all the JS
used by the Bulma CSS framework, you can decide to use this library, or alternatively write your own JS code.
To use widgets only, register `BulmaAsset::class`, which we can do in several ways explained below.
### Register asset in view layout or individual view
By registering the Asset in the `resources/layout/main.php` it will be available for all views.
If you need it registered for individual view (such as `resources/views/site/contact.php`) only,
register it in that view.
```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());
```
### Register asset in application params
You can register asset in the assets parameters, (by default, this is `config/packages/yiisoft/assets/params.php`).
Asset will be available for all views of this application.
```php
use Yiisoft\Yii\Bulma\Asset\BulmaAsset;
'yiisoft/asset' => [
'assetManager' => [
'register' => [
BulmaAsset::class,
],
],
],
```
Then in `resources/layout/main.php`:
```php
/* @var Yiisoft\View\WebView $this */
$this->setCssFiles($assetManager->getCssFiles());
$this->setJsFiles($assetManager->getJsFiles());
```
## Documentation
- [Guide](docs/guide/en/README.md)
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Framework Bulma Integration is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)