# {py:mod}`django_simple_nav.nav`

```{py:module} django_simple_nav.nav
```

```{autodoc2-docstring} django_simple_nav.nav
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`NavItemContext <django_simple_nav.nav.NavItemContext>`
  - ```{autodoc2-docstring} django_simple_nav.nav.NavItemContext
    :summary:
    ```
* - {py:obj}`Nav <django_simple_nav.nav.Nav>`
  - ```{autodoc2-docstring} django_simple_nav.nav.Nav
    :summary:
    ```
* - {py:obj}`NavItem <django_simple_nav.nav.NavItem>`
  - ```{autodoc2-docstring} django_simple_nav.nav.NavItem
    :summary:
    ```
* - {py:obj}`NavGroup <django_simple_nav.nav.NavGroup>`
  - ```{autodoc2-docstring} django_simple_nav.nav.NavGroup
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_build_renderable_context <django_simple_nav.nav._build_renderable_context>`
  - ```{autodoc2-docstring} django_simple_nav.nav._build_renderable_context
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`logger <django_simple_nav.nav.logger>`
  - ```{autodoc2-docstring} django_simple_nav.nav.logger
    :summary:
    ```
* - {py:obj}`USER_ATTRIBUTE_PERMISSIONS <django_simple_nav.nav.USER_ATTRIBUTE_PERMISSIONS>`
  - ```{autodoc2-docstring} django_simple_nav.nav.USER_ATTRIBUTE_PERMISSIONS
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: django_simple_nav.nav.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} django_simple_nav.nav.logger
```

````

````{py:data} USER_ATTRIBUTE_PERMISSIONS
:canonical: django_simple_nav.nav.USER_ATTRIBUTE_PERMISSIONS
:value: >
   'frozenset(...)'

```{autodoc2-docstring} django_simple_nav.nav.USER_ATTRIBUTE_PERMISSIONS
```

````

`````{py:class} NavItemContext(data: dict[str, object], *, nav_item: django_simple_nav.nav.NavGroup | django_simple_nav.nav.NavItem | None = None, request: django.http.HttpRequest | None = None)
:canonical: django_simple_nav.nav.NavItemContext

Bases: {py:obj}`dict`

```{autodoc2-docstring} django_simple_nav.nav.NavItemContext
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_simple_nav.nav.NavItemContext.__init__
```

````{py:method} __str__() -> str
:canonical: django_simple_nav.nav.NavItemContext.__str__

````

````{py:method} __html__() -> str
:canonical: django_simple_nav.nav.NavItemContext.__html__

```{autodoc2-docstring} django_simple_nav.nav.NavItemContext.__html__
```

````

````{py:method} _render() -> str
:canonical: django_simple_nav.nav.NavItemContext._render

```{autodoc2-docstring} django_simple_nav.nav.NavItemContext._render
```

````

`````

````{py:function} _build_renderable_context(item: NavGroup | NavItem, request: django.http.HttpRequest) -> django_simple_nav.nav.NavItemContext
:canonical: django_simple_nav.nav._build_renderable_context

```{autodoc2-docstring} django_simple_nav.nav._build_renderable_context
```
````

`````{py:class} Nav(*, template_name: str | None = None, items: list[django_simple_nav.nav.NavGroup | django_simple_nav.nav.NavItem] | None = None)
:canonical: django_simple_nav.nav.Nav

```{autodoc2-docstring} django_simple_nav.nav.Nav
```

```{rubric} Initialization
```

```{autodoc2-docstring} django_simple_nav.nav.Nav.__init__
```

````{py:attribute} template_name
:canonical: django_simple_nav.nav.Nav.template_name
:type: str | None
:value: >
   'field(...)'

```{autodoc2-docstring} django_simple_nav.nav.Nav.template_name
```

````

````{py:attribute} items
:canonical: django_simple_nav.nav.Nav.items
:type: list[NavGroup | NavItem] | None
:value: >
   'field(...)'

```{autodoc2-docstring} django_simple_nav.nav.Nav.items
```

````

````{py:method} render(request: django.http.HttpRequest, template_name: str | None = None) -> str
:canonical: django_simple_nav.nav.Nav.render

```{autodoc2-docstring} django_simple_nav.nav.Nav.render
```

````

````{py:method} get_context_data(request: django.http.HttpRequest) -> dict[str, object]
:canonical: django_simple_nav.nav.Nav.get_context_data

```{autodoc2-docstring} django_simple_nav.nav.Nav.get_context_data
```

````

````{py:method} get_items(request: django.http.HttpRequest) -> list[django_simple_nav.nav.NavGroup | django_simple_nav.nav.NavItem]
:canonical: django_simple_nav.nav.Nav.get_items

```{autodoc2-docstring} django_simple_nav.nav.Nav.get_items
```

````

````{py:method} get_template(template_name: str | None = None) -> django_simple_nav._typing.EngineTemplate
:canonical: django_simple_nav.nav.Nav.get_template

```{autodoc2-docstring} django_simple_nav.nav.Nav.get_template
```

````

````{py:method} get_template_name() -> str
:canonical: django_simple_nav.nav.Nav.get_template_name

```{autodoc2-docstring} django_simple_nav.nav.Nav.get_template_name
```

````

`````

`````{py:class} NavItem
:canonical: django_simple_nav.nav.NavItem

```{autodoc2-docstring} django_simple_nav.nav.NavItem
```

````{py:attribute} title
:canonical: django_simple_nav.nav.NavItem.title
:type: str
:value: >
   None

```{autodoc2-docstring} django_simple_nav.nav.NavItem.title
```

````

````{py:attribute} url
:canonical: django_simple_nav.nav.NavItem.url
:type: str | collections.abc.Callable[..., str] | django.utils.functional.Promise | None
:value: >
   None

```{autodoc2-docstring} django_simple_nav.nav.NavItem.url
```

````

````{py:attribute} permissions
:canonical: django_simple_nav.nav.NavItem.permissions
:type: list[str | collections.abc.Callable[[django.http.HttpRequest], bool]]
:value: >
   'field(...)'

```{autodoc2-docstring} django_simple_nav.nav.NavItem.permissions
```

````

````{py:attribute} extra_context
:canonical: django_simple_nav.nav.NavItem.extra_context
:type: dict[str, object]
:value: >
   'field(...)'

```{autodoc2-docstring} django_simple_nav.nav.NavItem.extra_context
```

````

````{py:attribute} append_slash
:canonical: django_simple_nav.nav.NavItem.append_slash
:type: bool | None
:value: >
   None

```{autodoc2-docstring} django_simple_nav.nav.NavItem.append_slash
```

````

````{py:attribute} template_name
:canonical: django_simple_nav.nav.NavItem.template_name
:type: str | None
:value: >
   None

```{autodoc2-docstring} django_simple_nav.nav.NavItem.template_name
```

````

````{py:method} get_context_data(request: django.http.HttpRequest) -> dict[str, object]
:canonical: django_simple_nav.nav.NavItem.get_context_data

```{autodoc2-docstring} django_simple_nav.nav.NavItem.get_context_data
```

````

````{py:method} get_template_name() -> str
:canonical: django_simple_nav.nav.NavItem.get_template_name

```{autodoc2-docstring} django_simple_nav.nav.NavItem.get_template_name
```

````

````{py:method} render(request: django.http.HttpRequest) -> str
:canonical: django_simple_nav.nav.NavItem.render

```{autodoc2-docstring} django_simple_nav.nav.NavItem.render
```

````

````{py:method} get_title() -> str
:canonical: django_simple_nav.nav.NavItem.get_title

```{autodoc2-docstring} django_simple_nav.nav.NavItem.get_title
```

````

````{py:method} get_url() -> str
:canonical: django_simple_nav.nav.NavItem.get_url

```{autodoc2-docstring} django_simple_nav.nav.NavItem.get_url
```

````

````{py:method} get_active(request: django.http.HttpRequest) -> bool
:canonical: django_simple_nav.nav.NavItem.get_active

```{autodoc2-docstring} django_simple_nav.nav.NavItem.get_active
```

````

````{py:method} get_items(request: django.http.HttpRequest) -> list[django_simple_nav.nav.NavGroup | django_simple_nav.nav.NavItem] | None
:canonical: django_simple_nav.nav.NavItem.get_items

```{autodoc2-docstring} django_simple_nav.nav.NavItem.get_items
```

````

````{py:method} check_permissions(request: django.http.HttpRequest) -> bool
:canonical: django_simple_nav.nav.NavItem.check_permissions

```{autodoc2-docstring} django_simple_nav.nav.NavItem.check_permissions
```

````

`````

`````{py:class} NavGroup
:canonical: django_simple_nav.nav.NavGroup

Bases: {py:obj}`django_simple_nav.nav.NavItem`

```{autodoc2-docstring} django_simple_nav.nav.NavGroup
```

````{py:attribute} items
:canonical: django_simple_nav.nav.NavGroup.items
:type: list[django_simple_nav.nav.NavGroup | django_simple_nav.nav.NavItem]
:value: >
   'field(...)'

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.items
```

````

````{py:method} get_template_name() -> str
:canonical: django_simple_nav.nav.NavGroup.get_template_name

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.get_template_name
```

````

````{py:method} get_context_data(request: django.http.HttpRequest) -> dict[str, object]
:canonical: django_simple_nav.nav.NavGroup.get_context_data

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.get_context_data
```

````

````{py:method} get_items(request: django.http.HttpRequest) -> list[django_simple_nav.nav.NavGroup | django_simple_nav.nav.NavItem]
:canonical: django_simple_nav.nav.NavGroup.get_items

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.get_items
```

````

````{py:method} get_url() -> str
:canonical: django_simple_nav.nav.NavGroup.get_url

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.get_url
```

````

````{py:method} get_active(request: django.http.HttpRequest) -> bool
:canonical: django_simple_nav.nav.NavGroup.get_active

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.get_active
```

````

````{py:method} check_permissions(request: django.http.HttpRequest) -> bool
:canonical: django_simple_nav.nav.NavGroup.check_permissions

```{autodoc2-docstring} django_simple_nav.nav.NavGroup.check_permissions
```

````

`````