Add default value documentation to props #44
Merged
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.
Related to #9
We want to see if we can further take advantage of typescript and add information about the props. In this PR we update to provide the MJML default values (i.e. the fallback if the value is undefined)
One caveat here is that this is not a react default/fallback. It is the default from MJML itself. That is why I chose to not use the jsdoc tags, as I feel like they suggest a default value in react, not in MJML itself.
We could alternatively add the value as a default value in React, but this seems superfluous as it forces that value to be set in react when it is a fallback anyway in MJML.
Let me know what you think.