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

Add Typescript types to Card, CardFooter, CardHeader #5197

Closed
6 tasks
Tracked by #4232
sstrubberg opened this issue May 14, 2024 · 0 comments · Fixed by #5760
Closed
6 tasks
Tracked by #4232

Add Typescript types to Card, CardFooter, CardHeader #5197

sstrubberg opened this issue May 14, 2024 · 0 comments · Fixed by #5760
Assignees
Labels
adopter: automation Issues connected to work that accelerates IBM's automation offerings. adopter: data & ai Issues connected to work that accelerates IBM's Data & AI offerings. adopter: security Issues connected to work that accelerates IBM's Security offerings. adopter: sustainability Issues connected to work that accelerates IBM's sustainability offerings. area: migration ➡️ Migration of Security package to IBM Products area: typescript role: dev type: enhancement 💡 New feature or request type: infrastructure 🤖 Issues related to devops, builds, packaging

Comments

@sstrubberg
Copy link
Member

sstrubberg commented May 14, 2024

As we add Typescript support, want to call out a few helpful tips from the Carbon TypeScript guide that is largely relevant to our library as well.

Changing the extension via git

When changing the file extension — do not simply rename the file. Instead, change the extension via git.

For example,

git mv packages/ibm-products/src/components/ComponentName/ComponentName.js packages/ibm-products/src/components/ComponentName/ComponentName.tsx

Do not add types to internal components or functions

Testing changes

A few different options for testing changes —

  • At the bottom of a file, write a dummy component that uses the component that you’re converting to ensure that you can still pass all appropriate props.
  • Take a storybook example for a component, copy and paste it into the bottom of the .tsx file and validate whether or not it accepts the props as you’ve defined them.

Tasks

Resources

Carbon’s guide on adding component types

@sstrubberg sstrubberg added type: infrastructure 🤖 Issues related to devops, builds, packaging area: migration ➡️ Migration of Security package to IBM Products area: typescript role: dev adopter: security Issues connected to work that accelerates IBM's Security offerings. adopter: data & ai Issues connected to work that accelerates IBM's Data & AI offerings. adopter: automation Issues connected to work that accelerates IBM's automation offerings. adopter: sustainability Issues connected to work that accelerates IBM's sustainability offerings. type: enhancement 💡 New feature or request labels May 14, 2024
@amal-k-joy amal-k-joy assigned amal-k-joy and unassigned amal-k-joy May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
adopter: automation Issues connected to work that accelerates IBM's automation offerings. adopter: data & ai Issues connected to work that accelerates IBM's Data & AI offerings. adopter: security Issues connected to work that accelerates IBM's Security offerings. adopter: sustainability Issues connected to work that accelerates IBM's sustainability offerings. area: migration ➡️ Migration of Security package to IBM Products area: typescript role: dev type: enhancement 💡 New feature or request type: infrastructure 🤖 Issues related to devops, builds, packaging
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants