selectbox

Displays a selectbox input widget and maps its value to the backend as a string.

We use Select2 under the hood to make the dropdown searchable.

Basic use¶

frontend (html+django)backend (python)

{% selectbox name="my_input" %}

from simmate.website.core_components.components import DynamicFormComponent

class ExampleView(DynamicFormComponent):

    my_input = None

    my_input_options = [
        ("label1", "value1"),
        ("label2", "value2"),
        ("label3", "value3"),
        # ...
    ]

Parameters¶

Parameter	Description
`name`	The unique name or identifier for the input field. This should match the name of your class attribute in the backend. Type: `str`, Default: —
`options`	The name of the class attribute that holds all options for the dropdown menu. In python, options should be a list of `('label', 'value')`, where `label` is what's shown in the UI and `value` is what is set in python. Type: `str`, Default: `f"{name}_options"
`label`	The display label for the input field. If not provided, the `name` may be used as the label. Type: `str`, Default: `None`
`show_label`	Whether to display the label alongside the input field. Type: `bool`, Default: `True`
`dynamic_options`	Whether the options list changes while the component is being updated. If your options are static, set this to `False` & add your options to `javascript_exclude` to improve performance. Type: `bool`, Default: `False`
`allow_custom_input`	Whether the user can type in their own value, in addition to the options listed. Type: `bool`, Default: `False`
`multiselect`	Whether the user can select more than 1 option from the dropdown. When `True`, the python attribute for `name` becomes a list of strings. Type: `bool`, Default: `False`