Socket
Socket
Sign inDemoInstall

fluentcms-button

Package Overview
Dependencies
1
Maintainers
1
Alerts
File Explorer

Install Socket

Detect and block malicious and high-risk dependencies

Install

    fluentcms-button

Bootstrap 3 Button element for django-fluent-contents


Maintainers
1

Readme

fluentcms-button

.. image:: https://github.com/django-fluent/fluentcms-button/actions/workflows/tests.yaml/badge.svg?branch=master :target: https://github.com/django-fluent/fluentcms-button/actions/workflows/tests.yaml .. image:: https://img.shields.io/pypi/v/fluentcms-button.svg :target: https://pypi.python.org/pypi/fluentcms-button/ .. image:: https://img.shields.io/badge/wheel-yes-green.svg :target: https://pypi.python.org/pypi/fluentcms-button/ .. image:: https://img.shields.io/pypi/l/fluentcms-button.svg :target: https://pypi.python.org/pypi/fluentcms-button/ .. image:: https://img.shields.io/codecov/c/github/django-fluent/fluentcms-button/master.svg :target: https://codecov.io/github/django-fluent/fluentcms-button?branch=master

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:

.. code-block:: bash

pip install fluentcms-button

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

Then add the following settings:

.. code-block:: python

INSTALLED_APPS += (
    'fluentcms_button',
)

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

The database tables can be created afterwards:

.. code-block:: bash

./manage.py migrate

Frontend styling

The button is rendered with the HTML that Bootstrap prescribes:

.. code-block:: html+django

<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:

.. code-block:: html+django

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. :-)

.. _django-fluent-contents: https://github.com/django-fluent/django-fluent-contents .. _Button: http://getbootstrap.com/css/#buttons

FAQs


Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc