[form] Documentation on the `onClearErrors` prop for the form component is insufficient

[marcospgp]

Event handler called when the errors object is cleared.

it doesn't say when the errors object is cleared or why. thanks!

https://base-ui.com/react/components/form

[mj12albert]

@marcospgp Are you already using it? Or is it not working as you expected

I guess the name onClearErrors is kind of misleading, it's called whenever one error is cleared e.g. when the user corrects a wrong value (and not errors plural as the name may imply), and the errors arg are the remaining errors in the form

Maybe it would be helpful to provide the name of the field that was cleared of an error in the callback as well

[marcospgp]

@mj12albert personally I'm generally not finding form error handling useful, I just handle validation independently for each field because managing a dictionary of errors keyed by input field name seems like it would be way too much trouble.

I just validate fields independently. And as long as they are validated when the form is submitted, then it works fine.

Then if the server returns an error that the client-side validation did not catch, I just assume that that is a bug and display a generic error dialog, similarly to whenever any other unhandled exception would occur.

[mj12albert]

onClearErrors will be dropped in #2758

Instead external errors are always cleared on change as they cannot be revalidated internally by <Form>, will also add more docs on using external/server-side errors in #2989

[github-actions]

This fix will be available in the next npm release of Base UI.

In the meantime, you can try it out on our Canary release channel:

npm i https://pkg.pr.new/@base-ui-components/react@3136