marcanuy / django-dynamic-breadcrumbs

Django app to generate HTML breadcrumbs from URL paths

django-dynamic-breadcrumbs

django-dynamic-breadcrumbs is a Django app to generate HTML breadcrumbs dynamically from URL paths.

At https://example.com/reference/instrument/guitar/, shows: Home > Reference > Instrument > Guitar.

Quick start

1. Install

pip install django-dynamic-breadcrumbs

2. Add to settings

Add "dynamic_breadcrumbs" label to your INSTALLED_APPS settings:

INSTALLED_APPS = [
    ...
    'dynamic_breadcrumbs',
]

Add dynamic_breadcrumbs.context_processors.breadcrumbs to context_processors:

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "DIRS": [os.path.join(BASE_DIR, "templates")],
        "APP_DIRS": True,
        "OPTIONS": {
            "context_processors": [
				#...
                "dynamic_breadcrumbs.context_processors.breadcrumbs",
            ],
        },
    },
]

3. Add template

Include the dynamic_breadcrumbs/breadcrumbs.html in your base template.

{% if breadcrumbs %}
<div class="container">
    {% include "dynamic_breadcrumbs/breadcrumbs.html" with breadcrumbs=breadcrumbs%}
</div>
{% endif %}

Now each time you visit a page which makes use of the above template, it will have the breadcrumbs generated from the URL path.

4. (Optional) Customization

Tweak default settings.

Example site

There is an example site to see how it works at example_site. To run it, in example_site directory:

1. Create db: python manage.py migrate
2. Load fixtures python manage.py loaddata fixtures.json
3. Run the server python manage.py runserver

Note: Fixtures were created with a sample database with ./manage.py dumpdata --all --format json -o fixtures.json.

Documentation

Full docs at: https://django-dynamic-breadcrumbs.readthedocs.io/

License

MIT

django-dynamic-breadcrumbs's Issues

Works fine, but formatting is being ignored.

Works fine, but the following def function is being ignored

def remove_dashes(self): page_name = str(item) return self.page_name.replace('-',' ')

Working fine, but instead of showing name of page, the breadcrumb shows the slug of the page

It works fine, but its showing the slug not the page title.

Any idea what may have cause this?

~Cheers

is there simplest way to remove "alert alert-success" ?

What can be the simplest way to remove "alert alert-success" of the line:

 <ol class="breadcrumb alert alert-success" itemprop="breadcrumb" itemscope itemtype="https://schema.org/BreadcrumbList">

thanks

Change the default html file

Hello!

I am using the dynamic_breadcrumbs in my django project and I like how easy it made it. However I would like to change some styling settings in the dynamic_breadcrumbs/breadcrumbs.html file. Is there a way to override some CSS in it?

Appreciate it
Fadi

Added app verbose_name support

Added some code to show the APP verbose_name instead of the pure app name from the url.
Would be glad if you could implement this change.

Thanks Werner

Pull Request #2

Question about BreadcrumbsItem.get_name

Hi Marcelo,

Thank you for sharing this clever implementation. Of all the breadcrumb implementations I have found so far, yours is by far the simplest to understand and set up and the only one that will allow me to create breadcrumbs of deeply nested re_paths like orgs > 4 > assets > 5 > systems > 5 > components.

I am trying to understand what you were trying to do with the get_name method of the BreadcrumbsItem class. It seemed like it might be a way to address issue #5 but I did not see a way.

produces an empty item at home path