Skip to main content

Bootstrap 3 Button element for django-fluent-contents

Project description

fluentcms-button

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

Displaying a Bootstrap 3 Button in text.

This button can be used for navigation, for example at the end of a text block.

These buttons can’t be used in forms.

Installation

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

pip install fluentcms-button

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

Then add the following settings:

INSTALLED_APPS += (
    'fluentcms_button',
)

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

The database tables can be created afterwards:

./manage.py migrate

Frontend styling

The button is rendered with the HTML that Bootstrap prescribes:

<a class="btn btn-default" href="#" role="button">Link</a>

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/_buttons.scss

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

Configuration

When desired, the following settings can be overwritten:

from django.utils.translation import pgettext_lazy

FLUENTCMS_BUTTON_STYLES = (
    ('btn-default', pgettext_lazy("button-style", u"Default")),
    ('btn-primary', pgettext_lazy("button-style", u"Primary")),
    ('btn-success', pgettext_lazy("button-style", u"Success")),
    ('btn-info', pgettext_lazy("button-style", u"Info")),
    ('btn-warning', pgettext_lazy("button-style", u"Warning")),
    ('btn-danger', pgettext_lazy("button-style", u"Danger")),
    ('btn-link', pgettext_lazy("button-style", u"Link")),
)

FLUENTCMS_BUTTON_SIZES = (
    ('', pgettext_lazy("button-size", u"Default")),
    ('btn-lg', pgettext_lazy("button-size", u"Large")),
    ('btn-sm', pgettext_lazy("button-size", u"Small")),
    ('btn-xs', pgettext_lazy("button-size", u"Extra Small")),
)

By default, the standard Bootstrap button classes are used. These can be redefined when the project uses other classes for the buttons.

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-button-2.0.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for fluentcms-button-2.0.tar.gz
Algorithm Hash digest
SHA256 cbdb8e78565aea8613ce99daa49bb5a6e300b4eb201c4752a275547e2c6bd1be
MD5 825ece9b04ebd387fc1ad6da4c30cc91
BLAKE2b-256 0414c7be831f381a157152b7dcd4c46de508b14fc40a14cf7b792b88d679b349

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fluentcms_button-2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 52bb69cfe09f2fcb1b19cf8afb7b9b3831c47e5a0341a3fab12827656a157f39
MD5 d9dccf78d959dea24f3caf376e3b42cb
BLAKE2b-256 cba436db6fce20920905fdbc200943242063a2df564bedb5e1e3081a166df34e

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