Remote functions form enhance documentation is confusing
Open
Nobody has claimed this yet.
documentation
forms
- Dominant language
- JavaScript
- Stars
- 20.8k
- Forks
- 2.3k
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 156
Description
Describe the bug
The current example
<form {...createPost.enhance(async ({ form, data, submit }) => {
try {
await submit();
form.reset();
showToast('Successfully published!');
} catch (error) {
showToast('Oh no! Something went wrong');
}
})}>
<!-- -->
</form>
gives the impression, given the preceding examples with validation, that a successful submit() implicitly means that the validation was successful.
The documentation would be better if it showed explicit handling of failed validation.
Reproduction
N/A
Logs
N/A
System Info
N/A
Severity
annoyance
Additional Information
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Remote functions form-enhance example and compare it with the preceding validation examples. Update the documentation to show explicit handling of failed validation after submit(), and verify that the example no longer implies that a successful submission means validation succeeded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100