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

Upgrade to react-bootstrap V2 with Bootstrap V5 #1394

Merged

Conversation

Antonio-Maranhao
Copy link
Contributor

@Antonio-Maranhao Antonio-Maranhao commented Mar 29, 2023

Overview

Replaces the unsupported version of react-bootstrap with the latest v2, which also required upgrading to Bootstrap v5.

A series of enhancements were done as part of the upgrade to Bootstrap 5. Most of these did not affect Fauxton design, although some changes were intentionally done to improve UX consistency and accessibility of the application.

Highlights:

  • Bootstrap is now installed as an npm package. The old bootstrap folder and its .less files were removed.
  • Bootstrap V5 required migrating from Less to Sass to compile the CSS
  • All CSS was updated to use variables instead of color literals, leading to all colors values being defined in _variables.scss.
  • As part of consolidating the use of colors, similar colors were removed in order to improve consistency across pages and components.
  • Some background and text colors were modified to improve accessibility. The goal was to achieve a minimum of 5:1 color contrast, which satisfies WCAG level AA.

Quick acknowledgement: Many thanks to @fryjordan who helped me put this together.

Testing recommendations

  • Run dev server and visually inspect the pages
  • There were no changes in behavior, so the current unit and e2e tests are enough to prove the application still works.

GitHub issue number

n/a

Related Pull Requests

n/a

Checklist

  • Code is written and works correctly;
  • Changes are covered by tests;
  • Documentation reflects the changes;
  • Update rebar.config.script with the correct tag once a new Fauxton release is made

The upgrade to bootstrap V5 required migrating from Less to Sass.
All CSS was updated to use variables instead of color literals,
leading to all colors being defined in _variables.scss.
Similar colors were also removed in order to improve consistency across
different pages and components.
@Antonio-Maranhao Antonio-Maranhao marked this pull request as ready for review March 29, 2023 15:09
Copy link
Contributor

@fryjordan fryjordan left a comment

Choose a reason for hiding this comment

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

LGTM!

@Antonio-Maranhao Antonio-Maranhao merged commit b0da14d into apache:main Mar 30, 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.

3 participants