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 ActionSet #4609

Closed
6 tasks
Tracked by #4232
matthewgallo opened this issue Mar 26, 2024 · 1 comment
Closed
6 tasks
Tracked by #4232

Add Typescript types to ActionSet #4609

matthewgallo opened this issue Mar 26, 2024 · 1 comment
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: typescript role: dev type: infrastructure 🤖 Issues related to devops, builds, packaging
Milestone

Comments

@matthewgallo
Copy link
Member

matthewgallo commented Mar 26, 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

@matthewgallo
Copy link
Member Author

This should also include removing the any included in SidePanel for the motion action set.

@sstrubberg sstrubberg added area: typescript type: infrastructure 🤖 Issues related to devops, builds, packaging role: dev labels Mar 27, 2024
@sstrubberg sstrubberg added this to the 2024 Q2 milestone Mar 27, 2024
@sstrubberg sstrubberg added status: needs triage 🕵️‍♀️ 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. and removed status: needs triage 🕵️‍♀️ labels Mar 28, 2024
@matthewgallo matthewgallo self-assigned this Apr 2, 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: typescript role: dev type: infrastructure 🤖 Issues related to devops, builds, packaging
Projects
Archived in project
Development

No branches or pull requests

2 participants