CheckboxGroupFieldV1

toloka.client.project.template_builder.fields.CheckboxGroupFieldV1 | Source code

CheckboxGroupFieldV1(
self,
data: Optional[BaseComponent] = None,
options: Optional[Union[BaseComponent, List[Union[BaseComponent, GroupFieldOption]]]] = None,
*,
disabled: Optional[Union[BaseComponent, bool]] = None,
preserve_false: Optional[Union[BaseComponent, bool]] = None,
hint: Optional[Any] = None,
label: Optional[Any] = None,
validation: Optional[BaseComponent] = None,
version: Optional[str] = '1.0.0'
)

A group of checkboxes.

This component creates a dictionary in the output data. Values from options are used as keys in the dictionary.

For more information, see field.checkbox-group.

Parameters description

ParametersTypeDescription
dataOptional[BaseComponent]

A data path.

optionsOptional[Union[BaseComponent, List[Union[BaseComponent, GroupFieldOption]]]]

A list of options.

disabledOptional[Union[BaseComponent, bool]]

Disabling the checkbox group.

preserve_falseOptional[Union[BaseComponent, bool]]
  • False — If a checkbox from the group is not selected then its key is not added to the dictionary.
  • True — The output dictionary contains all keys whether checkboxes are selected or not.

Default value: False.

hintOptional[Any]

A hint.

labelOptional[Any]

A label above the component.

validationOptional[BaseComponent]

Validation rules.

Last updated: August 28, 2023

Toloka-Kit
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming