Doc tweaks: Arrange FormState
's properties in cagtegories
#462
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.
Hello.
I really appreciate this lib's reasonable and simple design.
Let me contribute on improving docs for our better understanding and wider spreading.
Background
I have difficulty on understanding the outline of the FormState type document.
Especially, it is very hard to visualize in mind the relation between each properties
for example,
pristine === !dirty
hasXErrors
for existence of any error (to prevent submit)xError
only for whole form errorxErrors
for errors in fieldsHonestly, I think doc's comprehensibility is a big problem and barrier for me to introduce this lib for my co-worker or Japanese brothers/sisters.
To confess, until this work, I didn't understand the whole picture of relations.
What I did in this PR
Preview in Github
Preview in Github