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

Adding HelpText component #16293

Merged
merged 4 commits into from
Nov 3, 2022
Merged

Conversation

georgewrmarshall
Copy link
Contributor

@georgewrmarshall georgewrmarshall commented Oct 27, 2022

Explanation

Adding HelpText component that will eventually be used with TextField and Label to create FormTextField.

More Information

Screenshots/Screencaps

After

Screen.Recording.2022-10-27.at.2.34.52.PM.mov

Manual Testing Steps

  • Go to the latest build of Storybook in this PR
  • Search HelpText in the search bar
  • Check story controls
  • Check stories
  • Check docs

Pre-Merge Checklist

  • PR template is filled out
  • IF this PR fixes a bug, a test that would have caught the bug has been added
  • PR is linked to the appropriate GitHub issue
  • PR has been added to the appropriate release Milestone

+ If there are functional changes:

  • Manual testing complete & passed
  • "Extension QA Board" label has been applied

Acceptance Criteria

  • Has a className prop and the PropType descriptions are all the same
  • Prop table in MDX docs have the "Accepts all Box component props" description and link
  • We are consistent when using the same prop names like size and are suggesting the use of the generalized design-system.js constants e.g. SIZES as the primary option but noting the component consts in the documentation and using them for propType validation and storybook controls only
  • Standardize all similar prop names for images imgSrc, imgAlt(html element + attribute) (needs audit)
  • We have a story for each component prop and we use the prop name verbatim e.g. size prop would be export const Size = (args) => (
  • We have the accompanying documentation for each component prop and we use the prop name verbatim e.g. size prop would be ### Size
  • Add mm- prefix to all classNames
  • className is kebab case version of the component name
  • Spread base components props and reduce duplication of props when props aren't being changed and remain the same for both variant and base components
  • Add any "to dos" with a // TODO: comment so we can search for them at a later date e.g. blocking components etc

@georgewrmarshall georgewrmarshall added area-UI Relating to the user interface. team-design-system All issues relating to design system in Extension IA/NAV labels Oct 27, 2022
@georgewrmarshall georgewrmarshall self-assigned this Oct 27, 2022
@github-actions
Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@georgewrmarshall georgewrmarshall changed the title Adding initial HelpText component (WIP) Adding HelpText component (WIP) Oct 27, 2022
@georgewrmarshall georgewrmarshall changed the title Adding HelpText component (WIP) Adding HelpText component Oct 27, 2022
@georgewrmarshall georgewrmarshall marked this pull request as ready for review October 27, 2022 21:26
@georgewrmarshall georgewrmarshall requested a review from a team as a code owner October 27, 2022 21:26
@metamaskbot
Copy link
Collaborator

Builds ready [6956541]
Page Load Metrics (2384 ± 131 ms)
PlatformPageMetricMin (ms)Max (ms)Average (ms)StandardDeviation (ms)MarginOfError (ms)
ChromeHomefirstPaint932975282620298
domContentLoaded192729792362269129
load196629792384273131
domInteractive192729782362269129

highlights:

storybook

@georgewrmarshall georgewrmarshall merged commit 3d37ad3 into develop Nov 3, 2022
@georgewrmarshall georgewrmarshall deleted the feat/16151/help-text-component branch November 3, 2022 17:09
@github-actions github-actions bot locked and limited conversation to collaborators Nov 3, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-UI Relating to the user interface. team-design-system All issues relating to design system in Extension
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Ext Nav] Create component: HelpText
4 participants