fix: allow default on select #1327
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
📢 Thoughts on this report? Let us know!. |
SBoudrias
reviewed
Nov 5, 2023
| if (!_default) return -1; | ||
| return items.findIndex( | ||
| (item) => | ||
| !Separator.isSeparator(item) && isSelectable(item) && item.value === _default, |
There was a problem hiding this comment.
Suggested change
| !Separator.isSeparator(item) && isSelectable(item) && item.value === _default, | |
| isSelectable(item) && item.value === _default, |
| @@ -76,7 +77,17 @@ export default createPrompt( | |||
| return { first, last }; | |||
| }, [items]); | |||
|
|
|||
| const [active, setActive] = useState(bounds.first); | |||
| const defaultItemIndex = useMemo(() => { | |||
| if (!_default) return -1; | |||
There was a problem hiding this comment.
Suggested change
| if (!_default) return -1; | |
| if (!'default' in config) return -1; |
Thinking we might want to be more liberal with the value we allow to provide 🤔 (like allowing falsy values, null or undefined)
| @@ -51,6 +51,7 @@ const answer = await select({ | |||
| | -------- | ---------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |||
| | message | `string` | yes | The question to ask | | |||
| | choices | `Array<{ value: string, name?: string, description?: string, disabled?: boolean \| string } \| Separator>` | yes | List of the available choices. The `value` will be returned as the answer, and used as display if no `name` is defined. Choices who're `disabled` will be displayed, but not selectable. The `description` will be displayed under the prompt when the cursor land over the choice. | | |||
| | default | `string` | no | Selects the default value that is initially. If omitted, the first selectable item is selected. | | |||
There was a problem hiding this comment.
Suggested change
| | default | `string` | no | Selects the default value that is initially. If omitted, the first selectable item is selected. | | |
| | default | `string` | no | Defines in front of which item the cursor will initially appear. When omitted, the cursor will appear on the first selectable item. | |
|
Thanks for sending the PR! That's a great addition 😄 I merged your code inside #1329 |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Setting a default for selects is quite handy, especially when the list of options is huge.
One can currently "work around", by sorting the choices to put the "default" first, but imo this is annoying enough to better support it natively.