[Question] Ability to choose none in multiselect list

[rthill91]

Is there any way to allow the user to select zero options in a multiselect list?

When using a multiselect list if none of the choices have been selected Enter selects the currently highlighted option and proceeds. If one or more options have been selected the currently highlighted option is ignored.

[kazhala]

Hi @rthill91 ,

There is a possible way with the current released version. If you set the prompt to not raise KeyboardInterrupt, when encountering a KeyboardInterrupt, the question is skipped and no selection is made. The argument raise_keyboard_interrupt is used to manage this behavior.

Classic syntax

questions = [
    {
        "type": "list",
        "message": "Select regions:",
        "choices": [
            {"name": "Sydney", "value": "ap-southeast-2"},
            {"name": "Singapore", "value": "ap-southeast-1"},
            Separator(),
            "us-east-1",
            "us-east-2",
        ],
        "multiselect": True,
        "transformer": lambda result: "%s region%s selected"
        % (len(result), "s" if len(result) > 1 else ""),
        "when": lambda result: result[0] is not None,
    },
]

result = prompt(questions=questions, raise_keyboard_interrupt=False)

Alternate syntax

region = inquirer.select(
    message="Select regions:",
    choices=[
        {"name": "Sydney", "value": "ap-southeast-2"},
        {"name": "Singapore", "value": "ap-southeast-1"},
        Separator(),
        "us-east-1",
        "us-east-2",
    ],
    multiselect=True,
    transformer=lambda result: "%s region%s selected"
    % (len(result), "s" if len(result) > 1 else ""),
).execute(raise_keyboard_interrupt=False)

In the case if you still want no KeyboardInterrupt raised and also skip the question, there is no current way of doing so. Although I think it make sense to allow customization on a keybinding to skip a question.

I'll leave the issue open and include the kb customization for skipping in the next release.

Thanks,
Kevin

[rthill91]

I still think this might be a valuable addition, but I decided that checkbox had the functionality I needed and was probably a better fit for my case anyway. From my perspective at least this issue is closed.

[kazhala]

The ability to skip prompt is now added to the latest release 0.3.0. Its documented here