feat: rework values and user input to be separate#334
Merged
Conversation
🦋 Changeset detectedLatest commit: 831029d The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
@example/basic • @example/changesets commit: |
Merged
dreyfus92
reviewed
May 28, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Fixes #330
Basically, this introduces a new
userInputfield and event to the core.The difference is:
userInputtracks what the user has typed in (iftrack: true)valuein the core anymoreThis means it is the responsibility of each prompt to decide what to do with
value. They can then callthis._setValue(value)to set the value and trigger thevalueevent.An example - text prompt
The text prompt wants to set the value to what the user has typed in. So we can simply listen for
userInputand setvalueto whatever they have typed. Or we can wait forfinalizeand do it.A more complex example - auto complete
The auto complete prompt wants to take user input, but this isn't the value. The value should be the completed value.
To achieve this, we can set
valueonly once someone selects an option.This means the
valueis only everundefinedor a selected option.Notable changes
submit(press<RETURN>), it used to run against initial values tooundefined(it always could but we didn't type it as such, iirc)valueas a strong type)