ui: Improve form handling #1963
Open
+95
−14
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
Etsija
force-pushed
the
improve-form-handling
branch
3 times, most recently
from
03ec527 to
ae88545
Compare
#1940 introduced a component for inputting "password" fiels, so use it also for creating a new user. Signed-off-by: Jyrki Keisala <jyrki.keisala@doubleopen.org>
When using controlled forms, default values must be provided to non-optional form fields [1], to prevent the React warning (seen in the dev. console of the browser): "Warning: A component is changing an uncontrolled input to be controlled. This is likely caused by the value changing from undefined to a defined value, which should not happen." [1]: https://stackoverflow.com/a/77202565 Signed-off-by: Jyrki Keisala <jyrki.keisala@doubleopen.org>
Define a function which makes it possible to add refining schema validations to optional parameters [1]. [1]: shadcn-ui/ui#690 (comment) Signed-off-by: Jyrki Keisala <jyrki.keisala@doubleopen.org>
Optional inputs in controlled forms are problematic, because
(1) Specifying default values for them in the `useForm` hook leads to
unnecessary payload sent from the form, so rather keep them as
`undefined`, which means the corresponding parameter is not
included in the payload.
(2) Leaving them without default values causes a React warning about a
component transferring from uncontrolled to controlled state.
Alleviate these problems with a component specifically used for optional
inputs [1].
[1]: shadcn-ui/ui#410 (comment)
As an example of using `asOptionalField` utility function and `OptionalInput` component when handling optional inputs in forms, use them in the Admin section's user creation form. This form has quite many optional input fields, which, when left empty, are not included in the form payload. When they are non-empty, they are validated with Zod rules (for example, "email" field). Signed-off-by: Jyrki Keisala <jyrki.keisala@doubleopen.org>
Etsija
force-pushed
the
improve-form-handling
branch
from
ae88545 to
26dfd21
Compare
mnonnenmacher
approved these changes
Feb 10, 2025
There was a problem hiding this comment.
Looks good to me, but I would appreciate if @lamppu could also have a look as my React knowledge is limited.
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.
This PR gets rid of most React warnings about form components transferring from
uncontrolledtocontrolledstate by:Zodvalidation for optional fields, whenever user inputs something to them.As an example of handling optional fields, the user creation form is modified accordingly. If this approach is acceptable, other forms would be fixed in a follow-up PR.
This is a more proper alternative to #1946.
Please see the commits for details.