django CMS Bootstrap 5 (WIP)

django CMS Bootstrap 5 is a plugin bundle for django CMS providing several components from the popular Bootstrap 5 library.

Note

This project is endorsed by the django CMS Association. That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy. Join us on Slack.

Contributing

This is a an open-source project. We'll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

We're grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

One of the easiest contributions you can make is helping to translate this addon on Transifex.

Documentation

See REQUIREMENTS in the setup.py file for additional dependencies:

• Django Filer 1.7 or higher
• Django Text CKEditor 3.1 or higher

Make sure django Filer and django CMS Text CKEditor are installed and configured appropriately.

Installation

For a manual install:

• run pip install djangocms-bootstrap5

• add the following entries to your INSTALLED_APPS:

  'djangocms_icon',
  'djangocms_link',
  'djangocms_picture',
  'djangocms_bootstrap5',
  'djangocms_bootstrap5.contrib.bootstrap5_alerts',
  'djangocms_bootstrap5.contrib.bootstrap5_badge',
  'djangocms_bootstrap5.contrib.bootstrap5_card',
  'djangocms_bootstrap5.contrib.bootstrap5_carousel',
  'djangocms_bootstrap5.contrib.bootstrap5_collapse',
  'djangocms_bootstrap5.contrib.bootstrap5_content',
  'djangocms_bootstrap5.contrib.bootstrap5_grid',
  'djangocms_bootstrap5.contrib.bootstrap5_jumbotron',
  'djangocms_bootstrap5.contrib.bootstrap5_link',
  'djangocms_bootstrap5.contrib.bootstrap5_listgroup',
  'djangocms_bootstrap5.contrib.bootstrap5_media',
  'djangocms_bootstrap5.contrib.bootstrap5_picture',
  'djangocms_bootstrap5.contrib.bootstrap5_tabs',
  'djangocms_bootstrap5.contrib.bootstrap5_utilities',
  

• run python manage.py migrate

Configuration

django CMS Bootstrap 5 utilises the following django CMS plugins:

• django CMS Link: Link
• django CMS Picture: Picture
• django CMS Icon: Icon

It provides the following standard Bootstrap 5 components:

• Alerts
• Badge
• Card
• Carousel
• Collapse
• Content (Blockquote, Code, Figure)
• Grid (Container, Row, Column)
• Jumbotron
• Link / Button
• List group
• Media
• Picture / Image
• Tabs
• Utilities (Spacing)

django CMS Bootstrap 5 does not add the styles or javascript files to your frontend, these need to be added at your discretion.

Settings

There are various settings possible on django CMS Bootstrap 5, to restrict them for now only the following can be changed:

DJANGOCMS_BOOTSTRAP5_TAG_CHOICES = ['div', 'section', 'article', 'header', 'footer', 'aside']

DJANGOCMS_BOOTSTRAP5_CAROUSEL_TEMPLATES = (
    ('default', _('Default')),
)

DJANGOCMS_BOOTSTRAP5_GRID_SIZE = 12
DJANGOCMS_BOOTSTRAP5_GRID_CONTAINERS = (
    ('container', _('Container')),
    ('container-fluid', _('Fluid container')),
)
DJANGOCMS_BOOTSTRAP5_GRID_COLUMN_CHOICES = (
    ('col', _('Column')),
    ('w-100', _('Break')),
    ('', _('Empty'))
)

DJANGOCMS_BOOTSTRAP5_USE_ICONS = True

DJANGOCMS_BOOTSTRAP5_TAB_TEMPLATES = (
    ('default', _('Default')),
)

DJANGOCMS_BOOTSTRAP5_SPACER_SIZES = (
    ('0', '* 0'),
    ('1', '* .25'),
    ('2', '* .5'),
    ('3', '* 1'),
    ('4', '* 1.5'),
    ('5', '* 3'),
)

DJANGOCMS_BOOTSTRAP5_CAROUSEL_ASPECT_RATIOS = (
    (16, 9),
)

DJANGOCMS_BOOTSTRAP5_COLOR_STYLE_CHOICES = (
    ('primary', _('Primary')),
    ('secondary', _('Secondary')),
    ('success', _('Success')),
    ('danger', _('Danger')),
    ('warning', _('Warning')),
    ('info', _('Info')),
    ('light', _('Light')),
    ('dark', _('Dark')),
    ('custom', _('Custom')),
)

Please be aware that this package does not support djangocms-text-ckeditor's Drag & Drop Images so be sure to set TEXT_SAVE_IMAGE_FUNCTION = None.

Running Tests

You can run tests by executing:

virtualenv env
source env/bin/activate
pip install -r tests/requirements.txt
python setup.py test

To run the frontend make sure to use node 10.x.