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

GabrielNagy · 2022-07-05T15:17:54Z

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

maaslalani · 2022-07-05T15:42:32Z

❤️ This is fantastic! @meowgorithm and I were just talking about how this would be a great addition. Thank you for reading our minds @GabrielNagy 😄

GabrielNagy · 2022-08-19T09:55:44Z

@maaslalani let me know how I can help getting this merged 🙏🏼

maaslalani · 2022-08-19T14:17:42Z

Hey @GabrielNagy sorry for forgetting about this one!

I almost wonder if the ValidateFunc should return an error and a boolean on whether to block the input such that validation could block some input but not block all input (i.e. warnings vs errors).

The difference would be you could then validate input and give warning errors such as "file not found" but also prevent input that will never be valid such as inserting a special character in a file name.

This obviously would be a breaking API change so we might need to think about it a little more, but I'm curious to hear your thoughts on the validation function returning a bool for whether to allow the input or block it from changing. And, you can always return false or always return true for the behaviour in the current PR.

GabrielNagy · 2022-08-22T07:00:15Z

That sounds good to me! It's definitely the better solution apart from the backwards compatibility issue.

hopefulTex · 2023-02-16T00:03:25Z

I really like the option to block or warn on invalid input!
Would it be reasonable to set a behavior flag, like m.textInput.Warning()', and let the validator logic flip it back after writing the rune? It shouldn't break any users' code, and they'd set the behavior flag before returning their Err`.

As for the separate validation functions, would a more general Submit() function work for this? Maybe it could just run the former Validate function with block set before executing a user-supplied Submit function.
(I'd also love a SubmitKey tea.Msg to proc Submit() when set, but scope is scope.)

rynowak · 2023-05-29T19:56:55Z

I just hit this issue as well, and I need to stop using the Validate function as a result. Is there anything we can do to accelerate getting this functionality added?

CoMfUcIoS · 2023-09-04T14:48:44Z

Hitting this issue too. Can't validate FQDN because I can't type in the first dot. What it needs for this to be merged?

GabrielNagy · 2023-09-04T17:16:44Z

I rebased and implemented the backwards-incompatible suggestion from @maaslalani. I'd be happy to work on some tests as well once we decide on a way forward.

CoMfUcIoS · 2023-11-22T11:40:08Z

Any updates on this? Willing to help if needed as well.

maaslalani · 2024-02-28T16:57:12Z

@GabrielNagy, what do you think of simply removing the blocking of the validation?

That way we can keep the signature of the function the same. We would then simply put the responsibility on the user to ensure that there is no m.Err before they submit their form.

I like the idea of keeping the func Validate(s string) err since that the signature we use for huh, but for huh we just validate on Blur.

maaslalani · 2024-02-28T16:57:45Z

textinput/textinput.go


- if m.Err != nil {


So essentially we just remove this line and never block.

GabrielNagy · 2024-02-29T10:41:07Z

Thanks for coming back to this. Yeah, not blocking the input would solve all our issues since we already handled blocking submit ourselves, e.g. https://github.com/ubuntu/adsys/blob/ca3458501ff5b2f72f16be266bad7a189a890acf/internal/watchdtui/watchdtui.go#L224-L227

I'll push an update to the PR!

maaslalani · 2024-02-29T14:53:41Z

Thanks for all your patience on this one @GabrielNagy!

jippi · 2024-03-02T18:24:05Z

👋 Thanks for looking at this - I just spent a couple of hours debugging this issue on my own project 😆

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

maaslalani · 2024-03-13T22:03:39Z

textinput/textinput.go

- case key.Matches(msg, m.KeyMap.DeleteWordBackward):
- m.deleteWordBackward()


Any reason for deleting this?

Ah I see it's a duplicate now.

Yes, apologies should have pulled that to a separate commit. It confused me as well when re-reading the code. 😅

maaslalani

Awesome work @GabrielNagy, just tested and it works great!

maaslalani · 2024-03-13T22:04:13Z

textinput/textinput.go

- case key.Matches(msg, m.KeyMap.DeleteWordBackward):
- m.deleteWordBackward()


Ah I see it's a duplicate now.

* 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>

…(#33) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/charmbracelet/bubbles](https://github.com/charmbracelet/bubbles) | require | minor | `v0.18.0` -> `v0.19.0` | --- ### Release Notes <details> <summary>charmbracelet/bubbles (github.com/charmbracelet/bubbles)</summary> ### [`v0.19.0`](https://github.com/charmbracelet/bubbles/releases/tag/v0.19.0) [Compare Source](charmbracelet/bubbles@v0.18.0...v0.19.0) ### Bugs? Squashed (along with a few nice lil’ features). Community-Driven Development?! Yep, the majority of the changes in this release were done by the community. *Thank you* all for your contributions that made this release possible. #### Progress: custom chars You can now customize the filled and empty characters of the progress bar. ```go p := progress.New(progress.WithFillCharacters('>', '.')) ``` ![progress bar example](https://github.com/user-attachments/assets/ee1a1351-ebee-4f39-8543-af464e60b099) #### Table improvements ##### Help is on the way Table now includes a short and full help view so it's easier than ever to tell your users how to interact with the table. ```go // Render a table with its help. t := table.New() view := t.View() + "\n" + t.HelpView() ``` <img src="https://github.com/user-attachments/assets/22195043-5578-4201-982d-a8f9b7eefc5f" width="600"> ##### Accessing columns You can also now get the table's columns (this already existed for rows). ```go package table // Columns returns the current columns. func (m Model) Columns() []Column ``` #### List: page navigation is fixed! Previously, `list.NextPage()` and `list.PrevPage()` didn't work because the methods did not have pointer receivers. We've fixed this…by making them pointer receivers! ⚠️ Note that this is a minor API change and you *might* need to update your app to pass a pointer receiver to your model rather than a copy. Details in [#458](charmbracelet/bubbles#458). ```go package progress // NextPage moves to the next page, if available. func (m *Model) NextPage() // PrevPage moves to the previous page, if available. func (m *Model) PrevPage() ``` *** #### What’s Changed ##### Changed - Textarea: Improve setting width by [@mikelorant](https://github.com/mikelorant) in charmbracelet/bubbles#496 - Textinput: fix out of range panic if no matched suggestions by [@rdnt](https://github.com/rdnt) in charmbracelet/bubbles#473 - List: Fix no-op list pagination functions by [@nekopy](https://github.com/nekopy) in charmbracelet/bubbles#458 - Table: Clarify position constant in JoinHorizontal by [@aditipatelpro](https://github.com/aditipatelpro) in charmbracelet/bubbles#577 - Progress: make full/empty fill characters configurable by [@rwinkhart](https://github.com/rwinkhart) in charmbracelet/bubbles#409 - Dependencies: switch to x/ansi for text manipulation by [@aymanbagabas](https://github.com/aymanbagabas) in charmbracelet/bubbles#505 ##### Added - Textarea: add help to textarea key bindings by [@TravisYeah](https://github.com/TravisYeah) in charmbracelet/bubbles#418 - Textarea: Add multiline placeholder by [@mikelorant](https://github.com/mikelorant) in charmbracelet/bubbles#302 - Table: Add column return function by [@abeleinin](https://github.com/abeleinin) in charmbracelet/bubbles#369 - Table: Implement help.Keymap interface and add quit mapping by [@prgres](https://github.com/prgres) in charmbracelet/bubbles#440 - Ctrl+Left/Right for WordForward/Backward by [@maaslalani](https://github.com/maaslalani) in charmbracelet/bubbles#387 - Use goreleaser for releases by [@aymanbagabas](https://github.com/aymanbagabas) in charmbracelet/bubbles#526 ##### Fixed - Table: Render Row Tests by [@maaslalani](https://github.com/maaslalani) in charmbracelet/bubbles#487 - Table: Only render columns with a positive width by [@fabio42](https://github.com/fabio42) in charmbracelet/bubbles#465 - Table: Fix inheritence of SelectedStyle in StyleFunc by [@gabrielfu](https://github.com/gabrielfu) in charmbracelet/bubbles#539 - Table: Don't include header height in the total table size by [@prgres](https://github.com/prgres) in charmbracelet/bubbles#434 - Table: Fix premature viewport scroll by [@dzeleniak](https://github.com/dzeleniak) in charmbracelet/bubbles#429 - Textarea: Fix end of buffer character by [@mikelorant](https://github.com/mikelorant) in charmbracelet/bubbles#491 - Textarea: Set textarea default EndOfBufferCharacter to ' ' by [@blvrd](https://github.com/blvrd) in charmbracelet/bubbles#510 - Textarea: End of Buffer alignment by [@maaslalani](https://github.com/maaslalani) in charmbracelet/bubbles#486 - Textinput: don't block input on validation by [@GabrielNagy](https://github.com/GabrielNagy) in charmbracelet/bubbles#185 - Viewport: Fix division by zero in scrollpercentage by [@zMoooooritz](https://github.com/zMoooooritz) in charmbracelet/bubbles#494 - Help: Fix centering by [@gabe565](https://github.com/gabe565) in charmbracelet/bubbles#516 - Progress: Stop spring defaults from overriding WithStringOptions by [@nervo](https://github.com/nervo) in charmbracelet/bubbles#540 - Cursor: Make SetMode method in cursor library handle invalid mode values correctly by [@anirudhaCodes](https://github.com/anirudhaCodes) in charmbracelet/bubbles#477 ##### Test coverage ✅ - Add tests for textarea view by [@mikelorant](https://github.com/mikelorant) in charmbracelet/bubbles#485 - Add tests for paginator by [@anirudhaCodes](https://github.com/anirudhaCodes) in charmbracelet/bubbles#480 - Add tests for textInput Tests by [@KevM](https://github.com/KevM) in charmbracelet/bubbles#500 - Improve textarea tests by [@mikelorant](https://github.com/mikelorant) in charmbracelet/bubbles#490 #### New Contributors - [@rdnt](https://github.com/rdnt) made their first contribution in charmbracelet/bubbles#473 - [@rwinkhart](https://github.com/rwinkhart) made their first contribution in charmbracelet/bubbles#409 - [@mikelorant](https://github.com/mikelorant) made their first contribution in charmbracelet/bubbles#485 - [@anirudhaCodes](https://github.com/anirudhaCodes) made their first contribution in charmbracelet/bubbles#480 - [@nekopy](https://github.com/nekopy) made their first contribution in charmbracelet/bubbles#458 - [@TravisYeah](https://github.com/TravisYeah) made their first contribution in charmbracelet/bubbles#418 - [@abeleinin](https://github.com/abeleinin) made their first contribution in charmbracelet/bubbles#369 - [@fabio42](https://github.com/fabio42) made their first contribution in charmbracelet/bubbles#465 - [@prgres](https://github.com/prgres) made their first contribution in charmbracelet/bubbles#440 - [@zMoooooritz](https://github.com/zMoooooritz) made their first contribution in charmbracelet/bubbles#494 - [@dzeleniak](https://github.com/dzeleniak) made their first contribution in charmbracelet/bubbles#429 - [@KevM](https://github.com/KevM) made their first contribution in charmbracelet/bubbles#500 - [@gabe565](https://github.com/gabe565) made their first contribution in charmbracelet/bubbles#516 - [@blvrd](https://github.com/blvrd) made their first contribution in charmbracelet/bubbles#510 - [@nervo](https://github.com/nervo) made their first contribution in charmbracelet/bubbles#540 - [@gabrielfu](https://github.com/gabrielfu) made their first contribution in charmbracelet/bubbles#539 - [@aditipatelpro](https://github.com/aditipatelpro) made their first contribution in charmbracelet/bubbles#577 **Full Changelog**: charmbracelet/bubbles@v0.18.0...v0.19.0 *** <a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-badge.jpg?1" width="400"></a> Thoughts? Questions? We love hearing from you. Feel free to reach out on [Twitter](https://twitter.com/charmcli), [The Fediverse](https://mastodon.social/@charm), or on [Discord](https://charm.sh/chat). </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: Renovate Bot <renovate-bot@gitea.com> Reviewed-on: https://git.asdf.cafe/abs3nt/gspot/pulls/33

GabrielNagy mentioned this pull request Jul 11, 2022

Refactor watchdtui using the new bubbles Validate API ubuntu/adsys#375

Closed

GabrielNagy force-pushed the customizable-validation branch from bac2470 to 801ac44 Compare August 18, 2022 15:58

maaslalani mentioned this pull request Sep 15, 2022

textinput: Distinguish between intermediate valid inputs and final valid inputs #244

Open

muesli added the enhancement New feature or request label Oct 5, 2022

This was referenced Feb 15, 2023

Can't figure out how to show error in dedicated field in credit-card-example charmbracelet/bubbletea#654

Closed

feat(examples): Credit Card Example Now Displays User Input Errors charmbracelet/bubbletea#660

Closed

rynowak mentioned this pull request May 29, 2023

rad init validation blocks valid names (sadly) radius-project/radius#5611

Closed

GabrielNagy force-pushed the customizable-validation branch from 801ac44 to b0c7209 Compare September 4, 2023 17:15

maaslalani reviewed Feb 28, 2024

View reviewed changes

GabrielNagy force-pushed the customizable-validation branch from b0c7209 to 3d2b848 Compare February 29, 2024 10:45

GabrielNagy requested a review from meowgorithm as a code owner February 29, 2024 10:45

GabrielNagy force-pushed the customizable-validation branch from 3d2b848 to 5b06afd Compare February 29, 2024 10:46

GabrielNagy changed the title ~~feat(textinput): make validation customizable~~ feat(textinput): do not block input on validation Feb 29, 2024

maaslalani reviewed Mar 13, 2024

View reviewed changes

maaslalani force-pushed the customizable-validation branch from 5b06afd to e7b3760 Compare March 13, 2024 22:03

maaslalani approved these changes Mar 13, 2024

View reviewed changes

fix: change name

7f0383b

maaslalani merged commit 9030d22 into charmbracelet:master Mar 14, 2024
9 checks passed

GabrielNagy deleted the customizable-validation branch March 14, 2024 09:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

GabrielNagy commented Jul 5, 2022 •

edited

Loading

maaslalani commented Jul 5, 2022

GabrielNagy commented Aug 19, 2022

maaslalani commented Aug 19, 2022 •

edited

Loading

GabrielNagy commented Aug 22, 2022

hopefulTex commented Feb 16, 2023

rynowak commented May 29, 2023

CoMfUcIoS commented Sep 4, 2023

GabrielNagy commented Sep 4, 2023

CoMfUcIoS commented Nov 22, 2023

maaslalani commented Feb 28, 2024

maaslalani Feb 28, 2024

GabrielNagy commented Feb 29, 2024

maaslalani commented Feb 29, 2024

jippi commented Mar 2, 2024

maaslalani Mar 13, 2024

maaslalani Mar 13, 2024

GabrielNagy Mar 13, 2024

maaslalani left a comment

maaslalani Mar 13, 2024

		case key.Matches(msg, m.KeyMap.DeleteWordBackward):
		m.deleteWordBackward()

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

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

Conversation

GabrielNagy commented Jul 5, 2022 • edited Loading

maaslalani commented Jul 5, 2022

GabrielNagy commented Aug 19, 2022

maaslalani commented Aug 19, 2022 • edited Loading

GabrielNagy commented Aug 22, 2022

hopefulTex commented Feb 16, 2023

rynowak commented May 29, 2023

CoMfUcIoS commented Sep 4, 2023

GabrielNagy commented Sep 4, 2023

CoMfUcIoS commented Nov 22, 2023

maaslalani commented Feb 28, 2024

maaslalani Feb 28, 2024

Choose a reason for hiding this comment

GabrielNagy commented Feb 29, 2024

maaslalani commented Feb 29, 2024

jippi commented Mar 2, 2024

maaslalani Mar 13, 2024

Choose a reason for hiding this comment

maaslalani Mar 13, 2024

Choose a reason for hiding this comment

GabrielNagy Mar 13, 2024

Choose a reason for hiding this comment

maaslalani left a comment

Choose a reason for hiding this comment

maaslalani Mar 13, 2024

Choose a reason for hiding this comment

GabrielNagy commented Jul 5, 2022 •

edited

Loading

maaslalani commented Aug 19, 2022 •

edited

Loading