Bootstrap 5 Components icon
Module Id
bootstrap5-components
Group Id
org.jahiacommunity.modules
Updated
Requires Jahia
8.2.0.0
Author
pvollenweider
Category
Templating and extensions
Status
COMMUNITY info

Bootstrap 5 Components group_work

templates bootstrap layout

This project is a Bootstrap 5 implementation of http://getbootstrap.com for the Digital Experience Platform.

This module contains all the modules, definitions, views, and logic.

Get the full documentation on the GitHub page https://github.com/Jahia/bootstrap5

List of Components and Documentation

The Bootstrap 5 components module provides a comprehensive list of components that allows you to utilize Bootstrap 5 effortlessly. The logic and syntax are handled automatically.

  • Accordions This component enables you to create vertically collapsing accordions using the Bootstrap Collapse JavaScript plugin. 
  • Breadcrumb Indicate the current page's location within a navigational hierarchy, automatically adding separators via CSS. 
  • Button This versatile component allows you to create buttons with various styles, sizes, and functionalities. 
  • Card Bootstrap's cards provide flexible and extensible content containers with multiple variants and options. They can include headers, footers, different content types, contextual background colors, and more.
  • Carousel A slideshow component for cycling through elements, such as images or slides of text, like a carousel
  • Figure and Images Whenever you need to display content, such as an image with an optional caption, consider using the figure component
  • Layout and Grid Bootstrap's grid system uses containers, rows, and columns to create flexible and responsive layouts. It is built with flexbox and adapts to different screen sizes. 
  • Navbar The navbar component provides simple navigation for your site, including sign-in options, language switching, and more. 
  • Pagination Indicate the existence of a series of related content across multiple pages. 
  • Tabs and Pills Tabs and pills are navigation components that enhance website clarity and improve user experience.
  • Text This component provides Bootstrap styles and CK templates. 
  • Version Displays an alert during edit mode with the version of Bootstrap being used.

Dependencies & Dependants

Changelog 2.4.0

Compatibility Notice

  • This version requires Jahia 8.2 or higher.
  • All dependencies on Spring Framework have been removed to simplify the codebase and eliminate unused dependencies.

New Features

  • Enhanced Navbar Customization
  • Introduced two new configurable properties:
    • liClass: defines the CSS class for each <li> item in the navbar (default: nav-item).
    • navLinkClass: defines the CSS class for each <a> link in the navbar (default: nav-link).
  • These properties are available through the bootstrap5mix:customizeNavbar mixin and supported in both JSP and Groovy-based views.
  • Improved CKEditor Integration
  • Added “Remove Format” button to clear inline formatting.
  • Introduced a custom “Wash” button to clean up pasted HTML (e.g., from MS Word), removing unnecessary tags and styles.
  • Integrated purify.min.js and beautify-html.min.js to sanitize and beautify content.

Enhancements

  • Refactored navbar.basenav-multilevel.groovy
  • Simplified rendering logic with reusable helper methods.
  • Improved readability and maintainability of the recursive menu generation.
  • Enhanced support for jnt:pagejnt:nodeLink, and jnt:externalLink menu items.
  • Security & Compatibility
  • Added a safety check in ckconfig.js to prevent errors when accessing combo_inlinestyles if the UI component is not present in CKEditor.

Documentation

  • Updated docs/navbar.md to describe the new customizable navbar properties.
  • Updated docs/text.md and replaced text.png to reflect the new CKEditor toolbar with format-cleaning options.

 

FAQ

If you find any issue of if you want to propose some improvement, please use the dedicated tools from the developer page https://github.com/Jahia/bootstrap5

How To Install

The easiest way to install Bootstrap 5 on your platform using the package.
But you can also install only this module directly. Please read the dedicated tutorial on https://academy.jahia.com/training-kb/tutorials/administrators/installing-a-module and select the Bootstrap 5 Component module from the store.

 

License

MIT License

Copyright 2020 Philippe Vollenweider

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.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.