Skip to content
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.

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

[HOLD] fix: improve mobile's inline code block font and alignment #15367

Closed
wants to merge 1 commit into from

Conversation

fabioh8010
Copy link
Contributor

Details

Made some changes in mobile's inline code block to have a scalable font just like the other texts and not cut emojis, and improved some stylings to make the code block more aligned with the text. This is a temporary solution until I have a proper fix to the react-native issue that is the root cause of this misalignment problem.

Fixed Issues

$ #8132
PROPOSAL: #8132 (comment)

Tests

  1. Go to any chat
  2. Send a message that contains inline code blocks and emojis e.g. Lorem ipsum `dolor 🚀` sit amet, con`s``e`ctetur `adipiscing elit, sed do eiusmod tempor incididunt` ut labore et dolore `magna` ali`q`u`a`. 🚀
  3. Verify if the inline code blocks are properly aligned with the normal text and if emojis are not being cut.
  4. Increase the system or browser font size (if applicable). It should also increase the inline code block font properly.

Offline tests

This feature doesn't change or is impacted by offline mode.

QA Steps

Same as above.

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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. toggleReport and not onIconClick)
    • 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 is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is correct English and approved by marketing by adding the Waiting for Copy label 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
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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 this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • 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 any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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 Avatar is modified, I verified that Avatar is 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.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Screen.Recording.2023-02-22.at.18.39.11.mov
Screen.Recording.2023-02-22.at.18.40.48.mov
Mobile Web - Chrome
Screen.Recording.2023-02-22.at.18.44.55.mov
Mobile Web - Safari
Screen.Recording.2023-02-22.at.18.45.53.mov
Desktop
Screen.Recording.2023-02-22.at.18.47.25.mov
iOS
Screen.Recording.2023-02-22.at.18.49.00.mov
Android
Screen.Recording.2023-02-22.at.18.51.27.mov

@fabioh8010 fabioh8010 requested a review from a team as a code owner February 22, 2023 19:07
@melvin-bot melvin-bot bot requested review from Santhosh-Sellavel and stitesExpensify and removed request for a team February 22, 2023 19:07
@MelvinBot
Copy link

@stitesExpensify @Santhosh-Sellavel One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stitesExpensify

Code Looks good, but I will like to test it a bit more extensively so I would test it over the weekend.

@stitesExpensify
Copy link
Contributor

Hi @Santhosh-Sellavel did you get a chance to test this weekend like you planned?

@Santhosh-Sellavel
Copy link
Collaborator

Sorry didn't able to test extensively as I planned, caught occupied with other items and will update you by today or tomorrow.

@Santhosh-Sellavel
Copy link
Collaborator

Alignment is weird on iOS, line spacing for a code block

Now

Screenshot 2023-03-03 at 12 49 46 AM

Before

Screenshot 2023-03-03 at 12 53 39 AM

@fabioh8010
Copy link
Contributor Author

Hi @Santhosh-Sellavel, I will take a look on this today.

@fabioh8010
Copy link
Contributor Author

fabioh8010 commented Mar 7, 2023

Hi @Santhosh-Sellavel !

Tweaking a little bit with the positioning in iOS, what do you think about this?

diff --git a/src/styles/codeStyles/index.ios.js b/src/styles/codeStyles/index.ios.js
index a387609040..0dfd3babfc 100644
--- a/src/styles/codeStyles/index.ios.js
+++ b/src/styles/codeStyles/index.ios.js
@@ -7,7 +7,7 @@ const codeWordWrapper = {
 
 const codeWordStyle = {
     position: 'relative',
-    top: 2.5,
+    top: 3.5,
 };
 
 const codeTextStyle = {

Screenshot 2023-03-07 at 14 21 56

Screenshot 2023-03-07 at 14 24 46

As stated before, this is a workaround so the alignment won't be perfect until I get a proper fix for this on native side. We can also explore what was proposed here.

@Santhosh-Sellavel
Copy link
Collaborator

@stitesExpensify Can we have a check with design or lets proceed?

@stitesExpensify
Copy link
Contributor

@fabioh8010 can you create a before and after so that we can tag design and have them pick between them?

@fabioh8010
Copy link
Contributor Author

Sure @stitesExpensify , I'm OOO at the moment but I'll return on Tuesday and provide some examples to present to the design team!

@fabioh8010
Copy link
Contributor Author

Hi @stitesExpensify @Santhosh-Sellavel , today I came across this PR while helping a team member with testing and we noticed that that PR could help us solving this back tick issue properly, without workarounds. The idea here would be using this new prop textCodeBlock to stylise the code blocks instead of using a View, thus avoiding the misalignment problem we currently have.

What do you think? Is it worth waiting for that PR and internal RN update to be available for us in order to proceed with a proper fix on my PR?

@fabioh8010
Copy link
Contributor Author

@stitesExpensify @Santhosh-Sellavel Did you have opportunity to read my last comment?

@Santhosh-Sellavel
Copy link
Collaborator

I've read already It makes sense to wait here cc: @stitesExpensify

@stitesExpensify
Copy link
Contributor

I agree that it makes sense to wait. Not using a workaround seems worth it to me!

@stitesExpensify stitesExpensify changed the title fix: improve mobile's inline code block font and alignment [HOLD] fix: improve mobile's inline code block font and alignment Apr 6, 2023
@fabioh8010
Copy link
Contributor Author

Update: The old PR was closed, and now a new one is being prepared to fix those related issues.

@stitesExpensify
Copy link
Contributor

Since there hasn't been movement on that PR in ~6 months, should we close this PR for now?

@fabioh8010
Copy link
Contributor Author

@stitesExpensify I think yes, we can open later if necessary.

@fabioh8010 fabioh8010 closed this Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants