holt59/cakephp4-bootstrap-helpers

Bootstrap Helpers for CakePHP 4.0

4.1.0 2022-12-16 07:32 UTC

README

Software License Travis Packagist

CakePHP 4.x Helpers to generate HTML with @Twitter Boostrap style: Breadcrumbs, Flash, Form, Html, Modal, Navbar, Card and Paginator helpers available!

How to... ?

Installation

If you want the Bootstrap 4 version of the plugin:

  • Add the plugin to your composer.json:
# Stable version:
composer require holt59/cakephp3-bootstrap-helpers:4.0.3
$this->loadHelper('Html', [
    'className' => 'Bootstrap.Html',
    // Other configuration options...
]);

Breaking changes from previous versions

  • FormHelper:

    • it is not possible to place error message in a separate column in horizontal form, the error message will always be put below the input.
  • NavbarHelper:

    • the following options of the create() methods have been removed or have had their meaning changed:
      • static is now sticky
      • responsive has been dropped and replace by a collapse option with the following meaning: true for always collapsed, false for never collapsed, or a string representing indicating when the content should collapse ('lg' is the default).
      • fluid has been dropped.
      • container is a new option (bool, default is false) to indicate if the content of the navbar should be wrapped inside a <div class="container"></div>.
      • inverse has been dropped.
    • a new theme option has been added to the create() method to control, possible values are 'light', 'dark', false (no theme), or an array [$theme, $bg].
    • when adding a link() to an inner menu, the $linkOptions parameters is not usable anymore and the $options parameters should be used directly (their are no wrapping <li> anymore for inner menu).

The full plugin documentation is available at https://cakephp-bootstrap.github.io/cakephp3-bootstrap-helpers/.

Table of version and requirements

Version Bootstrap version CakePHP version Information
master 3 >= 3.7.0 Current active V3 branch.
4.0.3 4 >= 3.7.0 Current active V4 branch.
4.0.2 4 >= 3.7.0 Latest V4 release.
3.1.4 3 >= 3.7.0 Open issue(s) if necessary.
<= 3.1.2 3 < 3.4.0 Deprecated.

Contributing

Do not hesitate to post a github issue or submit a pull request if you find a bug or want a new feature.

Who is using it?

Non-exhaustive list of projects using these helpers, if you want to be in this list, do not hesitate to email me or post a comment on this issue.

Copyright and license

The MIT License (MIT)

Copyright (c) 2013-2020, Mikaël Capelle.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

See LICENSE.