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

Set up Material UI Theme in accordance with the Style Guide #517

Closed
4 tasks
entrotech opened this issue Jun 15, 2020 · 1 comment
Closed
4 tasks

Set up Material UI Theme in accordance with the Style Guide #517

entrotech opened this issue Jun 15, 2020 · 1 comment
Labels
Feature: Design System Standards, documentation and guide of design assets and components Missing: Size The effort estimate for this issue is missing Release Note: Tech Debt Shows on Release Notes under "Technical Debt" Role: Front-end Front End Developer
Milestone

Comments

@entrotech
Copy link
Member

entrotech commented Jun 15, 2020

Overview

The UX/UI team has almost finalized a Style Guide here https://www.figma.com/file/D3oq9QOXl0rFkwrEUJbABs/Fola-Design-System?node-id=174%3A0
(Replace the above link with a link to the finalized style guide when available). The code in the application uses the Material-UI library, which can support themes to ensure consistency of some aspects of the component styling. It has been suggested that much of the application styling can be accomplished through customizing a Material UI theme to be consistent with the style guide.

Other aspects of the styling (maybe page layout, margins,etc.) probably need additional styling with styled components or JSS or something, but we probably need to decide on the preferred approach and use it consistently across the application. This issue is "leading the way" in standardizing on a styling approach for the whole project.

Action Items

  • Review any existing Material UI theming and compare to the colors, fonts, etc. in the style guide.
  • Decide what aspects of the style guide can be implemented via the Material UI theme, and implement them.
  • Determine what other aspects of styling and layout cannot be accomplished via the theme, and determine the preferred approach (styled components, JSS, etc.). It needs to support media queries, pseudo classes, etc..
  • Use the Verification Admin dashboard as a first component to try all this out on (Also created as a separate issue (Improve Styling of VerificationAdmin component #518 )

Resources/Instructions

https://www.figma.com/file/D3oq9QOXl0rFkwrEUJbABs/Fola-Design-System?node-id=174%3A0

@entrotech entrotech added Role: Front-end Front End Developer Release Note: Tech Debt Shows on Release Notes under "Technical Debt" labels Jun 15, 2020
@entrotech entrotech added this to the FOLA V2 milestone Jun 15, 2020
@motorcykey motorcykey self-assigned this Jun 16, 2020
@motorcykey
Copy link
Member

Based on how Material UI maps out their "variants" and styles their button components, here's how I best found to map the typography styles to the Material UI variants which I can re-style:

  • h1 = Heading 1
  • h2 = Heading 2
  • h3 = Heading 3
  • h4 = Body Big 1
  • h5 = Body Big 2
  • h6 = Body Small 1
  • body1 = Body Small 2
  • body2 = Body Small Italic
  • BUTTON = BUTTON SMALL
  • OVERLINE = BUTTON BIG
  • Caption = Small Text
  • Default Typography (no variant) = Body Small 2

I've created a JS file which will hold all of the colors so we can easily look up & edit our hex codes which will be used through the theme and any custom components.

When I say "custom components" I'm referring to anything more complex than what Material UI offers out-of-the-box. What we're able to do is create re-usable custom versions of Material UI's components that extend their out-of-box features. As an example, I started work on a CustomButton which covers a lot of the cases shown for the non-toggle states in the style guide (Primary, Secondary, Button, Big/Small, etc) - all within a singular component.

Since I don't want to update the existing app's theme before MVP, I'll work on committing this code change in the next day or two as a new/separate theme file & component library from what's already in there.

motorcykey pushed a commit to motorcykey/food-oasis that referenced this issue Jun 26, 2020
motorcykey pushed a commit to motorcykey/food-oasis that referenced this issue Jun 26, 2020
@gigicobos gigicobos added the Feature: Design System Standards, documentation and guide of design assets and components label Jul 22, 2021
@ExperimentsInHonesty ExperimentsInHonesty added the Missing: Size The effort estimate for this issue is missing label Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature: Design System Standards, documentation and guide of design assets and components Missing: Size The effort estimate for this issue is missing Release Note: Tech Debt Shows on Release Notes under "Technical Debt" Role: Front-end Front End Developer
Projects
Archived in project
Development

No branches or pull requests

5 participants