Skip to content

Latest commit

 

History

History
47 lines (35 loc) · 1.44 KB

breadcrumbs.md

File metadata and controls

47 lines (35 loc) · 1.44 KB

Breadcrumbs

It is important to refrence the bootstrap documentation for how alerts work. This is how to include breadcrumbs in your code

Note: This component requires you to send data to the template from context

Examples

Add any one of the the following in your code, to show an alert

    {% include 'bootstrap_components/breadcrumb.html' with crumbs=crumbs_from_context %}
    {% include 'bootstrap_components/breadcrumb.html' with crumbs=crumbs_from_context separator=">" %}
    {% include 'bootstrap_components/breadcrumb.html' with crumbs=crumbs_from_context separator="|" active_crumb=1 %}

Here is an example of what the crumbs context should look like:

CRUMBS = (('home', reverse('index')),
          ('blog', reverse('blog:posts')),
          ('post', reverse('blog:post', args=[post_id]))
        )

Which look like this:

breadcrumbs-demo

Arguments

  • Required: content

    • adds text in the middle of the badge
    • string
  • seperator

    • Changes the separator between elements; default: /
    • accepts any normal character and the following symbols:
      • <, >, |
    • string
  • Required: crumbs

    • Accepts a tuple or list from context that has the structure [(<breadcrumb-text>, <breadcrumb-link>), ...]
    • tuple or list
  • active_crumb

    • Enter the index number starting from zero of which breadcrumb is active, by default it is the last one
    • int