Skip to content

InquirerCheckbox

Bases: InquirerWidget

A checkbox widget that allows multiple selections from a list of choices.

__init__(message, choices, name=None, enabled=None, mandatory=False)

Parameters:

Name Type Description Default
message str

The prompt message to display.

required
choices list[str | Choice]

A list of choices to present to the user.

required
name str | None

The name of the input field.

None
enabled list[str | Choice] | None

A list of choices that should be pre-selected.

None
mandatory bool

Whether at least one selection is mandatory.

False