Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/django-crispy-forms/crispy-bootstrap5
Bootstrap5 template pack for django-crispy-forms
https://github.com/django-crispy-forms/crispy-bootstrap5
Last synced: 7 days ago
JSON representation
Bootstrap5 template pack for django-crispy-forms
- Host: GitHub
- URL: https://github.com/django-crispy-forms/crispy-bootstrap5
- Owner: django-crispy-forms
- License: mit
- Created: 2020-11-08T20:36:46.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-05T12:07:16.000Z (13 days ago)
- Last Synced: 2024-10-05T12:49:27.158Z (13 days ago)
- Language: HTML
- Size: 193 KB
- Stars: 455
- Watchers: 9
- Forks: 72
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- stars - django-crispy-forms/crispy-bootstrap5 - Bootstrap5 template pack for django-crispy-forms (HTML)
- stars - django-crispy-forms/crispy-bootstrap5 - Bootstrap5 template pack for django-crispy-forms (HTML)
README
# crispy-bootstrap5
[](https://github.com/smithdc1/crispy-bootstrap5/blob/main/LICENSE)
Bootstrap5 template pack for django-crispy-forms
## Installation
Install this plugin using `pip`:
```bash
$ pip install crispy-bootstrap5
```
## Usage
You will need to update your project's settings file to add ``crispy_forms``
and ``crispy_bootstrap5`` to your projects ``INSTALLED_APPS``. Also set
``bootstrap5`` as and allowed template pack and as the default template pack
for your project
```python
INSTALLED_APPS = (
...
"crispy_forms",
"crispy_bootstrap5",
...
)
CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"
CRISPY_TEMPLATE_PACK = "bootstrap5"
```
## What's new?
Bootstrap 5 introduces [floating labels](https://getbootstrap.com/docs/5.0/forms/floating-labels/).
This template pack include a layout object to use this input type
```python
from crispy_bootstrap5.bootstrap5 import FloatingField
# then in your Layout
... Layout(
FloatingField("first_name"),
)
```
Accordions also have new features, such as [Accordion flush](https://getbootstrap.com/docs/5.0/components/accordion/#flush) and [Always open](https://getbootstrap.com/docs/5.0/components/accordion/#always-open).
There is a new layout object to use them
```python
from crispy_bootstrap5.bootstrap5 import BS5Accordion
# then in your Layout
# if not informed, flush and always_open default to False
... Layout(
BS5Accordion(
AccordionGroup("group name", "form_field_1", "form_field_2"),
AccordionGroup("another group name", "form_field"),
flush=True,
always_open=True
)
)
```
Support is added for [Switches](https://getbootstrap.com/docs/5.2/forms/checks-radios/#switches). Switches are a custom
checkbox rendered as a toggle switch. The widget for these fields should be
a [CheckboxInput](https://docs.djangoproject.com/en/4.2/ref/forms/widgets/#django.forms.CheckboxInput).
```python
from crispy_bootstrap5.bootstrap5 import Switch
... Layout(Switch("is_company"))
```
## Development
To contribute to this library, first checkout the code. Then create a new virtual environment:
```bash
cd crispy-bootstrap5
python -m venv venv
source venv/bin/activate
```
Or if you are using `pipenv`:
```bash
pipenv shell
```
Now install the dependencies and tests:
```bash
pip install -e '.[test]'
```
To run the tests:
```bash
pytest
```