README

This is a plugin wrapper for adding Bootstrap to a Craft CMS site.

Credit for the Bootstrap library belongs to the Bootstrap team.

⚠️ The Bootstrap plugin for Craft CMS is no longer being maintained. It will be retired when Craft 4 is released.

✉️ If you are interested in taking ownership of this repo, please contact us.

Automatically Loads Bootstrap

Once you've installed the plugin, the Bootstrap CSS and JS files will immediately be loaded into the front-end of your site. If you don't want them to be included on every page, you can disable auto-loading on the Settings page.

If you've disabled auto-loading, you can have Bootstrap load only on the pages where you need it:

{% useBootstrap %}

It doesn't matter where on the page you add that tag... the Bootstrap assets will be loaded as long as it exists somewhere in your Twig template.

In the rare case where you may want to load the assets via PHP, that's possible too:

Bootstrap::$plugin->useBootstrap();

Make sure your custom CSS and/or JS loads last

You'll probably want Bootstrap (and/or jQuery) to finish loading before you run any additional JS. Here's how to ensure your custom resources get loaded last...

{% do view.registerCssFile(url('path/to/styles.css'), {'depends': bootstrapAssets}) %}
{% do view.registerJsFile(url('path/to/script.js'), {'depends': bootstrapAssets}) %}

This tells Craft that your files depend on the Bootstrap assets to be loaded first.

bootstrapAssets is a variable which gets loaded automatically. It's simply the path Craft needs to locate the Bootstrap assets.

Uses a CDN in production

To lighten the load, this plugin will switch to loading Bootstrap via a CDN when it runs in a production environment.

If you don't want this feature, or if your production environment uses a name other than production, you can control those details on the Settings page.

Settings

Anything else?

We've got other plugins too!

Check out the full catalog at doublesecretagency.com/plugins

doublesecretagency / craft-bootstrap

Maintainers

Details