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

fix: Toast children prop type #3232

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Sep 11, 2024

Description

This is a small fix of the typing for the children prop of the Toast component. This was generating some warnings in the frontend-app-course-authoring when the Toast was used with an Element instead of a string.

Example (from here):

<Toast show={blockFailed} onClose={hooks.nullMethod}>
  <FormattedMessage {...messages.couldNotLoadTextContext}
</Toast>

Deploy Preview

https://deploy-preview-3232--paragon-openedx.netlify.app/components/toast/

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
Copy link

openedx-webhooks commented Sep 11, 2024

Thanks for the pull request, @rpenido!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/paragon-working-group. Tag them in a comment and let them know that your changes are ready for review.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 11, 2024
Copy link

netlify bot commented Sep 11, 2024

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f6de16c
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/66e1d0d73b2f900008faf980
😎 Deploy Preview https://deploy-preview-3232--paragon-openedx.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.

Copy link

codecov bot commented Sep 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.27%. Comparing base (a2d1a9d) to head (f6de16c).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3232   +/-   ##
=======================================
  Coverage   93.27%   93.27%           
=======================================
  Files         249      249           
  Lines        4401     4401           
  Branches     1033     1033           
=======================================
  Hits         4105     4105           
  Misses        290      290           
  Partials        6        6           

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

@bradenmacdonald
Copy link
Contributor

@rpenido Thanks for fixing this. Is it ready for review?

@rpenido rpenido marked this pull request as ready for review September 11, 2024 16:54
@rpenido
Copy link
Contributor Author

rpenido commented Sep 11, 2024

Yes! It is ready now.

@rpenido
Copy link
Contributor Author

rpenido commented Sep 11, 2024

@bradenmacdonald Fixed!

@bradenmacdonald
Copy link
Contributor

@rpenido This is going to require some more input while we decide whether Toast should allow arbitrary components as children or not: https://openedx.slack.com/archives/C02NR285KV4/p1726077388682079

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

3 participants