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.

Sign up for GitHub

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

Jump to bottom

feat: add typings for Toast component #3434

Open
wants to merge 3 commits into
base: release-22.x
Choose a base branch
from
Open

feat: add typings for Toast component #3434

wants to merge 3 commits into from

Conversation

PKulkoRaccoonGang
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang commented Feb 18, 2025 •
edited
Loading

Description

  • added typings for Toast component
  • some refactoring

Issue: #3409

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 18, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 18, 2025 •
edited
Loading

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/paragon-working-group.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@netlify Netlify
Copy link

netlify bot commented Feb 18, 2025 •
edited
Loading

✅ Deploy Preview for paragon-openedx-v22 ready!

Name Link
🔨 Latest commit 01ae0d9
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx-v22/deploys/67b6ff694ff90d0008d2167b
😎 Deploy Preview https://deploy-preview-3434--paragon-openedx-v22.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.

@codecov Codecov
Copy link

codecov bot commented Feb 18, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.46%. Comparing base (b0187dd) to head (01ae0d9).

Additional details and impacted files 
@@               Coverage Diff                @@
##           release-22.x    #3434      +/-   ##
================================================
+ Coverage         93.40%   93.46%   +0.05%     
================================================
  Files               252      252              
  Lines              4534     4545      +11     
  Branches           1064     1063       -1     
================================================
+ Hits               4235     4248      +13     
+ Misses              296      294       -2     
  Partials              3        3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@PKulkoRaccoonGang PKulkoRaccoonGang force-pushed the Peter_Kulko/typing-for-toast branch from fd9fdb1 to cea1920 Compare February 18, 2025 15:26
@PKulkoRaccoonGang PKulkoRaccoonGang marked this pull request as ready for review February 18, 2025 15:28
@PKulkoRaccoonGang PKulkoRaccoonGang changed the title feat: add typings for <Toast> feat: add typings for Toast component Feb 18, 2025
PKulkoRaccoonGang
PKulkoRaccoonGang commented Feb 18, 2025
View reviewed changes
src/Toast/Toast.test.tsx
Success message.
</ToastWrapper>,
);
const toast = screen.getByTestId('toast');
const toast = screen.getByRole('alert');
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since the component now does not have an extra role, it is possible to find an element without a test id

image

PKulkoRaccoonGang
PKulkoRaccoonGang commented Feb 18, 2025
View reviewed changes
src/Toast/README.md
@@ -39,7 +39,7 @@ notes: ''
Example of a basic Toast.
</Toast>

<Button variant="primary" onClick={() => setShow(true)}>Show Toast</Button>
<Button onClick={() => setShow(true)}>Show Toast</Button>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The default variant for the Button component is primary.

bradenmacdonald
bradenmacdonald reviewed Feb 18, 2025
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

Code looks good. Can you please also update src/index.d.ts and src/index.js to move the Toast imports from "Things that don't have types" to "Things that have types", and change the import so that the types are present?

@PKulkoRaccoonGang
Copy link
Contributor Author

@bradenmacdonald added, thanks for reminding me 💯

bradenmacdonald
bradenmacdonald reviewed Feb 19, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

@ihor-romaniuk ihor-romaniuk ihor-romaniuk approved these changes

@brian-smith-tcril brian-smith-tcril Awaiting requested review from brian-smith-tcril

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: In Eng Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@PKulkoRaccoonGang @openedx-webhooks @bradenmacdonald @ihor-romaniuk