Skip to content

Commit 3226654

Browse files
author
name
committed
docs(customization.md): add select type and search filter documentation
1 parent e0b1c77 commit 3226654

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Diff for: docs/customization.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -170,13 +170,16 @@ commitizen:
170170

171171
| Parameter | Type | Default | Description |
172172
| ----------- | ------ | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
173-
| `type` | `str` | `None` | The type of questions. Valid type: `list`, `input` and etc. [See More][different-question-types] |
173+
| `type` | `str` | `None` | The type of questions. Valid types: `list`, `select`, `input` and etc. The `select` type provides an interactive searchable list interface. [See More][different-question-types] |
174174
| `name` | `str` | `None` | The key for the value answered by user. It's used in `message_template` |
175175
| `message` | `str` | `None` | Detail description for the question. |
176-
| `choices` | `list` | `None` | (OPTIONAL) The choices when `type = list`. Either use a list of values or a list of dictionaries with `name` and `value` keys. Keyboard shortcuts can be defined via `key`. See examples above. |
176+
| `choices` | `list` | `None` | (OPTIONAL) The choices when `type = list` or `type = select`. Either use a list of values or a list of dictionaries with `name` and `value` keys. Keyboard shortcuts can be defined via `key`. See examples above. |
177177
| `default` | `Any` | `None` | (OPTIONAL) The default value for this question. |
178178
| `filter` | `str` | `None` | (OPTIONAL) Validator for user's answer. **(Work in Progress)** |
179-
| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. |
179+
| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`. |
180+
| `use_search_filter` | `bool` | `False` | (OPTIONAL) Enable search/filter functionality for list/select type questions. This allows users to type and filter through the choices. |
181+
| `use_jk_keys` | `bool` | `True` | (OPTIONAL) Enable/disable j/k keys for navigation in list/select type questions. Set to false if you prefer arrow keys only. |
182+
180183
[different-question-types]: https://github.com/tmbo/questionary#different-question-types
181184

182185
#### Shortcut keys

0 commit comments

Comments
 (0)