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

Clean up Organization component #120

Open
10 tasks
dgading opened this issue Feb 12, 2021 · 0 comments
Open
10 tasks

Clean up Organization component #120

dgading opened this issue Feb 12, 2021 · 0 comments
Assignees
Milestone

Comments

@dgading
Copy link
Member

dgading commented Feb 12, 2021

The Organization component can be the first text for the new 2.0.0 update.

  • Change component to arrow function
  • Pass props in instead of destructuring a single props prop
  • remove hard coded Organization Image alt name prop
  • Make search url path a prop, some sites may not use /search for dataset searches
  • all classNames are now props and their default is based on USWDS (maybe cards?)
  • Link alt text is not hardcoded
  • Prop types all defined and each has a commented line above it explaining it's purpose.
  • Complete or almost complete test coverage for the component
  • Tests include jest axe to have no violations test.
  • Docz file updated to document the component to explain it's usage

The prop type comments should look like

/**
   * This is a pretty good description for this prop.
   */

This will result appear in the Docz file for this component, see https://www.docz.site/docs/built-in-components for more examples.

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

No branches or pull requests

2 participants