class NavigationItem

Bases: object

Base for all items in a Navigation.

Every item inside a navigational view should derive from this class.

active = False

Indicates whether or not the item represents the currently active route

render(renderer=None, **kwargs)

Render the navigational item using a renderer.

Parameters:

renderer – An object implementing the Renderer interface.

Returns:

A markupsafe string with the rendered result.

class Link(text, dest)

Bases: NavigationItem

An item that contains a link to a destination and a title.

get_url()

Returns the URL to the destination.

class RawTag(content, **attribs)

Bases: NavigationItem

An item usually expressed by a single HTML tag.

Parameters:

• title – The text inside the tag.

• attribs – Attributes on the item.

class View(text, endpoint, **kwargs)

Bases: Link

Application-internal link.

The endpoint, *args and **kwargs are passed on to url_for() to get the link.

Parameters:

• text – The text for the link.

• endpoint – The name of the view.

• kwargs – Extra keyword arguments for url_for()

ignore_query = True

By default, query arguments are ignored.”””

get_url()

Return url for this item.

Returns:

A string with a link.

property active

Return True it view is active.

class Separator

Bases: NavigationItem

Separator.

A seperator inside the main navigational menu or a Subgroup. Not all renderers render these (or sometimes only inside Subgroups).

class Subgroup(title, *items)

Bases: NavigationItem

Nested substructure.

Usually used to express a submenu.

Parameters:

• title – The title to display (i.e. when using dropdown-menus, this text will be on the button).

• items – Any number of NavigationItem instances that make up the navigation element.

property active

Return True if any element is currently active.

class Text(text)

Bases: NavigationItem

Label text.

Not a <label> text, but a text label nonetheless. Precise representation is up to the renderer, but most likely something like <span>, <div> or similar.

class Navbar(title, *items)

Bases: Subgroup

Top level navbar.

class Renderer

Bases: Visitor

Base interface for navigation renderers.

Visiting a node should return a string or an object that converts to a string containing HTML.

visit_object(node)

Fallback rendering for objects.

If the current application is in debug-mode (flask.current_app.debug is True), an <!-- HTML comment --> will be rendered, indicating which class is missing a visitation function.

Outside of debug-mode, returns an empty string.

class SimpleRenderer(**kwargs)

Bases: Renderer

A very basic HTML5 renderer.

Renders a navigational structure using <nav> and <ul> tags that can be styled using modern CSS.

Parameters:

kwargs – Additional attributes to pass on to the root <nav>-tag.

visit_Link(node)

Returns arefs matching url.

visit_Navbar(node)

Returns navbar classes.

visit_View(node)

Returns arefs.

visit_Subgroup(node)

Returns subgroup divs.

visit_Separator(node)

Returns separator hrs.

visit_Text(node)

Returns nav-label spans.

class BootStrap5Renderer(**kwargs)

Bases: Renderer

A very basic Bootstrap 5 renderer.

Renders a navigational structure using <nav> and <ul> tags that can be styled using modern CSS.

Parameters:

kwargs – Additional attributes to pass on to the root <nav>-tag.

visit_Link(node)

Returns arefs matching url.

visit_Navbar(node)

Returns navbar classes.

visit_View(node)

Returns arefs.

visit_Subgroup(node)

Returns subgroup divs.

visit_Separator(node)

Returns separator hrs.

visit_Text(node)

Returns nav-label spans.