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

[BD-46] fix: correct PropTypes for DataTable #2749

Merged

Conversation

monteri
Copy link
Contributor

@monteri monteri commented Oct 26, 2023

Description

Checked whole DataTable component for suitable propTypes. Most of the focus was for Cell and oneOfType(PropTypes.func, PropTypes.element). I have validated that proper PropType is oneOfType(PropTypes.node, PropTypes.elementType) so that it would cover all cases:

  • ({ row }) => <div>hello</div> (function) - elementType
  • Component - elementType
  • <div>hello</div> (element) - node
  • string/number/bool/undefined/null - node
  • react fragment <></> - node
  • array of elements - node

Deploy Preview

https://deploy-preview-2749--paragon-openedx.netlify.app/components/datatable/

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 add wittjeff and adamstankiewicz as reviewers on this PR.

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 blended PR is managed through 2U's blended developmnt program label Oct 26, 2023
@openedx-webhooks
Copy link

Thanks for the pull request, @monteri!

When this pull request is ready, tag your edX technical lead.

@netlify
Copy link

netlify bot commented Oct 26, 2023

Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 736e9e5
🔍 Latest deploy log https://app.netlify.com/sites/paragon-openedx/deploys/655f6086d40a730008fcf1be
😎 Deploy Preview https://deploy-preview-2749--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.

@codecov
Copy link

codecov bot commented Oct 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2747ac1) 92.82% compared to head (736e9e5) 92.83%.
Report is 42 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2749   +/-   ##
=======================================
  Coverage   92.82%   92.83%           
=======================================
  Files         235      235           
  Lines        4237     4240    +3     
  Branches     1029     1029           
=======================================
+ Hits         3933     3936    +3     
  Misses        300      300           
  Partials        4        4           

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

Copy link
Member

@adamstankiewicz adamstankiewicz left a comment

Choose a reason for hiding this comment

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

Looks good, just one clarifying question!

canFilter: PropTypes.bool,
render: PropTypes.func.isRequired,
})).isRequired,
manualFilters: PropTypes.bool,
onFilter: PropTypes.func,
onFilter: PropTypes.elementType,
Copy link
Member

Choose a reason for hiding this comment

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

[clarification] Should onFilter be an elementType or remain as a function?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I missed that it is onFilter and not Filter that in the index.jsx. Thank you!

@viktorrusakov viktorrusakov merged commit 20e512e into openedx:master Dec 6, 2023
8 checks passed
@openedx-webhooks
Copy link

@monteri 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@openedx-semantic-release-bot

🎉 This PR is included in version 21.9.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@openedx-semantic-release-bot

🎉 This PR is included in version 22.0.0-alpha.20 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blended PR is managed through 2U's blended developmnt program released on @alpha released
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants