FlaskBB is a simple and extensible forum software for building communities.

Table of Contents

• Display
  • Navigation

Related Topics

• Documentation Overview
  • API
    • Previous: Deprecation Helpers
    • Next: Settings

Quick Search

Display

FlaskBB exposes a handful of helpers for building dynamic content to be rendered into templates.

Navigation

class flaskbb.display.navigation.NavigationContentType

Content type enum for navigation items.

link = 0

external_link = 1

header = 2

divider = 3

class flaskbb.display.navigation.NavigationItem

Abstract NavigationItem class. Not meant for use but provides the common interface for navigation items.

class flaskbb.display.navigation.NavigationLink(endpoint, name, icon='', active=False, urlforkwargs=NOTHING)

Representation of an internal FlaskBB navigation link:

NavigationLink(
    endpoint="user.profile",
    name="{}'s Profile".format(user.username),
    icon="fa fa-home",
    active=False,  # default
    urlforkwargs={"username": user.username}
)

class flaskbb.display.navigation.NavigationExternalLink(uri, name, icon='')

Representation of an external navigation link:

NavigationExternalLink(
    uri="mailto:{}".format(user.email),
    name="Email {}".format(user.username),
    icon="fa fa-at"
)

class flaskbb.display.navigation.NavigationHeader(text, icon='')

Representation of header text shown in a navigation bar:

NavigationHeader(
    text="A header",
    icon="fa fa-exclamation"
)

class flaskbb.display.navigation.NavigationDivider

Representation of a divider in a navigation bar:

NavigationDivider()