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

Migrate components to TS: BannerBase #19181

Closed
georgewrmarshall opened this issue May 17, 2023 · 6 comments · Fixed by #20421
Closed

Migrate components to TS: BannerBase #19181

georgewrmarshall opened this issue May 17, 2023 · 6 comments · Fixed by #20421
Labels
good first issue Good for newcomers team-design-system All issues relating to design system in Extension

Comments

@georgewrmarshall
Copy link
Contributor

georgewrmarshall commented May 17, 2023

Description

Migrate BannerBase component in ui/components/component-library to TypeScript

Dependencies

Technical Details

  • Convert Objects in SNAKE_CASE to enums in PascalCase (name and keys)
  • Ensure enums use singular not plural e.g. Size not Sizes
  • Update file name from component-name.contants.js to component-name.types.ts and add types
  • Update file name from component-name.js to component-name.tsx and add types
  • Update file name from component-name.test.js to component-name.test.tsx
  • Update file name from component-name.stories.js to component-name.stories.tsx
  • Update all instances of component objects to enums
  • Update all documentation

Acceptance Criteria

  • Component has been converted to TypeScript
  • Stories, documentation and tests have been updated inside of the component-name folder
  • Before/After screen cast of component stories in storybook to show no visual regression after migration

Difficulty: Intermediate

Good first issue for: External contributors who are familiar with TypeScript and want to contribute to improving the stability of the extension

@georgewrmarshall georgewrmarshall added good first issue Good for newcomers team-design-system All issues relating to design system in Extension labels May 17, 2023
@Sukriti-m
Copy link

Hey @georgewrmarshall
I would like to work on this issue. I'd be grateful if you could assign this task to me.

@georgewrmarshall
Copy link
Contributor Author

Hey @Sukriti-m, thanks for you interest! I believe this component has some dependencies that may need to be migrated first

@georgewrmarshall georgewrmarshall removed the good first issue Good for newcomers label Jun 5, 2023
@georgewrmarshall
Copy link
Contributor Author

Removing good-first-issue label until we close the Box dependency #19239

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers team-design-system All issues relating to design system in Extension
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@georgewrmarshall @Sukriti-m and others