Source

django-selectable / docs / fields.rst

Fields

Django-Selectable defines a number of fields for selecting either single or mutliple lookup items. Item in this context corresponds to the object return by the underlying lookup get_item. The single select select fields (:ref:`AutoCompleteSelectField` and :ref:`AutoComboboxSelectField`) allow for the creation of new items. To use this feature the field's lookup class must define create_item. In the case of lookups extending from :ref:`ModelLookup` newly created items have not yet been saved into the database and saving should be handled by the form. All fields take the lookup class as the first required argument.

AutoCompleteSelectField

Field tied to :ref:`AutoCompleteSelectWidget` to bind the selection to the form and create new items, if allowed. The allow_new keyword argument (default: False) which determines if the field allows new items. This field cleans to a single item.

AutoComboboxSelectField

Field tied to :ref:`AutoComboboxSelectWidget` to bind the selection to the form and create new items, if allowed. The allow_new keyword argument (default: False) which determines if the field allows new items. This field cleans to a single item.

This field is deprecated in v0.5 and will be removed in v0.6. You should instead use the above :ref:`AutoCompleteSelectField` and pass the :ref:`AutoComboboxSelectWidget` in the widget argument.

AutoCompleteSelectMultipleField

Field tied to :ref:`AutoCompleteSelectMultipleWidget` to bind the selection to the form. This field cleans to a list of items. :ref:`AutoCompleteSelectMultipleField` does not allow for the creation of new items.

AutoComboboxSelectMultipleField

Field tied to :ref:`AutoComboboxSelectMultipleWidget` to bind the selection to the form. This field cleans to a list of items. :ref:`AutoComboboxSelectMultipleField` does not allow for the creation of new items.

This field is deprecated in v0.5 and will be removed in v0.6. You should instead use the above :ref:`AutoCompleteSelectMultipleField` and pass the :ref:`AutoComboboxSelectMultipleWidget` in the widget argument.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.