Skip to content

Conversation

@jacobo-dominguez-wgu
Copy link
Contributor

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Oct 8, 2025

Description

Adding classname props to Sheet component, the props added are:

  • sheetClassName: to specify custom classes to the sheet element
  • className: to specify custom classes to the base/container element

Also created the unit tests to support these additions.
It closes #3750

Deploy Preview

Include a direct link to your changes in this PR's deploy preview here (e.g., a specific component page).

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 Oct 8, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @jacobo-dominguez-wgu!

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

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.

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

netlify bot commented Oct 8, 2025

Deploy Preview for paragon-openedx-v23 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 61264e7
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/68efcc1c1138930008ae2f32
😎 Deploy Preview https://deploy-preview-3855--paragon-openedx-v23.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 project configuration.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Oct 8, 2025
@codecov
Copy link

codecov bot commented Oct 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.33%. Comparing base (411e19e) to head (61264e7).
⚠️ Report is 35 commits behind head on release-23.x.

Additional details and impacted files
@@               Coverage Diff                @@
##           release-23.x    #3855      +/-   ##
================================================
+ Coverage         94.30%   94.33%   +0.03%     
================================================
  Files               242      242              
  Lines              4229     4235       +6     
  Branches            960      959       -1     
================================================
+ Hits               3988     3995       +7     
+ Misses              237      236       -1     
  Partials              4        4              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jacobo-dominguez-wgu jacobo-dominguez-wgu force-pushed the sheet-classname branch 3 times, most recently from cada56d to 056df41 Compare October 8, 2025 19:54
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Oct 8, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 8, 2025
@jacobo-dominguez-wgu jacobo-dominguez-wgu moved this from Waiting on Author to Ready for Review in Contributions Oct 8, 2025
Copy link
Contributor

@PKulkoRaccoonGang PKulkoRaccoonGang left a comment

Choose a reason for hiding this comment

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

I think it’s a good idea to allow passing custom class names both for the wrapper and for the component itself 👍

Image
  • sheetClassName: to specify custom classes to the sheet element
  • className: to specify custom classes to the base/container element

I’d like to suggest reconsidering the naming here. It might be clearer for consumers if we use containerClassName for the base/container element, and simply className for the sheet element.
This is just a suggestion, I’d be interested to hear your thoughts.

@brian-smith-tcril
Copy link
Contributor

@jacobo-dominguez-wgu did you see @PKulkoRaccoonGang's note?

I’d like to suggest reconsidering the naming here. It might be clearer for consumers if we use containerClassName for the base/container element, and simply className for the sheet element.
This is just a suggestion, I’d be interested to hear your thoughts.

@jacobo-dominguez-wgu
Copy link
Contributor Author

@brian-smith-tcril, @PKulkoRaccoonGang I came up with these classNames names based on some similarities on the IconButton props, but now that you mention it makes more sense your approach, I already updated the pr to follow your suggestion.

@brian-smith-tcril brian-smith-tcril merged commit cce7beb into openedx:release-23.x Oct 23, 2025
10 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Oct 23, 2025
@openedx-semantic-release-bot

🎉 This PR is included in version 23.15.0 🎉

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

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). open-source-contribution PR author is not from Axim or 2U released

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Provide className as prop for Sheet component

6 participants