Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c991fea

Browse filesBrowse files
nameLee-W
name
authored andcommitted
docs(customization.md): add select type and search filter documentation
1 parent 5f607f3 commit c991fea
Copy full SHA for c991fea

File tree

1 file changed

+7
-5
lines changed
Filter options

1 file changed

+7
-5
lines changed

‎docs/customization.md

Copy file name to clipboardExpand all lines: docs/customization.md
+7-5Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -170,13 +170,15 @@ 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. |
180182

181183
[different-question-types]: https://github.com/tmbo/questionary#different-question-types
182184

@@ -445,8 +447,8 @@ Commitizen gives you the possibility to provide your own changelog template, by:
445447

446448
- providing one with your customization class
447449
- providing one from the current working directory and setting it:
448-
- as [configuration][template-config]
449-
- as `--template` parameter to both `bump` and `changelog` commands
450+
- as [configuration][template-config]
451+
- as `--template` parameter to both `bump` and `changelog` commands
450452
- either by providing a template with the same name as the default template
451453

452454
By default, the template used is the `CHANGELOG.md.j2` file from the commitizen repository.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.