AdminLTE v2.4 Release Notes and Upgrade Guide

AdminLTE v2.4 Release Notes and Upgrade Guide

We are excited to announce that we just released AdminLTE 2.4 Beta. This version's main purpose is to provide a better developer experience and provide a good segue to v3. In this post, we are going to discuss the big changes and how they affect our users.

Complete Rewrite of JavaScript

Although the old code worked fine and supported all major browsers, it was not entirely friendly to developers and contributors. The new code is entirely modular and provides an intuitive API to users. All of the plugins now provide data attributes support so they can be activated and customized simply by using [data-option="value"] HTML attributes. AdminLTE also supports jQuery noConflict mode, which has been requested several times by multiple users.

Support NPM and Bower

This new version of AdminLTE also provides support to the most popular front-end package management tools NPM and Bower. Except for a handful of plugins that do not provide a fully compiled and usable version when installed with a package manager, most of the external plugins can be install simply by running bower install or npm install. The rest of the plugins are still available in the plugins folder.

This, however, makes direct downloading of AdminLTE a little more difficult to users who do not want to use Bower or NPM. Therefore, we decided to upload the bower_components folder to our GitHub repository and have NPM and Bower ignore the folder. This will make the downloadable work out of the box without having to learn a new tool if you are not up to it.

Rewritten Documentation

We have also rewritten the documentation (work in progress) to be more reader friendly. It now provides separate pages for each plugin to make it easier to search and access. It also supports per version documentation so users who don't upgrade immediately can find the documentation that supports their current implementation.

Upgrading to Version 2.4

To take full advantage of the new modular design of the JS code, we had to make a few changes to the users API. We did our best to keep the upgrade process as simple as possible and provided a step-by-step guide the documentation. Follow the steps lists in the upgrade guide and start utilizing the new features today.

Final Thoughts

AdminLTE 2.4 is still in beta stages and we plan to release the stable version as soon as we complete the documentation and get some of the bugs worked out. If you do encounter an issue or simply have a question, please don't hesitate to post an issue on our GitHub repository issues tracker.

Any comments and suggests are welcome below.