edc-navbar

|pypi| |actions| |codecov| |downloads|

edc_navbar

Simple Navbar class for edc

Installation

Include edc_navbar.apps.AppConfig in INSTALLED_APPS.

Overiew

Navbars are declared in your apps navbars.py and will be autodiscovered by edc_navbar and stored in the site global site_navbars.

By default, a basic navbar is added to the site global. For it to load you need to define the named urls for home_url, administration_url and logout_url in your main project urls.py. The named urls defined in the default navbar do not include a namespace.

For example, in the "main" project app urls.py:

.. code-block:: python

urlpatterns = [
    ...
    path('login', LoginView.as_view(), name='login_url'),
    path('logout', LogoutView.as_view(
        pattern_name='login_url'), name='logout_url'),
    path('admininistration/', AdministrationView.as_view(),
         name='administration_url'),
    path('', HomeView.as_view(manual_revision='1.0'), name='home_url'),
    ...
    ]

You can change the default navbar to another navbar by setting settings.DEFAULT_NAVBAR to the name of your custom navbar. You will need to declare and register your custom navbar manually. See edc_navbar.navbars.

The default template for NavbarItem is navbar_item.html. You can declare a custom template on the NavbarItem.

Render the Navbar

For example, in base.html:

.. code-block:: python

{% load edc_dashboard_extras %}

...

{% show_edc_navbar %}

...

The rendered html comes from edc_navbar.html

Declaring and registering a navbar

A navbar is defined and registered to the site global in the navbars.py module of each app that needs a navbar.

An example navbars.py:

.. code-block:: python

from edc_navbar import NavbarItem, site_navbars, Navbar

url_namespace = 'edc_pharmacy_dashboard'

# instantiate a Navbar
pharmacy_dashboard = Navbar(name='pharmacy_dashboard')

# add items to the navbar
pharmacy_dashboard.register(
    NavbarItem(
        name='prescribe',
        title='Prescribe',
        label='prescribe',
        glyphicon='glyphicon-edit',
        url_name=f'{url_namespace}:prescribe_listboard_url'))

pharmacy_dashboard.register(
    NavbarItem(
        name='dispense',
        title='Dispense',
        label='dispense',
        glyphicon='glyphicon-share',
        url_name=f'{url_namespace}:dispense_listboard_url'))

# register the navbar to the site
site_navbars.register(pharmacy_dashboard)

Accessing the navbar in your views

Next, add NavbarViewMixin to your views and set the navbar by name. The navbar will be rendered to string and added to the view context.

.. code-block:: python

from edc_navbar import NavbarViewMixin

class HomeView(EdcViewMixin, NavbarViewMixin, TemplateView):

    navbar_name = 'pharmacy_dashboard'
    navbar_selected_item = 'prescribe'

Rendering Navbar items

The default template for NavbarItem is navbar_item.html. You can declare a custom template on the NavbarItem.

Permissions per NavbarItem

Each NavbarItem can declare a Django permissions codename. The codename will be associated with model edc_navbar.navbar.

For example:

.. code-block:: python

from edc_navbar import NavbarItem, site_navbars, Navbar

url_namespace = 'edc_pharmacy_dashboard'

# instantiate a Navbar
pharmacy_dashboard = Navbar(name='pharmacy_dashboard')

# add items to the navbar
pharmacy_dashboard.register(
    NavbarItem(
        name='prescribe',
        title='Prescribe',
        label='prescribe',
        glyphicon='glyphicon-edit',
        permissions_codename='nav_pharmacy_prescribe',
        url_name=f'{url_namespace}:prescribe_listboard_url'))

pharmacy_dashboard.register(
    NavbarItem(
        name='dispense',
        title='Dispense',
        label='dispense',
        glyphicon='glyphicon-share',
        permissions_codename='nav_pharmacy_dispense',
        url_name=f'{url_namespace}:dispense_listboard_url'))

# register the navbar to the site
site_navbars.register(pharmacy_dashboard)

From the above, you can reference edc_navbar.nav_pharmacy_prescribe and edc_navbar.nav_pharmacy_dispense in your code.

.. code-block:: python

{% if perms.edc_navbar.nav_pharmacy_dispense %}
    href="some_url"
{% else%}
    disabled
{% endif %}

See also:

• https://github.com/clinicedc/edc-auth
• https://docs.djangoproject.com/en/2.1/topics/auth

.. |pypi| image:: https://img.shields.io/pypi/v/edc-navbar.svg :target: https://pypi.python.org/pypi/edc-navbar

.. |actions| image:: https://github.com/clinicedc/edc-navbar/actions/workflows/build.yml/badge.svg :target: https://github.com/clinicedc/edc-navbar/actions/workflows/build.yml

.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-navbar/branch/develop/graph/badge.svg :target: https://codecov.io/gh/clinicedc/edc-navbar

.. |downloads| image:: https://pepy.tech/badge/edc-navbar :target: https://pepy.tech/project/edc-navbar