docs: Call out FormInput's props explicitly #471
Conversation
truclyle
changed the title
truclyle
changed the title
| type: PropTypes.string, | ||
| value: PropTypes.string | ||
| }; | ||
|
|
There was a problem hiding this comment.
prop description should be provided for all non default props seen here:
src/Forms/FormInput.js
Outdated
|
|
||
| FormInput.propDescriptions = { | ||
| disabled: 'Set to **true** to mark component as disabled and make it non-interactive.', | ||
| readOnly: 'Set to **true** to mark component as readonly.', |
There was a problem hiding this comment.
those are default props - their descriptions will be assigned automatically by https://github.com/SAP/fundamental-react/blob/master/src/_playground/documentation/Properties/defaults.js
You will need add descriptions here for name, state, and arguably type as the definition differs here.
There was a problem hiding this comment.
Ok, I want to make sure I understand you correctly.
The descriptions at https://github.com/SAP/fundamental-react/blob/master/src/_playground/documentation/Properties/defaults.js are automatically added.
What I need to provide are the descriptions for the props (name, value) that are not described in the above file as well as modify type's description to reflect the FormInput component.
greg-a-smith
left a comment
greg-a-smith
left a comment
There was a problem hiding this comment.
@truclyle There should not be any changes in the package-lock.json file since there are no changes in the package.json file. It's likely a version mismatch that's causing it. We are using Node Version Manager and running Node 10.15.0, which comes bundled with NPM 6.4.1.
greg-a-smith
left a comment
greg-a-smith
left a comment
There was a problem hiding this comment.
Looks good. 🚢 Thanks for the contribution!
3 participants
Description
Call out more of FormInput's props explicitly for PropType validation using FormRadioItem as a model.
fixes #464