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

Convert compliance dashboard web component to react component #369

Merged
merged 3 commits into from
Apr 21, 2020

Conversation

hursey013
Copy link
Contributor

@hursey013 hursey013 commented Apr 17, 2020

This folds the compliance-dashboard-web-component back into code-gov-front-end for greater consistency with the rest of the code base, as well as more streamlined long term maintainability.

The process used to convert the web component to React is as follows:

  • Identify entry point of web component and associated data props (here we can see the entry point and the required props config and data)
  • Establish a new React component and migrate over existing methods (this step will vary depending on the complexity of the web component)
  • Migrate styles to existing SASS entry point (the current convention is to add styles to styles/_main.scss to make them available to the component
  • Add prop-types to document expected shape of data sent to component
  • Remove dependencies related to web-component from package.json and other entry points
  • Modify/review existing tests associated with web component, update snapshots, and new tests to make sure that new component is working as expected

@hursey013 hursey013 marked this pull request as draft April 17, 2020 21:14
@hursey013 hursey013 force-pushed the bh-convert-compliance-dashboard branch 8 times, most recently from 084d8bf to 4075e39 Compare April 20, 2020 17:04
@hursey013 hursey013 force-pushed the bh-convert-compliance-dashboard branch from 4075e39 to 78993f8 Compare April 20, 2020 17:36
@hursey013 hursey013 marked this pull request as ready for review April 20, 2020 22:04
@hursey013 hursey013 changed the title [WIP] Convert compliance dashboard web component to react component Convert compliance dashboard web component to react component Apr 20, 2020
Copy link
Contributor

@jcastle-zz jcastle-zz left a comment

Choose a reason for hiding this comment

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

@hursey013, looks good! Chat real fast and then merge this into master.

@jcastle-zz jcastle-zz merged commit dc9a32e into master Apr 21, 2020
@jcastle-zz jcastle-zz deleted the bh-convert-compliance-dashboard branch April 21, 2020 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants