Skip to main content

Bootstrap 3 Jumbotron element for django-fluent-contents

Project description

fluentcms-jumbotron

https://img.shields.io/travis/edoburu/fluentcms-jumbotron/master.svg?branch=master https://img.shields.io/pypi/v/fluentcms-jumbotron.svg https://img.shields.io/badge/wheel-yes-green.svg https://img.shields.io/pypi/l/fluentcms-jumbotron.svg https://img.shields.io/codecov/c/github/edoburu/fluentcms-jumbotron/master.svg

Displaying a Bootstrap 3 Jumbotron in a page

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install fluentcms-jumbotron

First make sure the project is configured for django-fluent-contents.

Then add the following settings:

INSTALLED_APPS += (
    'fluentcms_jumbotron',
)

FLUENT_CONTENTS_PLACEHOLDER_CONFIG = {
    'slot name': {
        'plugins': ('JumbotronPlugin', ...),
    },
}

The database tables can be created afterwards:

./manage.py migrate

Frontend styling

The jumbotron is rendered with the HTML that Bootstrap prescribes:

<div class="jumbotron">
  <h1>Hello, world!</h1>
  <p>...</p>
  <p><a class="btn btn-primary btn-lg" href="#" role="button">Learn more</a></p>
</div>

The standard Bootstrap 3 CSS will provide a reasonable styling for this, which can either be overwritten, or replaced in your own CSS files. The defaults provided by Bootstap 3 is: https://github.com/twbs/bootstrap-sass/blob/master/assets/stylesheets/bootstrap/_jumbotron.scss

Customizing

Centering, adding backgrounds, etc.. all happen by adding CSS styling. For example:

.jumbotron {
  background: url('/static/frontend/images/background.jpg') no-repeat fixed 0 0;
  background-size: cover;
  color: #fff;
  text-align: center;
}

.jumbotron .btn {
  margin-top: 12px;  /* For Sass: $padding-base-vertical * 2; */
}

When you use Sass, you can also override the Sass variables.

Full page width

To display the Bootstrap Jumbotron full page, you likely need to break out of the container the JumbotronPlugin is rendered in. For example, when your page looks like:

<div class="container">
    {% page_placeholder "homepage" title="Homepage" role="m" %}
</div>

You can change that into:

<div class="container">
    {% page_placeholder "homepage" title="Homepage" role="m" template="pages/placeholders/homepage.html" cachable=1 %}
</div>

The pages/placeholders/homepage.html template looks like:

{% for contentitem, html in contentitems %}
  {% if contentitem.plugin.name == 'JumbotronPlugin' %}
    </div>
    {{ html }}
    <div class="container">
  {% else %}
    {{ html }}
  {% endif %}
{% endfor %}

Note the exact HTML tags depend on your frontend HTML layout.

The cachable=1 flag is a promise that the template always returns the same result for every request. Otherwise, remove it.

Contributing

If you like this module, forked it, or would like to improve it, please let us know! Pull requests are welcome too. :-)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fluentcms-jumbotron-2.0.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

fluentcms_jumbotron-2.0-py2.py3-none-any.whl (12.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fluentcms-jumbotron-2.0.tar.gz.

File metadata

File hashes

Hashes for fluentcms-jumbotron-2.0.tar.gz
Algorithm Hash digest
SHA256 69fb4fcef075f626e547c29ebee6db68dc44e3c2e4c9cdd97df4f8660c432e81
MD5 5aad731475260b14e1a96d66eb7e02b2
BLAKE2b-256 c3304d52848f733347b387c83704ebb9dfa41836f5704f9f42baff811c435c67

See more details on using hashes here.

File details

Details for the file fluentcms_jumbotron-2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fluentcms_jumbotron-2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1eb450560c101fa0f63fdd3bf17b10b7d1ee9834afc3aae1a66a1b278811a572
MD5 1e673d5f5bbc5fd4af761b8f665012e3
BLAKE2b-256 04445b052baa0d865ee56979b28543154a2614e5fc7ecbabc7deaa9e60a70dd5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page