Skip to content

[No QA] Update getInputIDPropTypes docs #7754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tgolen merged 3 commits into from
Feb 15, 2022
Merged

[No QA] Update getInputIDPropTypes docs #7754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
303ee05
update getInputIDPropTypes docs
luacmartins Feb 15, 2022
78c468d
change getInputIDPropTypes to validateInputIDProps
luacmartins Feb 15, 2022
7793375
exactly match prop
luacmartins Feb 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/TextInput/baseTextInputPropTypes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const propTypes = {
* @param {Object} props - props passed to the input
* @returns {Object} - returns an Error object if isFormInput is supplied but inputID is falsey or not a string
*/
inputID: props => FormUtils.getInputIDPropTypes(props),
inputID: props => FormUtils.validateInputIDProps(props),

/** Saves a draft of the input value when used in a form */
shouldSaveDraft: PropTypes.bool,
Expand Down
8 changes: 4 additions & 4 deletions src/libs/FormUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
/**
* Gets the prop type for inputID
* Custom prop validator that enforces inputID as a required string if isFormInput is true
*
* @param {Object} props - props passed to the input component
* @returns {Object} returns an Error object if isFormInput is supplied but inputID is falsey or not a string
*/
function getInputIDPropTypes(props) {
function validateInputIDProps(props) {
if (!props.isFormInput) {
return;
}
if (!props.inputID) {
return new Error('InputID is required if isFormInput prop is supplied.');
return new Error('inputID is required if isFormInput is true');
}
if (typeof props.inputID !== 'string') {
return new Error(`Invalid prop type ${typeof props.inputID} supplied to inputID. Expecting string.`);
Expand All @@ -18,5 +18,5 @@ function getInputIDPropTypes(props) {

export {
// eslint-disable-next-line import/prefer-default-export
getInputIDPropTypes,
validateInputIDProps,
};