Package s3 :: Module s3widgets :: Class ICON

Class ICON

??-306 --+
         |
        ICON

Helper class to render <i> tags for icons, mapping abstract icon names to theme-specific CSS classes. The standard icon set can be configured using settings.ui.icons

e.g. ICON("book"), gives:

font-awesome: <i class="icon icon-book">
foundation: <i class="fi-book">

Standard sets are defined below.

Additional icons (beyond the standard set) can be configured per deployment (settings.ui.custom_icons).

If <i class=""> is not suitable for the CSS, a custom HTML layout can be configured as settings.ui.icon_layout. See S3Config for more details.

To Do:

apply in widgets/crud/profile+datalist layouts etc.
better abstract names for the icons to indicate what they symbolize rather than what they depict, e.g. "sitemap" is typically used to symbolize an organisation => rename into "organisation".

Instance Methods

__init__(self, name, **attr)
Constructor

source code

xml(self)
Render this instance as XML

source code

Class Methods

css_class(cls, name)

source code

Class Variables
	icons = `{"font-awesome": {"_base": "fa", "active": "fa-check",...`

Method Details

init(self, name, **attr)
(Constructor)

source code

Constructor

Parameters:

name - the abstract icon name
attr - additional HTML attributes (optional)

xml(self)

source code

Render this instance as XML

css_class(cls, name)
Class Method

source code

Class Variable Details

icons

Value:

{"font-awesome": {"_base": "fa", "active": "fa-check", "activity": "fa
-cogs", "add": "fa-plus", "administration": "fa-cog", "alert": "fa-bel
l", "arrow-down": "fa-arrow-down", "assessment": "fa-bar-chart", "asse
t": "fa-fire-extinguisher", "attachment": "fa-paperclip", "bar-chart":
 "fa-bar-chart", "book": "fa-book", "bookmark": "fa-bookmark", "bookma
rk-empty": "fa-bookmark-o", "briefcase": "fa-briefcase", "calendar": "
fa-calendar", "caret-right": "fa-caret-right", "certificate": "fa-cert
ificate", "comment-alt": "fa-comment-o", "commit": "fa-check-square-o"
...

Class ICON

__init__(self, name, **attr) (Constructor)

xml(self)

css_class(cls, name) Class Method

icons

init(self, name, **attr)
(Constructor)

css_class(cls, name)
Class Method