Navbar¶
NavBarLinkItem¶
-
class
django_propeller.navbar.
NavBarLinkItem
(name='', url=None, icon=None)¶ Generates a Link navbar item or a Link DropDown item.
Parameters:
- name
- The display name for the item. (for example: ‘Home’)
- url
- The address for the link item. Can be a absolute URL or a resolvable Django url. (for example: ‘http://example.org‘ or ‘home’). Optional.
- icon
- not yet supported
NavBarDropDownDivider¶
-
class
django_propeller.navbar.
NavBarDropDownDivider
¶ Generates a DropDown Divider item.
NavBarDropDownItem¶
-
class
django_propeller.navbar.
NavBarDropDownItem
(name='', items=None, url=None)¶ Generates a DropDown navbar item.
Parameters:
- name
- The display name for the item. (for example: ‘Home’)
- url
- The address for the link item. Can be a absolute URL or a resolvable Django url. (for example: ‘http://example.org‘ or ‘home’). Optional.
- icon
- not yet supported
- items
- A list containing NavBarLinkItems and/or NavBarDropDownDivider. Optional.
NavBar¶
-
class
django_propeller.navbar.
NavBar
¶ NavBar is a class that generates a NavBar.
Parameters:
- brandname
- The brand shown on the very left of the navbar.
- brandurl
- The address for the brand name. Can be a absolute URL or a resolvable Django url. (for example: ‘http://example.org‘ or ‘home’). Optional.
- items
- A list containing NavBarLinkItems and/or NavBarDropDownItems. Optional.
- style_inverse
- Generate a dark navbar if true (default) or a light navbar if false.
- style_static
- Sets the static style for the navbar. Static if true (default) or floating on top if false.
NavBar Example¶
navbar.py:
from django_propeller.navbar import NavBar, NavBarLinkItem, NavBarDropDownItem, NavBarDropDownDivider
class DemoNavBar(NavBar):
brandname = "Brand"
brandurl = "http://example.org"
items = [
NavBarLinkItem("Link"),
NavBarDropDownItem("DropDown", [
NavBarLinkItem("Action"),
NavBarLinkItem("Another action"),
NavBarDropDownDivider(),
NavBarLinkItem("Separated link"),
NavBarDropDownDivider(),
NavBarLinkItem("One more separated link"),
])
]
your_view.py:
from django.views.generic.base import TemplateView
from django_propeller.views import NavBarMixin
from your_project.navbar import DemoNavBar
class HomePageView(TemplateView, NavBarMixin):
template_name = 'your_template.html'
navbar_class = DemoNavBar
your_template.html:
{% load propeller %}
{% propeller_navbar navbar %}