New in version 3.2.
This module houses stylised versions of very basic user interface elements – user interface elements that have a one-to-one correspondence to HTML elements (or are of similar simplicity).
reahl.web.bootstrap.ui.HTML5Page(view, title='$current_title', css_id=None)¶A web page that may be used as the page of a web application. It ensures that everything needed by the framework (linked CSS and JavaScript, etc) is available on such a page.
Styling
Renders as an HTML5 page with customised <head> and an empty <body>.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Slot(view, name)¶A Slot is a placeholder area on a page into which different Views can plug different Widgets on the fly.
Using Slots, one can create a single HTML5page which can be re-used by different Views instead of having to create similar-looking HTML5Pages for each View in an application.
A Slot is added to an HTML5Page to represent an area that will be populated later by a View. When a View is served up the framework can then populate this empty area with Widgets specific to the current View.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.RunningOnBadge(view)¶A visual badge proclaiming that a website is “Running on Reahl”. Using it on your site is a bit of advertising for Reahl!
Styling
Renders as an HTML <a class=”runningon”> containing an <img>
| Parameters: | view – (See reahl.web.fw.Widget) |
|---|
reahl.web.bootstrap.ui.TextNode(view, value_or_getter, html_escape=True)¶An HTML TextNode. You can, for example, use a TextNode to add a snippet of text as a child of a P inbetween its other children (which will all be HTMLElements, like Span).
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Title(view, text, css_id=None)¶The title of an HTML page (the title of a reahl.web.fw.View is usually shown via a Title).
Styling
Rendered as a <title> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Link(view, rel, href, _type=None, css_id=None)¶A link to an external resource.
Styling
Renders as an HTML <link> element.
| Parameters: |
|
|---|
Changed in version 3.2: Changed _type to be an optional, keyword argument instead of a positional argument.
reahl.web.bootstrap.ui.Head(view, title, css_id=None)¶A container for metadata of a View.
Styling
Renders as an HTML <head> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Body(view, css_id=None)¶The content of an HTML document.
Styling
Renders as an HTML <body> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Span(view, text=None, html_escape=True, css_id=None)¶A logical grouping of other HTMLElements which fits in with text flow.
Styling
Renders as an HTML <span> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.LiteralHTML(view, contents, transform=<function LiteralHTML.<lambda>>)¶The LiteralHTML Widget renders a chunk of HTML as given in contents. If a single-argument callable is given as transform, contents will first be passed to that callable to possibly change the HTML on-the-fly before rendering (the callable should return the changed HTML to be rendered).
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.A(view, href, description=None, ajax=False, read_check=None, write_check=None, css_id=None)¶A hyper link.
Styling
Renders as an HTML <a> element.
| Parameters: |
|
|---|
from_bookmark(view, bookmark)¶Creates an A for the given bookmark on view.
factory_from_bookmark(bookmark)¶Creates a reahl.web.fw.WidgetFactory for creating an A for the given bookmark.
set_active(active)¶Explicitly sets whether this hyperlink is “active” or not. An active hyperlink cannot be clicked on, because conceptually, the user is already at its target.
| Parameters: | active – A boolean – send True if active, else False. |
|---|
reahl.web.bootstrap.ui.H(view, priority, text=None, css_id=None)¶The heading for a section.
Styling
Renders as an HTML <h1>, <h2> ... , <h6> element, depending on priority.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.P(view, text=None, css_id=None, html_escape=True)¶A paragraph of text.
Styling
Renders as an HTML <p> element.
| Parameters: |
|
|---|
format(*args, **kwargs)¶A complicated paragraph may consist of many TextNodes interspersed with other Widgets. Creating such a
paragraph programmatically is cumbersome. Instead, the text of a P can be a template resembling
a PEP-292 template. This format method works analogously to
string.format(), except that Widgets can be passed in to be substituted into the original P.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Div(view, css_id=None)¶A logical grouping of other HTMLElements.
Styling
Renders as an HTML <div> element
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Article(view, css_id=None)¶An independent section of informational content.
Styling
Renders as an HTML <article> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Header(view, css_id=None)¶A grouping of elements representing metadata pertaining to a section, such as an Article.
Styling
Rendered as an HTML <article> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Li(view, css_id=None)¶A list item.
Styling
Renders as an HTML <li> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Ul(view, css_id=None)¶An unordered list.
Styling
Renders as an HTML <ul> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Ol(view, css_id=None)¶An ordered list.
Styling
Renders as an HTML <ol> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Img(view, src=None, alt=None, css_id=None)¶An embedded image.
Styling
Renders as an HTML <img> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Legend(view, text=None, css_id=None)¶A caption for an reahl.web.ui.HTMLElement.
Styling
Rendered as an HTML <legend> element.
| Parameters: |
|
|---|
reahl.web.bootstrap.ui.Alert(view, message, severity)¶A message box meant to alert the user of some message.
| Parameters: |
|
|---|