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

MUI Theme Config #137

Merged
merged 10 commits into from
Sep 27, 2022
Merged

MUI Theme Config #137

merged 10 commits into from
Sep 27, 2022

Conversation

brightiron
Copy link
Contributor

@brightiron brightiron commented Sep 19, 2022

Includes:

  • AppBar
  • Button
  • Card
  • Chip
  • Pagination
  • TextField
  • Typography
  • Dialog

@netlify
Copy link

netlify bot commented Sep 19, 2022

Deploy Preview for sporosdaoapp-dev ready!

Name Link
🔨 Latest commit e4dd2f6
🔍 Latest deploy log https://app.netlify.com/sites/sporosdaoapp-dev/deploys/6330ddc82d80ae00087510c9
😎 Deploy Preview https://deploy-preview-137--sporosdaoapp-dev.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 24, 2022

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@brightiron
Copy link
Contributor Author

I have read the CLA Document and I hereby sign the CLA

@brightiron
Copy link
Contributor Author

recheck

@brightiron brightiron changed the title [WIP] Design System Components MUI Theme Config Sep 25, 2022
@brightiron brightiron marked this pull request as ready for review September 25, 2022 23:10
@ivelin
Copy link
Contributor

ivelin commented Sep 26, 2022

GM @brightiron ! Starting review this morning.

Does it make sense to add a section to the frontend readme on Custom MUI Theme?

  • how to use
  • how to manually test
  • how to contribute
  • how to write regression tests

@brightiron
Copy link
Contributor Author

GM @brightiron ! Starting review this morning.

Does it make sense to add a section to the frontend readme on Custom MUI Theme?

  • how to use
  • how to manually test
  • how to contribute
  • how to write regression tests

i can add some docs around how to spin up the storybook server locally, and general guide for contributing new styles.
In terms of use, you'll just use the existing MUI components, and import those directly from mui. I didn't go the custom component route for this iteration.

The storybook itself would serve as a reference for usage/implementation/docs.

For regression tests, since these are really just css styles, there's not a ton to test. You could use something like chromatic though, if that's what your thinking.. but there's nothing to really to write for tests, as it just relies on storybook stories.

@ivelin
Copy link
Contributor

ivelin commented Sep 26, 2022

All sounds good. Please drop an update to README.md so anyone can follow along the same process and tools for styling.

I will tinker with yarn test fixes in a separate PR. No need to hold this one.

@ivelin
Copy link
Contributor

ivelin commented Sep 26, 2022

@brightiron are you able to use the app on this branch? I am getting wallet connectivity errors:

Screen Shot 2022-09-26 at 2 16 23 PM
Screen Shot 2022-09-26 at 2 16 33 PM
Screen Shot 2022-09-26 at 2 16 38 PM

Screen Shot 2022-09-26 at 2 19 17 PM
Screen Shot 2022-09-26 at 2 19 34 PM
Screen Shot 2022-09-26 at 2 20 01 PM

@ivelin
Copy link
Contributor

ivelin commented Sep 26, 2022

These metamask errors turned out to be a problem with metamask. The chrome extension crashed after a few more tries and after restarting it in the browser, it works again as expected. I experienced the same issue with a different version of the app.

@ivelin
Copy link
Contributor

ivelin commented Sep 26, 2022

I've spent some time testing the look and feel of the new styles. Noticing some visible changes that I am not sure are by design. For example accents disappeared from some pages. Tribute buttons are usually the primary color (blue in the default MUI app) and Active are usually in an accented green color. With the new theme all seem to show monochromatic for the most part.

Also the font sizes do not seem proportional as compared to the default look and feel. See screenshots.

How do we go about testing look and feel, fixing any open issues and preventing regression in a reliable way?

@ivelin
Copy link
Contributor

ivelin commented Sep 26, 2022

Screen Shot 2022-09-26 at 5 33 37 PM
Screen Shot 2022-09-26 at 5 33 45 PM
Screen Shot 2022-09-26 at 5 33 54 PM
Screen Shot 2022-09-26 at 5 34 05 PM
Screen Shot 2022-09-26 at 5 34 21 PM
Screen Shot 2022-09-26 at 5 34 29 PM
Screen Shot 2022-09-26 at 5 34 38 PM
Screen Shot 2022-09-26 at 5 34 46 PM
Screen Shot 2022-09-26 at 5 34 54 PM

@brightiron
Copy link
Contributor Author

Screen Shot 2022-09-26 at 5 33 37 PM Screen Shot 2022-09-26 at 5 33 45 PM Screen Shot 2022-09-26 at 5 33 54 PM Screen Shot 2022-09-26 at 5 34 05 PM Screen Shot 2022-09-26 at 5 34 21 PM Screen Shot 2022-09-26 at 5 34 29 PM Screen Shot 2022-09-26 at 5 34 38 PM Screen Shot 2022-09-26 at 5 34 46 PM Screen Shot 2022-09-26 at 5 34 54 PM

@ivelin, font sizes are implemented by the design system. I did not go through and update the app. There are several cases where MUI typography tags are not being used.. For example, MUI recommends using for an h6.

Buttons are implemented via the design system specification. For example:
image

Text buttons are implemented using the text button variant (see above). Which is monochromatic by netbees design.

if you run yarn storybook locally, you will spin up a storybook instance where you can see all the different states implemented.

If a style is off, i.e. you previously had a 'text' button implemented, but it should be a 'contained' button instead, you'll need to implement a different variant.

Again, the scope of this PR was purely css changes and implementing styling over existing components to align with the future design system. In a couple limited cases i adjusted the main layout to show a simple implementation example, but adjustments to the site will still need to be made to align properly with material UI usage and Netbee's new designs.

Hope that clears things up. Anything else around issues w/ functionality of the site (wallet connection) wouldn't have been touched with this PR

@brightiron
Copy link
Contributor Author

running yarn storybook locally will allow you to independently verify mui styling. as well as how to implement specific styles:
image

image

image

@ivelin
Copy link
Contributor

ivelin commented Sep 27, 2022

OK. Merging this PR. Let's discuss separately how to polish the app so it matches netbee's figma work.

@ivelin ivelin merged commit 81bf3c7 into SporosDAO:dev Sep 27, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Sep 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sporos DAO branded custom React MUI components
2 participants