Feature: Validate Input #167

maaslalani · 2022-06-08T16:06:34Z

Based on #114

Adds Validate property to textinput to ensure input is valid.

Validate is a function that accepts a string and returns an error which may be nil if the string is valid.

// ValidateFunc is a function that returns an error if the input is invalid.
type ValidateFunc func(string) error

textinput/textinput.go

GabrielNagy · 2022-07-05T08:38:03Z

textinput/textinput.go

 	runes := []rune(s)
 	if m.CharLimit > 0 && len(runes) > m.CharLimit {
 		m.value = runes[:m.CharLimit]
 	} else {
 		m.value = runes
 	}
-	if m.pos == 0 || m.pos > len(m.value) {
+	if (m.pos == 0 && len(m.value) == 0) || m.pos > len(m.value) {


Hey @maaslalani do you know if this was intended?

Basically now when I use SetValue to prefill a field my cursor is no longer moved to the end of the line and I have to call CursorEnd myself.

Hey! That's definitely a bug, I will fix it soon! Thank you for catching it.

No worries, if you want I can open a PR 😄

If you would like to, go for it! It would be much appreciated :)

This PR builds upon the excellent work in charmbracelet#167 and charmbracelet#114 and adds a bit more customizability to the feature. Currently, the validation API will completely block text input if the Validate function returns an error. This commit makes this behavior configurable by introducing a ValidateAction which decides how to proceed in case a validation error happens. To preserve backwards compatibility, the default behavior remains unchanged. If ValidateAction is set to AllowInput, the text input error will still be set if needed, but actual input will not be blocked. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting this. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil

This PR builds upon the excellent work in charmbracelet#167 and charmbracelet#114 and adds a bit more customizability to the feature. Currently, the validation API will completely block text input if the Validate function returns an error. This commit makes this behavior configurable by introducing a ValidateAction which decides how to proceed in case a validation error happens. To preserve backwards compatibility, the default behavior remains unchanged. If ValidateAction is set to AllowInput, the text input error will still be set if needed, but actual input will not be blocked. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting the existence of the path. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil

This PR builds upon the excellent work in charmbracelet#167 and charmbracelet#114 and adds a bit more customizability to the feature. Currently, the validation API will completely block text input if the Validate function returns an error. This commit makes a breaking change to the ValidateFunc by returning an additonal bool that indicates whether or not input should be blocked. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting the existence of the path. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil

This PR builds upon the excellent work in charmbracelet#167 and charmbracelet#114 and adds a bit more customizability to the feature. Currently, the validation API will completely block text input if the Validate function returns an error. This commit makes a breaking change to the validate API to no longer block input if this is the case, thus handing this responsibility to the clients. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting the existence of the path. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil

This PR builds upon the excellent work in charmbracelet#167 and charmbracelet#114 and makes a breaking change to the validation API. Currently, validation will completely block text input if the Validate function returns an error. This is now changed so the function no longer blocks input if this is the case, thus handing this responsibility to the clients. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting the existence of the path. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil

* feat(textinput): do not block input on validation This PR builds upon the excellent work in #167 and #114 and makes a breaking change to the validation API. Currently, validation will completely block text input if the Validate function returns an error. This is now changed so the function no longer blocks input if this is the case, thus handing this responsibility to the clients. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting the existence of the path. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil * fix: change name --------- Co-authored-by: Maas Lalani <maas@lalani.dev>

* feat(textinput): do not block input on validation This PR builds upon the excellent work in charmbracelet#167 and charmbracelet#114 and makes a breaking change to the validation API. Currently, validation will completely block text input if the Validate function returns an error. This is now changed so the function no longer blocks input if this is the case, thus handing this responsibility to the clients. This is helpful for cases where the user is requested to type an existing system path, and the Validate function keeps asserting the existence of the path. With the current implementation such a validation is not possible. For example: > / Err: nil > /t Err: /t: No such file or directory > /tm Err: /tm: No such file or directory > /tmp Err: nil * fix: change name --------- Co-authored-by: Maas Lalani <maas@lalani.dev>

maaslalani mentioned this pull request Jun 8, 2022

Example: Input validation on age charmbracelet/bubbletea#340

Closed

caarlos0 reviewed Jun 8, 2022

View reviewed changes

textinput/textinput.go Outdated Show resolved Hide resolved

textinput/textinput.go Outdated Show resolved Hide resolved

textinput/textinput.go Outdated Show resolved Hide resolved

maaslalani force-pushed the validate branch 2 times, most recently from ad414d7 to edb33a0 Compare June 10, 2022 14:07

feat: added Validate function for textinput

16053f4

maaslalani force-pushed the validate branch from edb33a0 to 16053f4 Compare June 10, 2022 14:09

maaslalani mentioned this pull request Jun 10, 2022

feat: added Validate function for textinput #114

Closed

caarlos0 approved these changes Jun 10, 2022

View reviewed changes

maaslalani merged commit e57fd29 into master Jun 10, 2022

maaslalani deleted the validate branch June 10, 2022 16:17

GabrielNagy reviewed Jul 5, 2022

View reviewed changes

GabrielNagy mentioned this pull request Jul 5, 2022

feat(textinput): do not block input on validation #185

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Validate Input #167

Feature: Validate Input #167

maaslalani commented Jun 8, 2022

GabrielNagy Jul 5, 2022

maaslalani Jul 5, 2022

GabrielNagy Jul 5, 2022

maaslalani Jul 5, 2022

Feature: Validate Input #167

Feature: Validate Input #167

Conversation

maaslalani commented Jun 8, 2022

GabrielNagy Jul 5, 2022

Choose a reason for hiding this comment

maaslalani Jul 5, 2022

Choose a reason for hiding this comment

GabrielNagy Jul 5, 2022

Choose a reason for hiding this comment

maaslalani Jul 5, 2022

Choose a reason for hiding this comment