Reference: Blueprints#

This page contains documentation for available blueprints registered in the factory. This list is auto-generated and contains documentation of the following packages:

  • yafowil (core package)

  • yafowil.widget.ace

  • yafowil.widget.array

  • yafowil.widget.autocomplete

  • yafowil.widget.chosen

  • yafowil.widget.cron

  • yafowil.widget.datetime

  • yafowil.widget.dict

  • yafowil.widget.dynatree

  • yafowil.widget.image

  • yafowil.widget.location

  • yafowil.widget.multiselect

  • yafowil.widget.recaptcha

  • yafowil.widget.richtext

  • yafowil.widget.select2

  • yafowil.widget.slider

  • yafowil.widget.wysihtml5

ace#

Add-on blueprint yafowil.widget.ace .

Properties

name

default

description
mode 'python'

ACE Mode.

Used by:
  • ace_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
theme 'github'

ACE Theme.

Used by:
  • ace_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  1. ace_edit_renderer

  1. ace_display_renderer

-/-

-/-

array#

Add-on widget yafowil.widget.array.

Properties

name

default

description
add True

Render add action.

Used by:
  • array_wrapper_renderer
class 'array'

Common CSS-class to put on.

Used by:
  • array_wrapper_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • array_wrapper_renderer
error_class 'error'

CSS-class to put on in case of error.

Used by:
  • array_wrapper_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • array_wrapper_renderer
remove True

Render remove action.

Used by:
  • array_wrapper_renderer
required False

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • array_wrapper_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • array_wrapper_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
sort True

Render move up and move down actions.

Used by:
  • array_wrapper_renderer
static False

Array is immutable. No Array actions are rendered. If True, add, remove and sort properties are ignored.

Used by:
  • array_wrapper_renderer
table_class None

CSS classes rendered on array table.

Used by:
  • array_wrapper_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. array_extractor

  2. generic_required_extractor

  1. array_edit_renderer

  2. compound_renderer

  3. array_wrapper_renderer

  1. array_display_renderer

  2. compound_renderer

-/-

  1. array_builder

autocomplete#

Add-on blueprint yafowil.widget.autocomplete utilizing jquery.ui.autocomplete to offer the user a selection based on the input given so far.

Properties

name

default

description
class 'autocomplete'

Common CSS-class to put on.

Used by:
  • input_generic_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_generic_renderer
delay '300'

Delay in milliseconds.

Used by:
  • autocomplete_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_generic_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_generic_renderer
minLength '1'

Minimum input length to trigger autocomplete.

Used by:
  • autocomplete_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • input_generic_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_generic_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
source required/ not set

Autocomplete source as python iterable or string defining JSON view callback.

Used by:
  • autocomplete_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. autocomplete_extractor

  1. input_generic_renderer

  2. autocomplete_renderer

-/-

-/-

-/-

checkbox#

Single checkbox blueprint.

Properties

name

default

description
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • checkbox_edit_renderer
checked None

Set ‘checked’ attribute explicit. If not given, compute by value.

Used by:
  • checkbox_edit_renderer
class 'checkbox'

Common CSS-class to put on.

Used by:
  • checkbox_edit_renderer
  • checkbox_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • checkbox_edit_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • checkbox_edit_renderer
disabled False

Flag whether checkbox is disabled.

Used by:
  • checkbox_edit_renderer
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • checkbox_display_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • checkbox_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • checkbox_edit_renderer
format 'bool'

Data-type of the extracted value. One out of bool or string.

Used by:
  • checkbox_extractor
  • checkbox_edit_renderer
  • checkbox_display_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • checkbox_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • checkbox_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
size None global

Allowed input size.

Used by:
  • checkbox_edit_renderer
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • checkbox_edit_renderer
vocabulary {True: 'Yes', False: 'No', <UNSET>: 'Unset'}

In display mode and if `bool` is set to `True` this mapping will be used for display of the value. Expected keys are `True`, `False` and `UNSET`.

Used by:
  • checkbox_display_renderer
with_label False

Render empty label tag after visible checkbox in order to make checkbox UI customizable via CSS like so:

input.large_checkbox {
    display: none;
}
input.large_checkbox + label {
    width: 59px;
    height: 60px;
    background: url('/checkbox_large.png');
}
input.large_checkbox:checked + label {
    background: url('/checkbox_large_selected.png');
}

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. checkbox_extractor

  2. generic_required_extractor

  1. checkbox_edit_renderer

  1. checkbox_display_renderer

-/-

-/-

chosen#

Add-on blueprint yafowil.widget.chosen .

Properties

name

default

description
allow_single_deselect None

Allow deselection of single elements.

Used by:
  • chosen_edit_renderer
class 'chosen'

Common CSS-class to put on.

Used by:
  • select_display_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • select_display_renderer
disable_search None

Disable search at all.

Used by:
  • chosen_edit_renderer
disable_search_threshold None

Disable the threshold, when the search popup opens.

Used by:
  • chosen_edit_renderer
disabled None global

Disables input.

Used by:
  • select_extractor
max_selected_options None

Maximum number of selected options.

Used by:
  • chosen_edit_renderer
multivalued False

Used by:
  • select_extractor
  • select_display_renderer
new_values None

Allow adding new values. For: yafowil js integration. Values: [True|False|None (default)].

Used by:
  • chosen_edit_renderer
no_results_text None

Text for no results.

Used by:
  • chosen_edit_renderer
placeholder_text None

Placeholder text.

Used by:
  • chosen_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
search_contains None

Search also for substrings. Allowed values [True|False|None]. When using None or just not setting this value, the default of the Javascript widget is used.

Used by:
  • chosen_edit_renderer
single_backstroke_delete None

A single backstroke deletes the selected option.

Used by:
  • chosen_edit_renderer
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • select_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. select_extractor

  2. generic_required_extractor

  1. chosen_edit_renderer

  1. select_display_renderer

-/-

-/-

compound#

A blueprint to create a compound of widgets. This blueprint creates a node. A node can contain sub-widgets.

Properties

name

default

description
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  1. compound_renderer

-/-

-/-

cron#

Add-on blueprint yafowil.widget.cron .

Properties

name

default

description
class 'crontab widget'

CSS classes for cron widget wrapper DOM element.
emptyvalue required/ not set

If cron rule value empty, return as extracted value.

Used by:
  • cron_extractor
lang None

End year. Defaults to current year + 9
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. cron_extractor

  2. generic_required_extractor

  1. cron_edit_renderer

  2. compound_renderer

  1. cron_display_renderer

-/-

-/-

datetime#

Add-on blueprint yafowil.widget.datetime .

Properties

name

default

description
class 'datetime'

Common CSS-class to put on.

Used by:
  • datetime_edit_renderer
  • datetime_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • datetime_edit_renderer
dateinput_class 'dateinput'

CSS class rendered on date input field.
datepicker False

Flag whether date picker is enabled.

Used by:
  • datetime_edit_renderer
datepicker_class 'datepicker'

Flag whether date picker is enabled.

Used by:
  • datetime_edit_renderer
delimiter '.'

Delimiter used to render date in input field.

delimiter may be a callable taking widget and data as parameters expect to return a delimiter string.

Used by:
  • datetime_edit_renderer
disabled False

Disables input.

Used by:
  • datetime_edit_renderer
empty_display_value None

Value to display if no datetime value set. Used if widget mode is display.
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • datetime_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • datetime_edit_renderer
format '%Y.%m.%d %H:%M'

Pattern accepted by datetime.strftime or callable taking widget and data as parameters returning unicode or utf-8 string. Used if widget mode is display.

Used by:
  • datetime_display_renderer
locale 'iso'

Date input format locale. yafowil.widget.datetime uses bda.intellidatetime for input parsing. Take a look at this package for available locales.

locale may be a callable taking widget and data as parameters expect to return a locale string.

Used by:
  • datetime_extractor
  • datetime_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
  • datetime_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • datetime_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • datetime_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
time False

Flag whether time input should be rendered.

time may be a callable taking widget and data as parameters expect to return a boolean.

Used by:
  • datetime_extractor
  • datetime_edit_renderer
timeinput_class 'timeinput'

CSS class rendered on time input field.
timepicker False

Flag whether time picker is enabled.

Used by:
  • datetime_edit_renderer
timepicker_class 'timepicker'

jquery.ui timepicker binds to this class.

Used by:
  • datetime_edit_renderer
tzinfo None

Python datetime tzinfo object.

tzinfo may be a callable taking widget and data as parameters expect to return a tzinfo instance.

Used by:
  • datetime_extractor
unset_display_value required/ not set

Used by:
  • datetime_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. datetime_extractor

  4. generic_emptyvalue_extractor

  1. datetime_edit_renderer

  1. datetime_display_renderer

-/-

-/-

dict#

Add-on widget yafowil.widget.dict.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • dict_edit_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • dict_edit_renderer
error_class 'error'

CSS-class to put on in case of error.

Used by:
  • dict_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • dict_edit_renderer
head {}

B/C Labels for dict keys and values columns. Expect a dict containing key and value keys.

Used by:
  • dict_edit_renderer
  • dict_display_renderer
key_class 'keyfield'

CSS classes rendered on key input fields.

Used by:
  • dict_edit_renderer
key_label <UNSET>

Label for dict keys column.

Used by:
  • dict_edit_renderer
  • dict_display_renderer
required False global

Whether this value is required or not.

Used by:
  • static_dict_required_extractor
  • generic_required_extractor
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • dict_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • dict_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
static False

Flag whether dict is immutable.

Used by:
  • dict_extractor
  • static_dict_required_extractor
  • dict_edit_renderer
table_class 'dictwidget'

CSS classes rendered on dict table.

Used by:
  • dict_edit_renderer
value_class 'valuefield'

CSS classes rendered on value input fields.

Used by:
  • dict_edit_renderer
value_label <UNSET>

Label for dict values column.

Used by:
  • dict_edit_renderer
  • dict_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. dict_extractor

  2. static_dict_required_extractor

  3. generic_required_extractor

  1. dict_edit_renderer

  2. compound_renderer

  1. dict_display_renderer

-/-

-/-

div#

Blueprint rendering a ‘<div>’ element.

This is a hybrid blueprint. Check leaf property for details.

Properties

name

default

description
class None

CSS classes for div tag.

Used by:
  • div_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • div_renderer
data None

Dict containing data attributes for div tag.
error_class None global

CSS-class to put on in case of error.

Used by:
  • div_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • div_renderer
id None

Id attribute for div tag.

Used by:
  • div_renderer
leaf None global

Leaf property can be used in conjunction with hybrid_extractor and hybrid_renderer using blueprints in order to mark compound widgets as leaf.

If set True, it causes bypassing auto delegation of extraction and rendering to compound_renderer respective compound_extractor if widget contains children.

This is useful if mixing blueprints which renders and handles compounds on it’s own with blueprints using hybrid rendering and extraction in order to prevent side effects due to multiple child rendering and extraction.

Used by:
  • hybrid_extractor
  • hybrid_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • div_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • div_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. hybrid_extractor

  1. hybrid_renderer

  2. div_renderer

  1. hybrid_renderer

  2. div_renderer

-/-

-/-

email#

Email (HTML5) input blueprint.

Properties

name

default

description
allowed_datatypes [<class 'bytes'>, <class 'str'>]

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
class 'email'

Common CSS-class to put on.

Used by:
  • input_generic_renderer
  • generic_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_generic_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • generic_datatype_extractor
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_generic_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_generic_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • input_generic_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_generic_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • generic_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  4. generic_datatype_extractor

  5. email_extractor

  1. input_generic_renderer

  1. generic_display_renderer

  2. display_proxy_renderer

-/-

-/-

error#

Renders a tag with an error-message and the prior rendered output.

Properties

name

default

description
class 'error'

Common CSS-class to put on.

Used by:
  • error_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • error_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • error_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • error_renderer
message_class 'errormessage'

CSS class to apply to inner message-tag.

Used by:
  • error_renderer
message_tag 'div'

HTML tag to use to enclose each error message.

Used by:
  • error_renderer
position 'inner-before'

Error can be rendered at 3 different positions: before/ after the prior rendered output or with inner-before/ inner-after it puts the prior rendered output inside the tag used for the error message (beofre or after the message.

Used by:
  • error_renderer
render_empty False

Render tag even if there is no error message.

Used by:
  • error_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • error_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • error_renderer
tag 'div'

HTML tag to use to enclose all error messages.

Used by:
  • error_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. error_renderer

  1. empty_display_renderer

-/-

-/-

field#

Renders a div with an class field around the prior rendered output. This is supposed to be used for styling and grouping purposes.

Properties

name

default

description
class 'field'

Common CSS-class to put on.

Used by:
  • field_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • field_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • field_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • field_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • field_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • field_renderer
witherror None

Put the class given with this property on the div if an error happened.

Used by:
  • field_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. field_renderer

  1. field_renderer

-/-

-/-

fieldset#

Renders a fieldset around the prior rendered output.

Properties

name

default

description
class None

Common CSS-class to put on.

Used by:
  • fieldset_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • fieldset_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • fieldset_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • fieldset_renderer
legend False

Content of legend tag if legend should be rendered.

Used by:
  • fieldset_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • fieldset_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • fieldset_renderer
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  2. fieldset_renderer

  1. compound_renderer

  2. fieldset_renderer

-/-

-/-

file#

A basic file upload blueprint.

Properties

name

default

description
accept None

Accepted mimetype.

Used by:
  • input_file_edit_renderer
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • input_file_edit_renderer
class None global

Common CSS-class to put on.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • input_file_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
  • input_file_edit_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. file_extractor

  2. generic_required_extractor

  1. input_file_edit_renderer

  2. file_options_renderer

  1. input_file_display_renderer

-/-

-/-

form#

A html-form element as a compound of widgets.

Properties

name

default

description
action required/ not set

Target web address (URL) to send the form to.

Used by:
  • form_edit_renderer
class None global

Common CSS-class to put on.

Used by:
  • form_edit_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • form_edit_renderer
enctype 'multipart/form-data'

Encryption type of the form. Only relevant for method post. Expect one out of application/x-www-form-urlencoded or multipart/form-data.

Used by:
  • form_edit_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • form_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • form_edit_renderer
method 'post'

One out of get or post.

Used by:
  • form_edit_renderer
novalidate True

Flag whether HTML5 form validation should be suppressed.

Used by:
  • form_edit_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • form_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • form_edit_renderer
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  2. form_edit_renderer

  1. compound_renderer

  2. form_display_renderer

-/-

-/-

help#

Renders a tag with an help-message and the prior rendered output.

Properties

name

default

description
class 'help'

Common CSS-class to put on.

Used by:
  • help_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • help_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • help_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • help_renderer
help ''

Help text.

Used by:
  • help_renderer
position 'before'

Help can be rendered at 3 different positions: before/ after the prior rendered output or with inner-before/ inner-after it puts the prior rendered output inside the tag used for the help message (beofre or after the message.

Used by:
  • help_renderer
render_empty False

Render tag even if there is no help message.

Used by:
  • help_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • help_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • help_renderer
tag 'div'

HTML tag to use to enclose all help messages.

Used by:
  • help_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. help_renderer

  1. empty_display_renderer

-/-

-/-

hidden#

Hidden input blueprint.

Properties

name

default

description
allowed_datatypes <UNSET> global

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
class 'hidden'

Common CSS-class to put on.

Used by:
  • input_generic_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_generic_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • generic_datatype_extractor
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_generic_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_generic_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • input_generic_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_generic_renderer
type 'hidden'

Type of input tag.

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_emptyvalue_extractor

  3. generic_datatype_extractor

  1. input_generic_renderer

  1. empty_display_renderer

-/-

-/-

image#

Add-on widget yafowil.widget.image.

Properties

name

default

description
accept 'image/*'

Accepted mimetype of image.

Used by:
  • mimetype_extractor
  • input_file_edit_renderer
alt ''

Image alternative text.

Used by:
  • image_edit_renderer
  • image_display_renderer
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • input_file_edit_renderer
class 'image'

Common CSS-class to put on.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
  • image_edit_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
  • image_edit_renderer
crop None

Crop extracted file to size at offset. The created cropped image gets placed in the return value returned by file extractor under key cropped. Crop definition is a dict containing:

size

(width, height), mandatory

offset

(left, top), defaults to (0, 0)

fitting

Boolean, ignores offset if True, scales image to smaller site of size and centers larger one.

Used by:
  • crop_extractor
error_class 'error'

CSS-class to put on in case of error.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
  • image_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
  • image_edit_renderer
maxdpi None

Maximum DPI of image defined as 2-tuple containing (x, y).

Used by:
  • dpi_extractor
maxsize None

Maximum size of image defined as 2-tuple containing (width, height) in pixel as integer.

Used by:
  • size_extractor
mindpi None

Minimum DPI of image defined as 2-tuple containing (x, y).

Used by:
  • dpi_extractor
minsize None

Minimum size of image defined as 2-tuple containing (width, height) in pixel as integer.

Used by:
  • size_extractor
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • input_file_edit_renderer
required False

Whether this value is required or not.

Used by:
  • generic_required_extractor
  • input_file_edit_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
  • image_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_file_edit_renderer
  • file_options_renderer
  • image_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
scales None

Scales to create on extraction. Scales are defined as dict, where the key represents the scale name and the value is a 2-tuple containing (width, height) in pixel. The created scales get placed in the return value returned by file extractor under key scales.

Used by:
  • scales_extractor
src None

Image URL if image present and displaying is desired.

Used by:
  • image_edit_renderer
  • image_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. file_extractor

  2. generic_required_extractor

  3. mimetype_extractor

  4. image_extractor

  5. size_extractor

  6. dpi_extractor

  7. scales_extractor

  8. crop_extractor

  1. input_file_edit_renderer

  2. file_options_renderer

  3. image_edit_renderer

  1. image_display_renderer

-/-

-/-

label#

Label blueprint.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • label_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • label_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • label_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • label_renderer
for None

Optional dottedpath of widget to be labled

Used by:
  • label_renderer
label required/ not set

Text to be displayed as a label.

Used by:
  • label_renderer
position 'before'

Label can be rendered at 3 different positions: before or after the prior rendered output or with inner it puts the prior rendered output inside the label tag.

Used by:
  • label_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • label_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • label_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. label_renderer

  1. label_renderer

-/-

-/-

lines#

Lines blueprint. Renders a textarea and extracts lines as list.

Properties

name

default

description
allowed_datatypes <UNSET> global

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • lines_edit_renderer
class 'lines'

Common CSS-class to put on.

Used by:
  • lines_edit_renderer
  • lines_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • lines_edit_renderer
cols 40

Number of characters.

Used by:
  • lines_edit_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • lines_edit_renderer
  • lines_display_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • generic_datatype_extractor
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
disabled None global

Disables input.

Used by:
  • lines_edit_renderer
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • lines_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • lines_edit_renderer
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • lines_edit_renderer
readonly None

Flag textarea is readonly.

Used by:
  • lines_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
  • lines_edit_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • lines_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • lines_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
rows 8

Number of lines.

Used by:
  • lines_edit_renderer
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • lines_edit_renderer
wrap None

Either soft, hard, virtual, physical or off.

Used by:
  • lines_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. lines_extractor

  4. generic_emptyvalue_extractor

  5. generic_datatype_extractor

  1. lines_edit_renderer

  1. lines_display_renderer

  2. display_proxy_renderer

-/-

-/-

location#

Add-on blueprint yafowil.widget.location

Properties

name

default

description
class 'location'

Common CSS-class to put on.

Used by:
  • location_edit_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • location_edit_renderer
error_class 'error'

CSS-class to put on in case of error.

Used by:
  • location_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • location_edit_renderer
lat 47.2667

Initial map center point latitude (north/south).

Used by:
  • location_edit_renderer
lon 11.3833

Initial map center point longitude (east/west).

Used by:
  • location_edit_renderer
min_zoom 2

Maximum map zoom level.
required False

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • location_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • location_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
zoom 12

Initial map zoom level.

Used by:
  • location_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. location_extractor

  2. generic_required_extractor

  1. location_edit_renderer

  1. location_display_renderer

-/-

-/-

multiselect#

Add-on blueprint yafowil.widget.multiselect .

Properties

name

default

description
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • select_edit_renderer
block_class required/ not set

Used by:
  • select_edit_renderer
class 'multiselect'

Common CSS-class to put on.

Used by:
  • select_edit_renderer
  • select_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • select_edit_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • select_edit_renderer
  • select_display_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • select_edit_renderer
disabled None global

Disables input.

Used by:
  • select_extractor
  • select_edit_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • select_edit_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • select_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • select_edit_renderer
format 'block'

Used by:
  • select_edit_renderer
label_checkbox_class required/ not set

Used by:
  • select_edit_renderer
label_radio_class required/ not set

Used by:
  • select_edit_renderer
listing_label_position required/ not set

Used by:
  • select_edit_renderer
listing_tag required/ not set

Used by:
  • select_edit_renderer
multivalued True

Used by:
  • select_extractor
  • select_edit_renderer
  • select_display_renderer
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • select_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • select_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • select_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
size None

Allowed input size.

Used by:
  • select_edit_renderer
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • select_display_renderer
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • select_edit_renderer
vocabulary required/ not set

Used by:
  • select_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. select_extractor

  2. generic_required_extractor

  1. select_edit_renderer

  1. select_display_renderer

-/-

-/-

number#

Number blueprint (HTML5).

Properties

name

default

description
allowed_datatypes [<class 'int'>, <class 'float'>, 'int', 'integer', 'float']

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
class 'number'

Common CSS-class to put on.

Used by:
  • input_generic_renderer
  • generic_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_generic_renderer
datatype <class 'float'>

Callable for converting extracted value to output datatype. Allowed datatypes are int and float

datatype can also be defined as string with value out of ‘int’`, 'integer' or 'float'.

Used by:
  • generic_datatype_extractor
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue <UNSET>

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_generic_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_generic_renderer
max None

Maximum value.

Used by:
  • number_extractor
min None

Minimum value.

Used by:
  • number_extractor
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • input_generic_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_generic_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
step None

Stepping value must be in.

Used by:
  • number_extractor
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • generic_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  4. generic_datatype_extractor

  5. number_extractor

  1. input_generic_renderer

  1. generic_display_renderer

  2. display_proxy_renderer

-/-

-/-

password#

Password blueprint.

The password is never rendered to markup, instead yafowil.common.PASSWORD_NOCHANGE_VALUE is set as value property on dom element. See yafowil.common.password_extractor for details on password extraction.

Properties

name

default

description
ascii False

Flag ascii check should performed.

Used by:
  • ascii_extractor
autocomplete None global

Switch autocomplete explizit to on or off.

Used by:
  • password_edit_renderer
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • password_edit_renderer
class 'password'

Common CSS-class to put on.

Used by:
  • password_edit_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • password_edit_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • password_edit_renderer
disabled None global

Disables input.

Used by:
  • password_edit_renderer
displayplaceholder '********'

Placeholder shown in display mode if password was set.

Used by:
  • password_display_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • password_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • password_edit_renderer
minlength -1

Minimum length of password.

Used by:
  • minlength_extractor
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • password_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • password_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • password_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
size None global

Maximum length of password.

Used by:
  • password_edit_renderer
strength -1

Integer value <= 4. Define how many rules must apply to consider a password valid.

Used by:
  • password_extractor
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • password_edit_renderer
weak_password_message 'Password too weak' global

Message shown if password is not strong enough.

Used by:
  • password_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  4. minlength_extractor

  5. ascii_extractor

  6. password_extractor

  1. password_edit_renderer

  1. password_display_renderer

-/-

-/-

proxy#

Bypass arguments out of form namespace using a hidden field.

Properties

name

default

description
allowed_datatypes <UNSET> global

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
class None

Common CSS-class to put on.

Used by:
  • input_proxy_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_proxy_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • generic_datatype_extractor
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_proxy_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_proxy_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • input_proxy_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_proxy_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_emptyvalue_extractor

  3. generic_datatype_extractor

  1. input_proxy_renderer

  1. empty_display_renderer

-/-

-/-

richtext#

Add-on blueprint yafowil.widget.richtext .

Properties

name

default

description
cols 80

Number of characters.
mimetypes ['text/html']

List of mimetypes.
mimetypes_class ''

CSS class to be set on mimetypes selection.
mimetypes_data {}

Dict containing data attributes to render on mimetypes selection.
readonly None

Flag for readonly.
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
rows 25

Number of lines.
wrap None

Either soft, hard, virtual, physical or off.

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  1. richtext_edit_renderer

  1. richtext_display_renderer

-/-

-/-

select#

Selection Blueprint. Single selection as dropdown or radio-buttons. Multiple selection as selection-list or as checkboxes.

Properties

name

default

description
allowed_datatypes <UNSET> global

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • select_edit_renderer
block_class None

CSS class to render on selection if block format.

Used by:
  • select_edit_renderer
checkbox_label_class None

CSS class to render on checkbox labels.
checkbox_wrapper_class None

CSS class to render on checkbox wrapper.
class 'select'

Common CSS-class to put on.

Used by:
  • select_edit_renderer
  • select_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • select_edit_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • select_edit_renderer
  • select_display_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • generic_datatype_extractor
  • select_edit_renderer
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
disabled None global

Disables the whole widget or single selections. To disable the whole widget set the value to ‘True’. To disable single selection pass a iterable of keys to disable, i.e. ['foo', 'baz']. Defaults to False.

Used by:
  • select_extractor
  • select_edit_renderer
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
  • select_edit_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • select_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • select_edit_renderer
format 'block'

Every value except ‘block’ results in either a list of radio buttons or checkboxes depending on the ‘multivalued’ property.

Used by:
  • select_edit_renderer
label_checkbox_class None

CSS class to render on checkbox labels.

This property is deprecated and will be remove as of yafowil 2.2. Use checkbox_label_class instead.

Used by:
  • select_edit_renderer
label_radio_class None

CSS class to render on radio button labels.

This property is deprecated and will be remove as of yafowil 2.2. Use radio_label_class instead.

Used by:
  • select_edit_renderer
listing_label_position 'inner-after'

Label position if format is ‘single’. Behaves the same way as label widget position property.

Used by:
  • select_edit_renderer
listing_tag 'div'

Desired rendering tag for selection if selection format is ‘single’. Valid values are ‘div’ and ‘ul’.

Used by:
  • select_edit_renderer
multivalued None

Flag whether multiple items can be selected.

Used by:
  • select_extractor
  • select_edit_renderer
  • select_display_renderer
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • select_edit_renderer
radio_label_class None

CSS class to render on radio button labels.
radio_wrapper_class None

CSS class to render on radio button wrapper.
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • select_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • select_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
size None

Size of input if multivalued and format ‘block’.

Used by:
  • select_edit_renderer
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • select_display_renderer
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • select_edit_renderer
vocabulary required/ not set

Vocabulary to be used for the selection list. Expects a dict-like or an iterable or a callable which returns one of both first. An iterable can consist out of strings or out of tuples with (key, value). The items in the result list are in the same order like the vocabulary.

Used by:
  • select_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. select_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  4. generic_datatype_extractor

  1. select_edit_renderer

  1. select_display_renderer

  2. display_proxy_renderer

-/-

-/-

select2#

Add-on blueprint yafowil.widget.select2

Integrates Select2 Widget

Detailed widget documentation

Properties

name

default

description
adaptContainerCssClass None

Function that filters/renames css classes as they are copied from the source tag to the select2 container tag:

adaptContainerCssClass(clazz)

The default implementation applies all classes without modification.

Used by:
  • select2_edit_renderer
adaptDropdownCssClass None

Function that filters/renames css classes as they are copied from the source tag to the select2 dropdown tag:

adaptDropdownCssClass(clazz)

The default implementation always returns null thereby filtering out all classes.

Used by:
  • select2_edit_renderer
ajax None

Options for the built in ajax query function. This object acts as a shortcut for having to manually write a function that performs ajax requests. The built-in function supports more advanced features such as throttling and dropping out-of-order responses.

In order for this function to work Select2 should be attached to a input type=’hidden’ tag instead of a select.

Used by:
  • select2_edit_renderer
ajaxurl None

Ajax URL to JSON view returning an array of objects like:

[{id: 'id', text: 'text'}]
Used by:
  • select2_edit_renderer
allowClear None

Whether or not a clear button is displayed when the select box has a selection. The button, when clicked, resets the value of the select box back to the placeholder, thus this option is only available when the placeholder is specified.

This option only works when the placeholder is specified.

When attached to a select an option with an empty value must be provided. This is the option that will be selected when the button is pressed since a select box requires at least one selection option.

Also, note that this option only works with non-multi-value based selects because multi-value selects always provide such a button for every selected option.

Used by:
  • select2_edit_renderer
closeOnSelect None

If set to false the dropdown is not closed after a selection is made, allowing for rapid selection of multiple items. By default this option is set to true.

Only applies when configured in multi-select mode.

Used by:
  • select2_edit_renderer
containerCss None

Inline css that will be added to select2’s container. Either an object containing css property/value key pairs or a function that returns such an object.

Used by:
  • select2_edit_renderer
containerCssClass None

Css class that will be added to select2’s container tag.

Used by:
  • select2_edit_renderer
createSearchChoice None

Creates a new selectable choice from user’s search term. Allows creation of choices not available via the query function. Useful when the user can create choices on the fly, eg for the ‘tagging’ usecase:

createSearchChoice(term)

If the function returns undefined or null no choice will be created. If a new choice is created it is displayed first in the selection list so that user may select it by simply pressing enter.

When used in combination with input[type=hidden] tag care must be taken to sanitize the id attribute of the choice object, especially stripping , as it is used as a value separator.

Used by:
  • select2_edit_renderer
createSearchChoicePosition None

Define the position where to insert element created by createSearchChoice. The following values are supported:

top

Insert in the top of the list

bottom

Insert at the end of the list

function

A custom function. For example if you want to insert the new item in the second position:

$("#tags").select2({
    ...
    createSearchChoice: function(term) { ... },
    createSearchChoicePosition: function(list, item) {
        list.splice(1, 0, item);
    }
});
Used by:
  • select2_edit_renderer
data None

Options for the built in query function that works with arrays.

If this element contains an array, each element in the array must contain id and text keys.

Alternatively, this element can be specified as an object in which results key must contain the data as an array and a text key can either be the name of the key in data items that contains text or a function that retrieves the text given a data element from the array.

Used by:
  • select2_edit_renderer
dropdownAutoWidth None

When set to true attempts to automatically size the width of the dropdown based on content inside.

Used by:
  • select2_edit_renderer
dropdownCss None

Inline css that will be added to select2’s dropdown container. Either an object containing css property/value key pairs or a function that returns such an object.

Used by:
  • select2_edit_renderer
dropdownCssClass None

Css class that will be added to select2’s dropdown container.

Used by:
  • select2_edit_renderer
escapeMarkup None

String escapeMarkup(String markup)

Function used to post-process markup returned from formatter functions. By default this function escapes html entities to prevent javascript injection.

Used by:
  • select2_edit_renderer
formatInputTooLong None

String containing “Search input too long” message, or Function used to render the message:

formatInputTooLong(term, maxLength)
Used by:
  • select2_edit_renderer
formatInputTooShort None

String containing “Search input too short” message, or Function used to render the message:

formatInputTooShort(term, minLength)
Used by:
  • select2_edit_renderer
formatLoadMore None

String containing “Loading more results” message, or Function used to render the message:

formatLoadMore(pageNumber)
Used by:
  • select2_edit_renderer
formatNoMatches None

String containing “No matches” message, or Function used to render the message:

formatNoMatches(term)
Used by:
  • select2_edit_renderer
formatResult None

Function used to render a result that the user can select:

formatResult(object, container, query)

The default implementation expects the object to have a text property that is returned.

The implementation may choose to append elements directly to the provided container object, or return a single value and have it automatically appended.

When attached to a select the original <option> (or <optgroup>) element is accessible inside the specified function through the property item.element:

format(item) {
    var originalOption = item.element;
    return item.text
}
Used by:
  • select2_edit_renderer
formatResultCssClass None

Function used to add css classes to result elements:

formatResultCssClass(object)

By default when attached to a select css classes from options will be automatically copied.

Used by:
  • select2_edit_renderer
formatSearching None

String containing “Searching…” message, or Function used to render the message that is displayed while search is in progress:

formatSearching()
Used by:
  • select2_edit_renderer
formatSelection None

Function used to render the current selection:

formatSelection(object, container)

The default implementation expects the object to have a text property that is returned.

The implementation may choose to append elements directly to the provided container object, or return a single value and have it automatically appended.

When attached to a select the original <option> (or <optgroup>) element is accessible inside the specified function through the property item.element:

format(item) {
    var originalOption = item.element;
    return item.text
}
Used by:
  • select2_edit_renderer
formatSelectionTooBig None

String containing “You cannot select any more choices” message, or Function used to render the message:

formatSelectionTooBig(maxSize)
Used by:
  • select2_edit_renderer
id None

Function used to get the id from the choice object or a string representing the key under which the id is stored:

id(object)

The default implementation expects the object to have a id property that is returned.

Used by:
  • select2_edit_renderer
initSelection None

Called when Select2 is created to allow the user to initialize the selection based on the value of the element select2 is attached to.

Essentially this is an id->object mapping function:

initSelection(element, callback)

This function will only be called when there is initial input to be processed.

Used by:
  • select2_edit_renderer
inputtag False

Render widget as input element instead of selection.

Used by:
  • select2_extractor
  • select2_edit_renderer
loadMorePadding None

Defines how many pixels need to be below the fold before the next page is loaded. The default value is 0 which means the result list needs to be scrolled all the way to the bottom for the next page of results to be loaded. This option can be used to trigger the load sooner, possibly resulting in a smoother user experience.

Used by:
  • select2_edit_renderer
matcher None

Used to determine whether or not the search term matches an option when a built-in query function is used. The built in query function is used when Select2 is attached to a select, or the local or tags helpers are used:

matcher(term, text, option)

The default implementation is case insensitive and matches anywhere in the term:

function(term, text) {
    return text.toUpperCase().indexOf(term.toUpperCase()) >= 0;
}
Used by:
  • select2_edit_renderer
maximumInputLength None

Maximum number of characters that can be entered for an input.

Used by:
  • select2_edit_renderer
maximumSelectionSize None

The maximum number of items that can be selected in a multi-select control. If this number is less than 1 selection is not limited.

Once the number of selected items reaches the maximum specified the contents of the dropdown will be populated by the formatSelectionTooBig function.

Used by:
  • select2_edit_renderer
minimumInputLength None

Number of characters necessary to start a search.

Used by:
  • select2_edit_renderer
minimumResultsForSearch None

The minimum number of results that must be initially (after opening the dropdown for the first time) populated in order to keep the search field. This is useful for cases where local data is used with just a few results, in which case the search box is not very useful and wastes screen space.

The option can be set to a negative value to permanently hide the search field.

Only applies to single-value select boxes.

Used by:
  • select2_edit_renderer
multiple None

Whether or not Select2 allows selection of multiple values.

When Select2 is attached to a select element this value will be ignored and select’s multiple attribute will be used instead.

Used by:
  • select2_edit_renderer
nextSearchTerm None

Function used to determine what the next search term should be.

Function can be used when the dropdown is configured in single and multi-select mode. It is triggered after selecting an item. In single mode it is also triggered after initSelection (when provided).

Used by:
  • select2_edit_renderer
openOnEnter None

If set to true the dropdown is opened when the user presses the enter key and Select2 is closed. By default this option is enabled.

Used by:
  • select2_edit_renderer
placeholder None

Initial value that is selected if no other selection is made.

The placeholder can also be specified as a data-placeholder attribute on the select or input element that Select2 is attached to.

Note that because browsers assume the first option element is selected in non-multi-value select boxes an empty first option element must be provided (<option></option>) for the placeholder to work.

Used by:
  • select2_edit_renderer
placeholderOption None

When attached to a select resolves the option that should be used as the placeholder. Can either be a function which given the select element should return the option element or a string first to indicate that the first option should be used.

This option is useful when Select2’s default of using the first option only if it has no value and no text is not suitable.

Used by:
  • select2_edit_renderer
query None

Function used to query results for the search term:

query(options)

In order for this function to work Select2 should be attached to a input type=’hidden’ tag instead of a select.

Used by:
  • select2_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
selectOnBlur None

Set to true if you want Select2 to select the currently highlighted option when it is blurred.

Used by:
  • select2_edit_renderer
separator None

Separator character or string used to delimit ids in value attribute of the multi-valued selects. The default delimiter is the , character.

Used by:
  • select2_edit_renderer
sortResults None

Used to sort the results list for searching right before display. Useful for sorting matches by relevance to the user’s search term:

sortResults(results, container, query)

Defaults to no sorting:

function(results, container, query) {
    return results;
}
Used by:
  • select2_edit_renderer
tags None

Puts Select2 into ‘tagging’ mode where the user can add new choices and pre-existing tags are provided via this options attribute which is either an array or a function that returns an array of objects or strings. If strings are used instead of objects they will be converted into an object that has an id and text attribute equal to the value of the string.

Used by:
  • select2_edit_renderer
tokenSeparators None

An array of strings that define token separators for the default tokenizer function. By default, this option is set to an empty array which means tokenization using the default tokenizer is disabled. Usually it is sensible to set this option to a value similar to [‘,’, ‘ ‘].

Used by:
  • select2_edit_renderer
tokenizer None

A tokenizer function can process the input typed into the search field after every keystroke and extract and select choices. This is useful, for example, in tagging scenarios where the user can create tags quickly by separating them with a comma or a space instead of pressing enter.

Tokenizer only applies to multi-selects:

tokenizer(input, selection, selectCallback, opts)
Used by:
  • select2_edit_renderer
width None

Controls the width style attribute of the Select2 container div. The following values are supported:

off

No width attribute will be set. Keep in mind that the container div copies classes from the source element so setting the width attribute may not always be necessary.

element

Uses javascript to calculate the width of the source element.

copy

Copies the value of the width style attribute set on the source element.

resolve

First attempts to copy than falls back on element.

other values

if the width attribute contains a function it will be evaluated, otherwise the value is used verbatim.

Used by:
  • select2_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. select2_extractor

  2. generic_required_extractor

  1. select2_edit_renderer

  1. select2_display_renderer

-/-

-/-

slider#

Add-on blueprint yafowil.widget.slider .

Properties

name

default

description
change None

Optional Javascript change callback as string.

Used by:
  • slider_edit_renderer
data {}

Additional data redered as HTML data attributes on slider wrapper DOM Element.

Used by:
  • slider_edit_renderer
height None

Height of slider if orientation is vertical in pixel.

Used by:
  • slider_edit_renderer
max None

Maximum slider value value. Defaults to 100.

Used by:
  • slider_edit_renderer
min None

Minimum slider value. Defaults to 0.

Used by:
  • slider_edit_renderer
orientation None

Slider Orientation. Either horizontal or vertical.

Used by:
  • slider_edit_renderer
range None

Slider Range. Either True, 'min' or 'max'.

Used by:
  • slider_extractor
  • slider_edit_renderer
show_value False

Show value in addition to slider.

Used by:
  • slider_edit_renderer
slide None

Optional Javascript slide callback as string.

Used by:
  • slider_edit_renderer
step None

Snap slider to increments.

Used by:
  • slider_edit_renderer
unit ''

Slider value unit.

Used by:
  • slider_edit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. slider_extractor

  1. slider_edit_renderer

  1. slider_display_renderer

-/-

-/-

submit#

Submit action inside the form

Properties

name

default

description
action True

Marks this widget as an action. One out of True or False.

Used by:
  • submit_renderer
class None global

Common CSS-class to put on.

Used by:
  • submit_renderer
expression True

Flag or expression callable whether this action is available to the user or not.

Used by:
  • submit_renderer
handler required/ not set

Handler is a callable which get called if this action performs. It expects two parameters: widget, data.

Used by:
  • submit_renderer
label required/ not set

Label of the submit.

Used by:
  • submit_renderer
next required/ not set

Next is a callable expected to return the web address. It expects a request as the only parameter.

Used by:
  • submit_renderer
skip False

Skips action and only perform next. One out of True or False.

Used by:
  • submit_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. submit_renderer

  1. empty_display_renderer

-/-

-/-

table#

<table> compound widget for table creation.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • table_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • table_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • table_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • table_renderer
id required/ not set

Value of table id attribute.

Used by:
  • table_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • table_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • table_renderer
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  2. table_renderer

  1. compound_renderer

  2. table_renderer

-/-

-/-

tag#

Render HTML tags with text. Useful for rendering headings etc.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • tag_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • tag_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • tag_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • tag_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • tag_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • tag_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • tag_renderer
tag required/ not set

HTML tag name.

Used by:
  • tag_renderer
text required/ not set

Tag contents.

Used by:
  • tag_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. tag_renderer

  1. tag_renderer

-/-

-/-

tbody#

<tbody> compound widget for table creation.

Properties

name

default

description
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  2. tbody_renderer

  1. compound_renderer

  2. tbody_renderer

-/-

-/-

td#

<td> compound widget for table creation.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • td_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • td_renderer
colspan required/ not set

Value of colspan attribute.

Used by:
  • td_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • td_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • td_renderer
id required/ not set

Value of id attribute.

Used by:
  • td_renderer
leaf None global

Leaf property can be used in conjunction with hybrid_extractor and hybrid_renderer using blueprints in order to mark compound widgets as leaf.

If set True, it causes bypassing auto delegation of extraction and rendering to compound_renderer respective compound_extractor if widget contains children.

This is useful if mixing blueprints which renders and handles compounds on it’s own with blueprints using hybrid rendering and extraction in order to prevent side effects due to multiple child rendering and extraction.

Used by:
  • hybrid_extractor
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • td_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • td_renderer
rowspan required/ not set

Value of rowspan attribute.

Used by:
  • td_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. hybrid_extractor

  1. td_renderer

  1. td_renderer

-/-

-/-

text#

One line text input blueprint.

Properties

name

default

description
allowed_datatypes <UNSET> global

List of allowed datatypes. If UNSET, datatype converters are not restricted.

Used by:
  • generic_datatype_extractor
autocomplete None global

Switch autocomplete explizit to on or off.

Used by:
  • text_edit_renderer
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • text_edit_renderer
class 'text'

Common CSS-class to put on.

Used by:
  • text_edit_renderer
  • generic_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • text_edit_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • text_edit_renderer
datatype None global

Callable for converting extracted value to output datatype.

datatype can also be defined as string with value out of 'str', 'unicode', 'int', 'integer', 'long', 'float' or 'uuid'.

ATTENTION: In python 3, string identifiers should not be used at all, but if,
the following must be known:

  • 'str' refers to bytes type.

  • 'unicode' refers to str type.

  • 'long' refers to int type.

Custom converter callables must raise one out of the following exceptions if conversion fails:

  • ValueError

  • UnicodeDecodeError

  • UnicodeEncodeError

Used by:
  • generic_datatype_extractor
datatype_message None global

Custom extraction error message if datatype conversion fails.

Used by:
  • generic_datatype_extractor
disabled False

Flag input field is disabled.

Used by:
  • text_edit_renderer
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
  • generic_datatype_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • text_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • text_edit_renderer
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • text_edit_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • text_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • text_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
size None global

Allowed input size.

Used by:
  • text_edit_renderer
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • generic_display_renderer
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • text_edit_renderer
type 'text'

Type of input tag.

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  4. generic_datatype_extractor

  1. text_edit_renderer

  1. generic_display_renderer

  2. display_proxy_renderer

-/-

-/-

textarea#

HTML textarea blueprint.

Properties

name

default

description
autofocus None global

Whether this field gets the focus automatically or not (if browser supports it).

Used by:
  • textarea_renderer
class 'textarea'

Common CSS-class to put on.

Used by:
  • textarea_renderer
  • generic_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • textarea_renderer
cols 80

Number of characters.

Used by:
  • textarea_renderer
data {} global

Additional data rendered as HTML5 data attributes on DOM Element.

Used by:
  • textarea_renderer
disabled None global

Disables input.

Used by:
  • textarea_renderer
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • textarea_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • textarea_renderer
placeholder None global

Whether this input has a placeholder value or not (if browser supports it).

Used by:
  • textarea_renderer
readonly None

Flag textarea is readonly.

Used by:
  • textarea_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
  • textarea_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • textarea_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • textarea_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
rows 25

Number of lines.

Used by:
  • textarea_renderer
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • generic_display_renderer
title None global

Optional help text to be rendered in the title attribute.

Used by:
  • textarea_renderer
wrap None

Either soft, hard, virtual, physical or off.

Used by:
  • textarea_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  1. textarea_renderer

  1. generic_display_renderer

  2. display_proxy_renderer

-/-

-/-

th#

<th> compound widget for table creation.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • th_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • th_renderer
colspan required/ not set

Value of colspan attribute.

Used by:
  • th_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • th_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • th_renderer
id required/ not set

Value of id attribute.

Used by:
  • th_renderer
label required/ not set

Explicit th content. If absent, rendered markup from downstream blueprint(s) is used.

Used by:
  • th_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • th_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • th_renderer
rowspan required/ not set

Value of rowspan attribute.

Used by:
  • th_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

-/-

  1. th_renderer

  1. th_renderer

-/-

-/-

thead#

<thead> compound widget for table creation.

Properties

name

default

description
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  2. thead_renderer

  1. compound_renderer

  2. thead_renderer

-/-

-/-

time#

Add-on blueprint yafowil.widget.datetime .

Properties

name

default

description
class 'time'

Common CSS-class to put on.

Used by:
  • time_edit_renderer
  • time_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • time_edit_renderer
daytime False

Flag whether value is day of time. Setting this property or ‘timepicker’ property above to True results in day time range validation.

Used by:
  • time_extractor
disabled False

Disables input.

Used by:
  • time_edit_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • time_edit_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • time_edit_renderer
format 'string'

Define widget value and extraction format. Either ‘string’, ‘number’ or ‘tuple’.

Used by:
  • time_extractor
  • time_edit_renderer
  • time_display_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • time_edit_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • time_edit_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
timeinput_class 'timeinput'

CSS class rendered on time input field.
timepicker False

Flag whether time picker is enabled.

Used by:
  • time_edit_renderer
timepicker_class 'timepicker'

jquery.ui timepicker binds to this class.

Used by:
  • time_edit_renderer
unit 'hours'

Only considered if ‘format’ is ‘number’. If unit is ‘hours’ value is float, otherwise integer.

Used by:
  • time_extractor
  • time_edit_renderer
  • time_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. time_extractor

  4. generic_emptyvalue_extractor

  1. time_edit_renderer

  1. time_display_renderer

-/-

-/-

tr#

<tr> compound widget for table creation.

Properties

name

default

description
class None global

Common CSS-class to put on.

Used by:
  • tr_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • tr_renderer
error_class None global

CSS-class to put on in case of error.

Used by:
  • tr_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • tr_renderer
id required/ not set

Value of id attribute.

Used by:
  • tr_renderer
required_class None global

CSS-class to put on in case if required condition was not met.

Used by:
  • tr_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • tr_renderer
structural False global

If a compound is structural, it will be omitted in the dotted-path levels and will not have an own runtime-data.

Used by:
  • compound_extractor

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. compound_extractor

  1. compound_renderer

  2. tr_renderer

  1. compound_renderer

  2. tr_renderer

-/-

-/-

url#

URL aka web address (HTML5) input blueprint.

Properties

name

default

description
class 'url'

Common CSS-class to put on.

Used by:
  • input_generic_renderer
  • generic_display_renderer
class_add None global

Additional CSS-class to put on.

Used by:
  • input_generic_renderer
display_proxy False global

If ‘True’ and widget mode ‘display’, widget value gets rendered as hidden input.

Used by:
  • display_proxy_renderer
emptyvalue required/ not set

If configured and received value in request is empty, return as extracted value.

Used by:
  • generic_emptyvalue_extractor
error_class None global

CSS-class to put on in case of error.

Used by:
  • input_generic_renderer
error_class_default 'error' global

Fallback CSS-class to put on in case of error if no specific class was given.

Used by:
  • input_generic_renderer
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_class 'required'

CSS-class to put on in case if required condition was not met.

Used by:
  • input_generic_renderer
required_class_default 'required' global

CSS-class to apply if required condition was not met - if no specific class was given.

Used by:
  • input_generic_renderer
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
template '%s' global

Format string with pythons built-in string format template. If a callable is given it will be used instead and is called with widget and data as parameters.

Used by:
  • generic_display_renderer

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  3. generic_emptyvalue_extractor

  4. url_extractor

  1. input_generic_renderer

  1. generic_display_renderer

  2. display_proxy_renderer

-/-

-/-

wysihtml5#

Add-on blueprint yafowil.widget.wysihtml5 .

Properties

name

default

description
color None

Show the color styles toolbar buttons. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
cols 80

Number of characters.
emphasis None

Show the emphasis toolbar buttons. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
font-styles None

Show the font styles toolbar buttons. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
html None

Show the html toolbar button. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
image None

Show the image toolbar buttons. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
justify None

Show the justify styles toolbar buttons. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
link None

Show the link toolbar button. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
lists None

Show the list toolbar buttons. Options: bootstrap-wysihtml5. Values: [True|False|None (use default)].

Used by:
  • wysihtml5_textarea_renderer
readonly None

Flag for readonly.
required False global

Whether this value is required or not.

Used by:
  • generic_required_extractor
required_message 'Mandatory field was empty' global

Message to be shown if required condition was not met.

Used by:
  • generic_required_extractor
rows 10

Number of lines.
size None

Size of toolbar buttons. Options: bootstrap-wysihtml5. Values: [‘lg’|’sm’|’sx’|None (default)].

Used by:
  • wysihtml5_textarea_renderer
wrap None

Either soft, hard, virtual, physical or off.

Chains

extractors

edit renderers

display renderers

preprocessors

builders

  1. generic_extractor

  2. generic_required_extractor

  1. wysihtml5_textarea_renderer

  1. wysihtml5_display_renderer

-/-

-/-

On this page