Standardize form error styles #12098
Conversation
|
Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers! |
melvin-bot
bot
requested review from
mountiny and
parasharrajat
and removed request for
a team
src/components/FormHelpMessage.js
Outdated
| const propTypes = { | ||
| message: PropTypes.node, | ||
|
|
||
| children: PropTypes.node, | ||
|
|
||
| isError: PropTypes.bool, | ||
|
|
||
| // eslint-disable-next-line react/forbid-prop-types | ||
| style: PropTypes.arrayOf(PropTypes.object), |
There was a problem hiding this comment.
Missing comments. Check styleGuide.
src/components/FormHelpMessage.js
Outdated
| const propTypes = { | ||
| message: PropTypes.node, | ||
|
|
||
| children: PropTypes.node, | ||
|
|
||
| isError: PropTypes.bool, | ||
|
|
||
| // eslint-disable-next-line react/forbid-prop-types | ||
| style: PropTypes.arrayOf(PropTypes.object), |
There was a problem hiding this comment.
Please use stylePropTypes via import.
src/styles/styles.js
Outdated
| formHelpMessage: { | ||
| display: 'flex', | ||
| flexDirection: 'row', | ||
| alignItems: 'center', | ||
| }, |
There was a problem hiding this comment.
Please use style util objects. e.g. styles.flexRow etc.
There was a problem hiding this comment.
@shawnborton Would you be able to give a look at this design change? For me I feel like the error message below the checkbox feels a bit off compared to the other dots/messages.
It might be given the checkbox being larger than the text and then there is different padding between the box and the label and the error message. But curious for your thoughts
|
I think it's okay, but I think I would add another 4px margin between the indicator message and the input above for both text inputs and the checkbox. |
src/components/FormAlertWrapper.js
Outdated
| <> | ||
| {`${props.translate('common.please')} `} | ||
| <TextLink | ||
| style={styles.label} | ||
| onPress={props.onFixTheErrorsLinkPressed} | ||
| > | ||
| {props.translate('common.fixTheErrors')} | ||
| </TextLink> | ||
| {` ${props.translate('common.inTheFormBeforeContinuing')}.`} | ||
| </> |
There was a problem hiding this comment.
We don't use such patterns where UI blocks are passed as props.
What you can do is?
- this part can be passed as children like
RenderHTML. - Else if part is only message which you can directly pass to the message prop.
- See next comment.
There was a problem hiding this comment.
We don't use such patterns where UI blocks are passed as props
@parasharrajat I did this because it shouldn't be rendered inside View but Text (to fix wrap issue in #11410)
So what I suggest is that remove message prop and use only children. But instead introduce useDirectChildren prop whether to put children inside Text or not
What do you think?
There was a problem hiding this comment.
useDirectChildren just feels confusing to me. It will become difficult for others to reason whether to use useDirectChildren or not in the future.
Instead, the message clearly indicates that it accepts simple text. Only a few cases will require using the children varient if the user has to put in complex rendering logic.
There was a problem hiding this comment.
@parasharrajat updated from your feedback and pushed
src/components/FormHelpMessage.js
Outdated
| {!_.isEmpty(props.message) ? ( | ||
| <Text style={[props.isError ? styles.formError : styles.formHelp, styles.flex1, styles.mb0, styles.ml2]}> | ||
| {props.message} | ||
| </Text> | ||
| ) : <View style={[styles.flex1, styles.ml2]}>{props.children}</View>} |
There was a problem hiding this comment.
Now reverse this condition. Children take priority. When children is passed override the props.message's Text block.
|
#12098 (comment) |
@shawnborton added another 4px |
|
Nice, looks good to me! |
There was a problem hiding this comment.
Nice one @0xmiroslav code looks fine to me.
Leaving for @parasharrajat for final tests and then we can merge!
| {props.isError && <Icon src={Expensicons.DotIndicator} fill={colors.red} />} | ||
| <View style={[styles.flex1, styles.ml2]}> | ||
| {props.children || ( | ||
| <Text style={[props.isError ? styles.formError : styles.formHelp, styles.mb0]}> |
There was a problem hiding this comment.
| <Text style={[props.isError ? styles.formError : styles.formHelp, styles.mb0]}> | |
| <Text style={[props.isError ? styles.formError : styles.formHelp]}> |
Do we need mb0 here?
There was a problem hiding this comment.
yes because both styles.formError and styles.formHelp have marginBottom: 4 and this bottom margin is already applied in parent View here (styles.mb1)
And also for vertically centered with red dot
src/components/FormHelpMessage.js
Outdated
| } | ||
|
|
||
| return ( | ||
| <View style={[styles.dFlex, styles.flexRow, styles.alignItemsCenter, styles.mt2, styles.mb1, ...props.style]}> |
There was a problem hiding this comment.
| <View style={[styles.dFlex, styles.flexRow, styles.alignItemsCenter, styles.mt2, styles.mb1, ...props.style]}> | |
| <View style={[styles.flexRow, styles.alignItemsCenter, styles.mt2, styles.mb1, ...props.style]}> |
|
Looks like the margin or style is applied before the error string on Should we move the error inside the wrapper? This PR does not cause this issue. It was already there but as we are refactoring the design I think we should think about it thoroughly. |
I agree |
|
@parasharrajat I fixed your feedback and pushed |
|
Thanks, I will rereview it. |
| </Text> | ||
| ); | ||
| } else if (props.isMessageHtml) { | ||
| children = <RenderHTML html={`<muted-text>${props.message}</muted-text>`} />; |
There was a problem hiding this comment.
You will have to modify the style for muted-text
Also, please add a new story that usage RenderHTML variant.
There was a problem hiding this comment.
@parasharrajat this is done
Also added video for this case
|
@mountiny does this look correct to show the HTML server errors in red too? |
|
I think that would make sense but how did you get the large h1 style in there? |
|
I think But I am sure that the server will never send a header in error. This is a test so we can add anything. |
There was a problem hiding this comment.
@parasharrajat oh that looks "interesting" 😄 I dont think ti is actively used for the RBR errors, but seems like fine thing to have in place.
Seems like we are getting closer with this one, great job @0xmiroslav and @parasharrajat ! 🎉
|
Thanks for confirmation. I will test it soon. |
|
@parasharrajat I am not 100% sure, I would say my preference so I would wait for @shawnborton to confirm |
There was a problem hiding this comment.
LGTM.
cc: @mountiny
Screenshots
🔲 iOS / native
🔲 iOS / Safari
🔲 MacOS / Desktop
🔲 MacOS / Chrome
🔲 Android / Chrome
🔲 Android / native
PR Reviewer Checklist
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issuessection above - I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I verified the steps for local testing are in the
- I checked that screenshots or videos are included for tests on all platforms
- I included screenshots or videos for tests on all platforms
- I verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- MacOS / Desktop
- If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
- I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
toggleReportand notonIconClick). - I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product was added in all
src/languages/*files - I verified any copy / text that was added to the app is correct English and approved by marketing by adding the
Waiting for Copylabel for a copy review on the original GH to get the correct copy. - I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in
STYLE.md) were followed
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e.
- If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
- I verified that this PR follows the guidelines as stated in the Review Guidelines
- I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like
Avatar, I verified the components usingAvatarhave been tested & I retested again) - I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
- I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
- If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a
/** comment above it */ - The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
- If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
- If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like
Avataris modified, I verified thatAvataris working as expected in all cases) - If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
- I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
There was a problem hiding this comment.
I approved it because the current code is working fine.
But let's wait for.
- Standardize form error styles #12098 (review).
- @0xmiroslav Please merge main.
|
@parasharrajat Amazing, thank you very much 🙇 |
@parasharrajat they look fine as they are with everything vertically middle-aligned. |
|
That's what I thought. @mountiny All yours. |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀
|
1 similar comment
|
🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀
|
|
🚀 Deployed to production by @yuwenmemon in version: 1.2.24-4 🚀
|
| {children} | ||
| </FormHelpMessage> | ||
| )} | ||
| {props.children(props.network.isOffline)} |
There was a problem hiding this comment.
I'm lost. Why did we need this? Can't we just subscribe to the Onyx network key instead of rendering a child?
| </View> | ||
| </View> | ||
| )} | ||
| {props.children(props.network.isOffline)} |
There was a problem hiding this comment.
I'm lost. Why did we need this? Can't we just subscribe to the Onyx network key instead of rendering a child?
@marcaaron that was already existing code before this PR
There was a problem hiding this comment.
Ok thanks, let's see maybe it was me who added it lol
Details
FormHelpMessagewhich accepts both error text and hint text as childrenFormHelpMessageAffected components:
FormAlertWrapper,BaseTextInput,Picker,CheckboxWithLabel,RadioButtonWithLabelFixed Issues
$ #11908
PROPOSAL: #11908 (comment)
Tests
Scenario 1:
Save & continuebuttonScenario 2:
policyRoomsbeta enabledCreate RoombuttonScenario 3:
Phone or emailfield (i.e.abc)Design guideline is here
QA Steps
Scenario 1:
Save & continuebuttonScenario 2:
policyRoomsbeta enabledCreate RoombuttonScenario 3:
Phone or emailfield (i.e.abc)Design guideline is here
PR Review Checklist
PR Author Checklist
### Fixed Issuessection aboveTestssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*filesWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)Avataris modified, I verified thatAvataris working as expected in all cases)PR Reviewer Checklist
The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed
### Fixed Issuessection aboveTestssectionQA stepssectiontoggleReportand notonIconClick).src/languages/*filesWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarhave been tested & I retested again)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)Avataris modified, I verified thatAvataris working as expected in all cases)Screenshots
Web
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android
Storybook
Screen.Recording.2022-11-01.at.9.38.51.PM.mov