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

Mfrank/rename variables #17

Merged
merged 5 commits into from
Jan 18, 2024
Merged

Mfrank/rename variables #17

merged 5 commits into from
Jan 18, 2024

Conversation

MaxFrank13
Copy link
Member

@MaxFrank13 MaxFrank13 commented Jan 12, 2024

Updates plugins to pluginSlots in the env.config.js configuration. The only place where this value is explicitly referenced is in the usePluginSlot hook.

Some inline documentation has been added to help explain some of the props of the framework components. Additionally, the scrolling attribute has been removed as it is a deprecated attribute for iframes.

APER-3046

fallback: PropTypes.node,
scrolling: PropTypes.oneOf(['auto', 'yes', 'no']),
Copy link
Member Author

Choose a reason for hiding this comment

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

This attribute has been deprecated for iframes. I think it may have been causing some of the scrollbars we were seeing before.

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#deprecated_attributes

Copy link

codecov bot commented Jan 12, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (3b9139d) 75.19% compared to head (efbe3e0) 75.19%.
Report is 2 commits behind head on master.

Files Patch % Lines
src/plugins/data/hooks.js 0.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master      #17   +/-   ##
=======================================
  Coverage   75.19%   75.19%           
=======================================
  Files          10       10           
  Lines         129      129           
  Branches       19       19           
=======================================
  Hits           97       97           
  Misses         30       30           
  Partials        2        2           

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

@MaxFrank13 MaxFrank13 force-pushed the mfrank/rename-variables branch from 9d61426 to 0523922 Compare January 12, 2024 18:53
- runtime config
*/

/** TODO: Examples still need to be set up as part of APER-3042 https://2u-internal.atlassian.net/browse/APER-3042 */

Choose a reason for hiding this comment

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

Do we still need this TODO and commented out code in here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point on this commented out code in here. Could a lot of this exist in the README since there's already a section there about how the config should be set up?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes good call outs. I will move it to the README. I blame my mucus infused brain for attempting to push a full file of comments 😅

Copy link

@justinhynes justinhynes left a comment

Choose a reason for hiding this comment

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

Seems reasonable to me but I'm not as plugged into the FPF as others on the team. Feel free to wait for a more experienced approval from someone. :)

docs: update readme

docs: update readme
@MaxFrank13 MaxFrank13 force-pushed the mfrank/rename-variables branch from e25b772 to 5eec110 Compare January 16, 2024 22:37
@MaxFrank13 MaxFrank13 merged commit 496f198 into master Jan 18, 2024
6 of 7 checks passed
@MaxFrank13 MaxFrank13 deleted the mfrank/rename-variables branch January 23, 2024 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants