Reference: Blueprints¶

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.

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.

The vocabulary source. This can be either [o]dict, string or a a callable returning one of both.

If a dict is passed or returned by the callable, the vocabulary is rendered inline. The dict keys are used as values, dicts value is a tuple of (title, children), where title is shown in the tree and children is either None or a dict of the same structure.

If a string is passed it is considered as an URL to fetch the vocabulay from. It is returned as JSON in the format described in the original jquery.dynatreee.js documentation.

If a callable is passed it expects widget and data as parameters and has to return either a string or a dict as described above.

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'.

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

• ValueError
• UnicodeDecodeError
• UnicodeEncodeError

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'.

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

• ValueError
• UnicodeDecodeError
• UnicodeEncodeError

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.

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.

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.

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.

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.

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.

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.

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

formatInputTooShort(term, minLength)

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

formatNoMatches(term)

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.

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
}

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 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;
}

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.

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.

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).

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.

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.

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)