Skip to content

[NoQA] Add AvatarSelector component#72214

Merged
grgia merged 9 commits into
Expensify:mainfrom
software-mansion-labs:feat/add-avatar-selector-component
Oct 14, 2025
Merged

[NoQA] Add AvatarSelector component#72214
grgia merged 9 commits into
Expensify:mainfrom
software-mansion-labs:feat/add-avatar-selector-component

Conversation

@jmusial

@jmusial jmusial commented Oct 9, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

This PR adds a new AvatarSelector to be used while implementing #71653.

Fixed Issues

$ #71886

PROPOSAL:

Tests

  1. Open storybook
  2. Check AvatarSelector

Offline tests

n/a

QA Steps

n/a

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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.ts 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 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(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Screen.Recording.2025-10-09.at.15.30.14.mov

@jmusial jmusial changed the title Add AvatarSelector component [NoQA] Add AvatarSelector component Oct 9, 2025
@grgia grgia requested review from dukenv0307 and grgia October 9, 2025 13:39
@jmusial jmusial marked this pull request as ready for review October 9, 2025 14:15
@jmusial jmusial requested review from a team as code owners October 9, 2025 14:15
@melvin-bot melvin-bot Bot requested review from stitesExpensify and removed request for a team October 9, 2025 14:15
@melvin-bot

melvin-bot Bot commented Oct 9, 2025

Copy link
Copy Markdown

@stitesExpensify Please 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]

@shawnborton

Copy link
Copy Markdown
Contributor

Looking good! Any way to organize these by color? I think that's what @dannymcclain had in mind at least.

@codecov

codecov Bot commented Oct 9, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 43.58974% with 22 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/stories/Avatar.stories.tsx 0.00% 11 Missing ⚠️
src/stories/AvatarSelector.stories.tsx 0.00% 10 Missing ⚠️
src/components/AvatarSelector.tsx 88.88% 0 Missing and 1 partial ⚠️
Files with missing lines Coverage Δ
src/components/Avatar.tsx 100.00% <ø> (ø)
src/libs/Avatars/CustomAvatarCatalog.ts 100.00% <100.00%> (ø)
src/styles/index.ts 45.35% <ø> (ø)
src/components/AvatarSelector.tsx 88.88% <88.88%> (ø)
src/stories/AvatarSelector.stories.tsx 0.00% <0.00%> (ø)
src/stories/Avatar.stories.tsx 0.00% <0.00%> (ø)

... and 169 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dannymcclain

Copy link
Copy Markdown
Contributor

Looking good! Any way to organize these by color?

Yeah that would be ideaaaal!

@dukenv0307

Copy link
Copy Markdown
Contributor

Looks good. But we'll implement this selector in the avatar page, right?

Screen.Recording.2025-10-10.at.00.07.14.mov

@jmusial

jmusial commented Oct 10, 2025

Copy link
Copy Markdown
Contributor Author

@dukenv0307 the idea was to implement just the component in this task and integrate it in #71890 to keep PRs small and your work easier :)

I'm gonna be working on integration today

cc. @grgia

@grgia grgia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@dukenv0307 That's correct, we will add them in the next issue. The plan is to only add the component in this PR. Mostly because I want to keep the release PRs small 😁

@jmusial I DMd you a diff for the avatar order, we could add that in this PR if you'd like

@grgia

grgia commented Oct 10, 2025

Copy link
Copy Markdown
Contributor

Looking good! Any way to organize these by color?

@dannymcclain already on it, here's the diff for that

didsdsdff.txt

@grgia

grgia commented Oct 10, 2025

Copy link
Copy Markdown
Contributor

@jmusial added here, dw! #72331

const styles = useThemeStyles();
const StyleUtils = useStyleUtils();
const [selected, setSelected] = useState(selectedID);

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

PERF-4

Object.entries(ALL_CUSTOM_AVATARS) creates a new array instance on every render. Since this array is used in the render loop below, React cannot optimize re-renders effectively as the reference changes every time.

Suggested fix:

const avatars = useMemo(() => Object.entries(ALL_CUSTOM_AVATARS), []);

Since ALL_CUSTOM_AVATARS is a constant catalog, the dependency array can be empty.

<>
{!!label && (
<View style={[styles.pt5, styles.ph2]}>
<Text style={StyleUtils.combineStyles([styles.sidebarLinkText, styles.optionAlternateText, styles.textLabelSupporting, styles.pre])}>{label}</Text>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

PERF-4

StyleUtils.combineStyles([...]) creates a new array on every render and combines it into a new style object. This new object reference causes unnecessary re-renders of the Text component.

Suggested fix:

const labelStyle = useMemo(
    () => StyleUtils.combineStyles([styles.sidebarLinkText, styles.optionAlternateText, styles.textLabelSupporting, styles.pre]),
    [StyleUtils, styles.sidebarLinkText, styles.optionAlternateText, styles.textLabelSupporting, styles.pre]
);

// Then use it:
<Text style={labelStyle}>{label}</Text>

Or simply use array syntax directly without combineStyles:

<Text style={[styles.sidebarLinkText, styles.optionAlternateText, styles.textLabelSupporting, styles.pre]}>{label}</Text>

Comment thread src/components/AvatarSelector.tsx Outdated
accessible
accessibilityRole="button"
accessibilityLabel="Select Avatar"
onPress={() => handleSelect(id as keyof typeof ALL_CUSTOM_AVATARS)}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

PERF-4

This code creates a new style array and a new style object ({borderColor: theme.success, borderWidth: 2}) on every iteration of the map loop. Since this is rendering potentially dozens of avatars, this creates significant memory churn and prevents React from optimizing re-renders.

Suggested fix:

Move the selected border style outside the map:

const selectedBorderStyle = useMemo(
    () => ({borderColor: theme.success, borderWidth: 2}),
    [theme.success]
);

// Then in the map:
return (
    <PressableWithFeedback
        key={id}
        accessible
        accessibilityRole="button"
        accessibilityLabel="Select Avatar"
        onPress={() => handleSelect(id as keyof typeof ALL_CUSTOM_AVATARS)}
        style={[styles.avatarSelectorWrapper, isSelected && selectedBorderStyle]}
    >

@dukenv0307

Copy link
Copy Markdown
Contributor

@jmusial I DMd you a diff for the avatar order, we could add that in this PR if you'd like

@jmusial do you have a plan to do it?

@jmusial

jmusial commented Oct 13, 2025

Copy link
Copy Markdown
Contributor Author

Updated sorting
image

@jmusial

jmusial commented Oct 13, 2025

Copy link
Copy Markdown
Contributor Author

@jmusial I DMd you a diff for the avatar order, we could add that in this PR if you'd like

@jmusial do you have a plan to do it?

Yup, just added that. Sorry on Fri I was preoccupied by other tasks.

@grgia grgia left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I can close #72331 if we want to use this, but let me know thoughts here! Else LGTM

'wrenches-pink600': {local: SeasonF1.WrenchesPink600, url: `${CDN_SEASON_F1}/wrenches-pink600.png`},
};

const DISPLAY_ORDER = [

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

https://github.com/Expensify/App/pull/72331/files

I made some slight improvements in this PR- want to integrate those?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

@dukenv0307

Copy link
Copy Markdown
Contributor

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 Issues section 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 Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • 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 checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • 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. 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
    • 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 grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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 using Avatar have 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.ts 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 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(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
Screen.Recording.2025-10-13.at.22.21.07.mov
MacOS: Desktop

@dukenv0307

Copy link
Copy Markdown
Contributor

LGTM

@dukenv0307

Copy link
Copy Markdown
Contributor

@jmusial We have 1 comment that need to resolve

@jmusial

jmusial commented Oct 14, 2025

Copy link
Copy Markdown
Contributor Author

@jmusial We have 1 comment that need to resolve

updated

@melvin-bot melvin-bot Bot requested a review from grgia October 14, 2025 08:43
@grgia grgia merged commit 1a6a616 into Expensify:main Oct 14, 2025
23 checks passed
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/grgia in version: 9.2.31-0 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.2.31-2 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

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.

6 participants