Module reahl.web.bootstrap.navs
A Bootstrap “Nav” is a navigation menu: a list of items that are
links to other Views. Navs can also have a second level so that if you
click on an item, a dropdown list of vertically stacked options
appear.
This module contains the necessary Widgets and Layouts to create and
style Bootstrap Navs.
Changed in version 4.0: Moved Menu here from reahl.web.ui.
Changed in version 4.0: Removed the .add_item and add_submenu methods in favour of .add_a,.add_bookmark,.add_dropdown methods.
Nav
-
class reahl.web.bootstrap.navs.Nav(view)
Bases: Menu
A Nav is a navigation menu, with items a user can click on to transition to
possibly different Views. Individual Items visually indicate whether they
are active or disabled.
- Parameters:
view – (See Widget)
-
query_fields
Used to declare the arguments of this Widget on its class.
Override this class attribute to declare arguments this Widget, each described
by a Field.
When constructed, the Widget uses the names and validation details of each Field to
parse values for its arguments from the current query string. The resultant
argument values are set as attributes on this Widget (with names matching the argument names).
To declare arguments on your own Widget class, assign a ExposedNames instance to query_fields
and then assign a single-argument callable for each Widget argument to it. This callable
will be called with the Widget instance as argument, and should return a
Field describing it:
class MyWidget(Widget):
query_fields = ExposedNames()
query_fields.my_argument = lambda i: Field()
Changed in version 6.1: This used to be set up using a method using an exposed decorator.
-
add_dropdown(title, dropdown_menu, drop_position='down', query_arguments={})
Adds the dropdown_menu DropdownMenu to this Nav. It appears as the
top-level item with text title.
- Parameters:
drop_position – Position relative to the item where the dropdown should appear (‘up’, ‘down’, ‘left’ or ‘right’).
query_arguments – (For internal use)
PillLayout
-
class reahl.web.bootstrap.navs.PillLayout(stacked=False, content_alignment=None, content_justification=None)
Bases: NavLayout
This Layout makes a Nav appear as horizontally or vertically arranged pills (buttons).
- Parameters:
stacked – If True, the pills are stacked vertically.
content_alignment – If given, changes how content is aligned inside the Nav (default is start)
(One of: center, end)
content_justification – If given, makes the content take up all space in the Nav. Either with elements having equal space (fill), or unequal space (justified)
(One of: fill, justified)
-
customise_widget()
Override this method in subclasses to allow your Layout to change its Widget upon construction.
There is no need to call super(), as the superclass implementation does nothing.
TabLayout
-
class reahl.web.bootstrap.navs.TabLayout(content_alignment=None, content_justification=None)
Bases: NavLayout
This Layout makes a Nav appear as horizontal tabs.
- Parameters:
content_alignment – If given, changes how content is aligned inside the Nav (default is start)
(One of: center, end)
content_justification – If given, makes the content take up all space in the Nav. Either with elements having equal space (fill), or unequal space (justified)
(One of: fill, justified)
