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

feat: Add Typescript typings to Breadcrumb, BreadcrumbItems, and BreadcrumbSkeleton #15033

Merged
merged 5 commits into from
Oct 31, 2023

Conversation

Tresau
Copy link
Contributor

@Tresau Tresau commented Oct 26, 2023

Closes #13546

Add typings to Breadcrumb, BreadcrumbItems, and BreadcrumbSkeleton. During work, discovered incorrect PropType in BreadcrumbItem for 'aria-current' and opened #15034 as a result.

Changelog

New

  • Added Typescript types to Breadcrumb, BreadcrumbItems, BreadcrumbSkeleton

Changed

  • File extensions from .js to .tsx

Removed

  • n/a

Testing / Reviewing

Verify that the storybooks run properly.
Run unit tests

@Tresau Tresau requested a review from a team as a code owner October 26, 2023 14:58
@github-actions
Copy link
Contributor

github-actions bot commented Oct 26, 2023

DCO Assistant Lite bot All contributors have signed the DCO.

@netlify
Copy link

netlify bot commented Oct 26, 2023

Deploy Preview for v11-carbon-react ready!

Name Link
🔨 Latest commit 8eac7cc
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-react/deploys/65415d94d6265b00087c938c
😎 Deploy Preview https://deploy-preview-15033--v11-carbon-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link

netlify bot commented Oct 26, 2023

Deploy Preview for carbon-elements ready!

Name Link
🔨 Latest commit 8eac7cc
🔍 Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/65415d942a794e0008a5ee47
😎 Deploy Preview https://deploy-preview-15033--carbon-elements.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Tresau
Copy link
Contributor Author

Tresau commented Oct 26, 2023

I have read the DCO document and I hereby sign the DCO.

Comment on lines +106 to +107
// @ts-expect-error - v12 TODO: BREAKING: This should match AriaAttributes['aria-current']
'aria-current': PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This definition is to broad for 'aria-current'. Per my discussion here I have decided to simply suppress the error in order to not introduce breaking changes in the typing additions. I have opened #15034 where I will address this issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have created #15052 to address the Incorrect PropTypes to be accepted at a later time as it is a Breaking change.

@Tresau Tresau changed the title Add Typescript typings to Breadcrumb, BreadcrumbItems, and BreadcrumbSkeleton feat: Add Typescript typings to Breadcrumb, BreadcrumbItems, and BreadcrumbSkeleton Oct 27, 2023
Copy link
Contributor

@andreancardona andreancardona left a comment

Choose a reason for hiding this comment

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

thank you!! 🎉

@andreancardona andreancardona added this pull request to the merge queue Oct 31, 2023
Merged via the queue into carbon-design-system:main with commit c8dcddc Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add TypeScript types to Breadcrumb, BreadcrumbItem, BreadcrumbSkeleton
3 participants