PHPackages                             alescx/bootstrap-ui - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. alescx/bootstrap-ui

ActiveCakephp-plugin[Utility & Helpers](/categories/utility)

alescx/bootstrap-ui
===================

Twitter Bootstrap 3 support for CakePHP 3

012PHP

Since Apr 28Pushed 8y ago1 watchersCompare

[ Source](https://github.com/alescx/bootstrap-ui)[ Packagist](https://packagist.org/packages/alescx/bootstrap-ui)[ RSS](/packages/alescx-bootstrap-ui/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Bootstrap UI
============

[](#bootstrap-ui)

[![Build Status](https://camo.githubusercontent.com/bd0a2262e466c767ce6c7b7e10571b1d88a3c9c13eeeb7dbf2fd9da54864f24f/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f467269656e64734f6643616b652f626f6f7473747261702d75692f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/FriendsOfCake/bootstrap-ui)[![Coverage Status](https://camo.githubusercontent.com/b8379c048a3104e4206937c3ad69937f91b8bb960c00c26de6aaa14e25ff4d48/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f467269656e64734f6643616b652f626f6f7473747261702d75692f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/r/FriendsOfCake/bootstrap-ui?branch=master)[![Total Downloads](https://camo.githubusercontent.com/3ca1fd3e1ca7fc318c25d06a2f1c4d4ca0e2e064f6663908191a2bfcff395b22/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f667269656e64736f6663616b652f626f6f7473747261702d75692e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/friendsofcake/bootstrap-ui)[![License](https://camo.githubusercontent.com/942e017bf0672002dd32a857c95d66f28c5900ab541838c6c664442516309c8a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/friendsofcake/bootstrap-ui)

Transparently use [Bootstrap 3](http://getbootstrap.com) with [CakePHP 3](http://cakephp.org).

Requirements
------------

[](#requirements)

- CakePHP 3.x
- Bootstrap 3.x
- jQuery 1.9+

What's included?
----------------

[](#whats-included)

- FlashComponent + elements (types: error, info, success, warning)
- FormHelper (align: default, inline, horizontal)
- HtmlHelper (components: breadcrumbs, badge, label, icon)
- PaginatorHelper
- Widgets (basic, radio, button, select, textarea)
- Sample layouts (cover, signin, dashboard)
- Bake templates *incomplete*

Installing Using [Composer](http://getcomposer.org)
---------------------------------------------------

[](#installing-using-composer)

`cd` to the root of your app folder (where the `composer.json` file is) and run the following command:

```
composer require friendsofcake/bootstrap-ui

```

Then load the plugin by adding the following to your app's `config/boostrap.php`:

```
\Cake\Core\Plugin::load('BootstrapUI');
```

or using CakePHP's console:

```
./bin/cake plugin load BootstrapUI

```

Usage
-----

[](#usage)

You will need to modify your `src/View/AppView` class to either extend `BootstrapUI\View\UIView` or use the trait `BootStrapUI\View\UIViewTrait`.

### AppView Setup

[](#appview-setup)

For a quick setup, just make your `AppView` class extend `BootstrapUI\View\UIView`. The base class will handle the initializing and loading of the BootstrapUI `layout.ctp` for your app.

The `src\View\AppView.php` will look something like the following:

```
namespace App\View;

use BootstrapUI\View\UIView;

class AppView extends UIView
{

    /**
     * Initialization hook method.
     */
    public function initialize()
    {
        //Don't forget to call the parent::initialize()
        parent::initialize();
    }
}
```

### AppView Setup Using UIViewTrait

[](#appview-setup-using-uiviewtrait)

If you're adding BootstrapUI to an existing application. It might be easier to use the trait, as it gives you more control over the loading of the layout.

```
namespace App\View;

use BootstrapUI\View\UIViewTrait;
use Cake\View\View;

class AppView extends View
{
    use UIViewTrait;

    /**
     * Initialization hook method.
     */
    public function initialize()
    {
        //render the initializeUI method from the UIViewTrait
        $this->initializeUI();
    }
}
```

BootstrapUI Layout
------------------

[](#bootstrapui-layout)

BootstrapUI comes with its own `layout.ctp` file and examples taken from the Bootstrap framework.

When no layout for the view is defined the `BootstrapUI\View\UIViewTrait` will load its own `layout.ctp` file. You can override this behavior in two ways.

- Assign a layout to the view with `$this->layout('layout')`.
- Disable auto loading of the layout in `BootstrapUI\View\UIViewTrait` with `$this->initializeUI(['layout' => false]);`.

### Loading the Bootstrap framework

[](#loading-the-bootstrap-framework)

If you wish to use your own layout template, just make sure to include:

```
// in the
echo $this->Html->css('path/to/bootstrap.css');
echo $this->Html->script(['path/to/jquery.js', 'path/to/bootstrap.js']);
```

When using the BootstrapUI layout (or a copy of it), extra layout types (directly taken from the Bootstrap examples). You just need to copy them to your application's layouts directory:

```
cp -R vendor/friendsofcake/bootstrap-ui/src/Template/Layout/examples src/Template/Layout/TwitterBootstrap

```

You can then simply extend them in your views like so:

```
$this->extend('../Layout/TwitterBootstrap/dashboard');

```

Available types are:

- cover
- signin
- dashboard
- blog *coming soon*

**NOTE: Remember to set the stylesheets in the layouts you copy.**

Installing Bootstrap via Bower
------------------------------

[](#installing-bootstrap-via-bower)

A quick way of getting the Bootstrap assets installed is using [bower](http://bower.io). Assuming you are in `ROOT`:

```
bower install bootstrap
mkdir -p webroot/css/bootstrap webroot/js/bootstrap webroot/js/jquery webroot/css/fonts
cp bower_components/bootstrap/dist/css/* webroot/css/bootstrap/.
cp bower_components/bootstrap/dist/js/* webroot/js/bootstrap/.
cp bower_components/jquery/dist/* webroot/js/jquery/.
cp bower_components/bootstrap/dist/fonts/* webroot/css/fonts/.
echo /bower_components >> .gitignore
git add .gitignore \
bower.json \
webroot/css/bootstrap \
webroot/js/bootstrap \
webroot/js/jquery

```

Console Bake
------------

[](#console-bake)

For those of you who want even more automation, some bake templates have been included. Use them like so:

```
$ bin/cake bake.bake [subcommand] -t BootstrapUI

```

Helper Usage
------------

[](#helper-usage)

At the core of BootstrapUI is a collection of enhancements for CakePHP core helpers. These helpers replace the HTML templates used to render elements for the views. This allows you to create forms and components that use the Bootstrap styles.

The current list of enhanced helpers are:

- `BootstrapUI\View\Helper\FlashHelper`
- `BootstrapUI\View\Helper\FormHelper`
- `BootstrapUI\View\Helper\HtmlHelper`
- `BootstrapUI\View\Helper\PaginatorHelper`

When the `BootstrapUI\View\UIViewTrait` is initialized it loads the above helpers with the same aliases as the CakePHP core helpers. That means that when you use `$this->Form->create()` in your views. The helper being used is from the BootstrapUI plugin.

### Basic Form

[](#basic-form)

```
echo $this->Form->create($article);
echo $this->Form->control('title');
echo $this->Form->control('published', ['type' => 'checkbox']);
```

will render this HTML:

```

        Title

            Published

```

### Horizontal Form

[](#horizontal-form)

```
echo $this->Form->create($article, ['align' => [
    'sm' => [
        'left' => 6,
        'middle' => 6,
        'right' => 12
    ],
    'md' => [
        'left' => 4,
        'middle' => 4,
        'right' => 4
    ]
]]);
echo $this->Form->control('title');
echo $this->Form->control('published', ['type' => 'checkbox']);
```

will render this HTML:

```

        Title

                Published

```

### Configuration

[](#configuration)

You can configure each of the helpers by passing in extra parameters through the AppView.php.

Here is an example of changing the `prev` and `next` labels for the PaginatorHelper.

```
$this->loadHelper(
    'Paginator',
    [
        'className' => 'BootstrapUI.Paginator',
        'labels' => [
            'prev' => 'previous',
            'next' => 'next',
        ]
    ]
);
```

To style auth flash messages properly set the `flash` key in `AuthComponent` config as shown:

```
        $this->loadComponent('Auth', [
            'flash' => [
                'element' => 'error',
                'key' => 'auth'
            ],
            ...

```

**NOTE: Check tests for more examples.**

Testing
-------

[](#testing)

You can run the tests for BootstrapUI by doing the following:

```
    $ composer install
    $ ./vendor/bin/phpunit

```

Patches & Features
----------------------

[](#patches--features)

- Fork
- Mod, fix
- Test - this is important, so it's not unintentionally broken
- Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
- Pull request - bonus point for topic branches

To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards. A `pre-commit`hook has been included to automatically run the code sniffs for you. From your project's root directory:

```
cp ./contrib/pre-commit .git/hooks/
chmod 755 .git/hooks/pre-commit

```

Bugs & Feedback
-------------------

[](#bugs--feedback)

License
-------

[](#license)

Copyright (c) 2015, Jad Bitar and licensed under [The MIT License](http://www.opensource.org/licenses/mit-license.php).

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/6fe34a693b4246641a0b00bff1368d02119898030b8495f6fc606a387124f2e3?d=identicon)[alescx](/maintainers/alescx)

---

Top Contributors

[![jadb](https://avatars.githubusercontent.com/u/33527?v=4)](https://github.com/jadb "jadb (130 commits)")[![ADmad](https://avatars.githubusercontent.com/u/142658?v=4)](https://github.com/ADmad "ADmad (117 commits)")[![eymen-elkum](https://avatars.githubusercontent.com/u/2862528?v=4)](https://github.com/eymen-elkum "eymen-elkum (23 commits)")[![josegonzalez](https://avatars.githubusercontent.com/u/65675?v=4)](https://github.com/josegonzalez "josegonzalez (16 commits)")[![lorenzo](https://avatars.githubusercontent.com/u/37621?v=4)](https://github.com/lorenzo "lorenzo (8 commits)")[![balcsida](https://avatars.githubusercontent.com/u/1768446?v=4)](https://github.com/balcsida "balcsida (7 commits)")[![AD7six](https://avatars.githubusercontent.com/u/33387?v=4)](https://github.com/AD7six "AD7six (6 commits)")[![dakota](https://avatars.githubusercontent.com/u/83255?v=4)](https://github.com/dakota "dakota (6 commits)")[![cewi](https://avatars.githubusercontent.com/u/1643900?v=4)](https://github.com/cewi "cewi (5 commits)")[![steefaan](https://avatars.githubusercontent.com/u/5982785?v=4)](https://github.com/steefaan "steefaan (5 commits)")[![alescx](https://avatars.githubusercontent.com/u/5637058?v=4)](https://github.com/alescx "alescx (3 commits)")[![dereuromark](https://avatars.githubusercontent.com/u/39854?v=4)](https://github.com/dereuromark "dereuromark (3 commits)")[![broot02](https://avatars.githubusercontent.com/u/7757740?v=4)](https://github.com/broot02 "broot02 (3 commits)")[![martonmiklos](https://avatars.githubusercontent.com/u/1609182?v=4)](https://github.com/martonmiklos "martonmiklos (3 commits)")[![monsurhoq](https://avatars.githubusercontent.com/u/7543998?v=4)](https://github.com/monsurhoq "monsurhoq (3 commits)")[![hiryu85](https://avatars.githubusercontent.com/u/406275?v=4)](https://github.com/hiryu85 "hiryu85 (2 commits)")[![CodeBlastr](https://avatars.githubusercontent.com/u/393946?v=4)](https://github.com/CodeBlastr "CodeBlastr (2 commits)")[![bfncs](https://avatars.githubusercontent.com/u/1049882?v=4)](https://github.com/bfncs "bfncs (1 commits)")[![vaughany](https://avatars.githubusercontent.com/u/381767?v=4)](https://github.com/vaughany "vaughany (1 commits)")[![ceeram](https://avatars.githubusercontent.com/u/111448?v=4)](https://github.com/ceeram "ceeram (1 commits)")

### Embed Badge

![Health badge](/badges/alescx-bootstrap-ui/health.svg)

```
[![Health](https://phpackages.com/badges/alescx-bootstrap-ui/health.svg)](https://phpackages.com/packages/alescx-bootstrap-ui)
```

###  Alternatives

[bitrix-expert/bbc-module

Module with classes for the basis components

1951.8k1](/packages/bitrix-expert-bbc-module)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)