-
Notifications
You must be signed in to change notification settings - Fork 174
feat: add Page Banner Slot for Schedule and Details Page #2748
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
base: master
Are you sure you want to change the base?
Conversation
|
Thanks for the pull request, @Anas12091101! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2748 +/- ##
========================================
Coverage 94.89% 94.90%
========================================
Files 1235 1236 +1
Lines 28254 28261 +7
Branches 6223 6415 +192
========================================
+ Hits 26813 26820 +7
+ Misses 1383 1370 -13
- Partials 58 71 +13 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
bradenmacdonald
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the nice PR. I have a few concerns about the plugin slot props, and hope we can simplify them. Otherwise this looks great.
|
|
||
| export interface PageBannerSlotProps { | ||
| show: boolean; | ||
| dismissible: boolean; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think dismissable should be a prop for the plugin slot. First of all, it's never false, and second of all, it should be up to the plugin contents to decide whether to show a dismiss button or not.
| show: boolean; | ||
| dismissible: boolean; | ||
| onDismiss: () => void; | ||
| className: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this makes sense as a prop either. Just hard-code the default className on the div in the default contents, or move that wrapper div outside of the slot. This className won't necessarily apply to custom plugins that put different content in this slot.
| variant?: string; | ||
| dismissAltText?: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These two props don't seem to be used, so I think you can just use them on the default contents only; they don't have to be a plugin prop.
The plugin prop API needs to be stable so it's best to keep it as simple as possible and only include necessary properties.
| className, | ||
| children, | ||
| variant = 'info', | ||
| dismissAltText = 'Dismiss', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This word "Dismiss" won't be translated, so we need another way of specifying it.
Description
This PR adds a Page Banner Slot in the Schedule and Details Page to allow customization of the banner message, which is currently hardcoded.
Useful information to include:
By default:

Overridden by Slot:

Supporting information
https://github.com/mitodl/hq/issues/9362
Testing instructions
Other information
Include anything else that will help reviewers and consumers understand the change.
Best Practices Checklist
We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:
.ts,.tsx).propTypesanddefaultPropsin any new or modified code.src/testUtils.tsx(specificallyinitializeMocks)apiHooks.tsin this repo for examples.messages.tsfiles have adescriptionfor translators to use.../in import paths. To import from parent folders, use@src, e.g.import { initializeMocks } from '@src/testUtils';instead offrom '../../../../testUtils'