1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# checkbox
A prompt which displays a list of checkboxes to toggle/tick.
## Example
<details>
<summary>Classic Syntax (PyInquirer)</summary>
```{eval-rst}
.. literalinclude :: ../../../examples/classic/checkbox.py
:language: python
```
</details>
<details open>
<summary>Alternate Syntax</summary>
```{eval-rst}
.. literalinclude :: ../../../examples/alternate/checkbox.py
:language: python
```
</details>
## Choices
```{seealso}
{ref}`pages/dynamic:choices`
```
In checkbox prompt, the `multiselct` option is always enabled. If you want any choices to be pre-selected,
use {class}`~InquirerPy.base.control.Choice` to create choices and set `enabled` to True.
```{code-block} python
from InquirerPy.base import Choice
choices = [
Choice("selected", enabled=True),
Choice("notselected", enabled=False),
"notselected2"
]
```
## Keybindings
```{seealso}
{ref}`pages/kb:Keybindings`
```
```{include} ../kb.md
:start-after: <!-- start kb -->
:end-before: <!-- end kb -->
```
```{include} ./list.md
:start-after: <!-- start list kb -->
:end-before: <!-- end list kb -->
```
```{include} ./list.md
:start-after: <!-- start list vi kb -->
:end-before: <!-- end list vi kb -->
```
## Default Value
```{seealso}
{ref}`pages/dynamic:default`
```
The `default` parameter will be used to determine which choice is highlighted by default.
It should be the value of one of the choices.
If you wish to pre-select certain choices, you can leverage the `enabled` parameter/key of each choice.
```{code-block} python
from InquirerPy.base import Choice
choices = [
Choice(1, enabled=True), # enabled by default
Choice(2) # not enabled
]
```
## Reference
```{eval-rst}
.. autoclass:: InquirerPy.prompts.checkbox.CheckboxPrompt
:noindex:
```
|
