-
Notifications
You must be signed in to change notification settings - Fork 51
AppSideNav
, SideNav
: fix typing issue
#2908
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git βοΈ
|
π¦ RC Packages PublishedLatest commit: 112b8b9 |
π¦ RC Packages PublishedLatest commit: 112b8b9 |
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.
From a code perspective, everything makes sense (my previous porting to TS was not correct, I see only now)
According to the internal guidance, we should have a changeset associated with the change.
Also, not sure if we should test with at least one consumer (Cloud UI?) to make sure the build works. I'll leave it to you to decide if it's worth it or not.
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.
Nice PR! π
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 cleaning these up!
π Summary
If merged, this PR would fix an issue with unused arguments being required for the AppSideNav and SideNav components.
π οΈ Detailed description
Currently, the component throws type errors that
@target
is required forHds::AppSideNav/SideNav::Portal
and@name
is required forHds::AppSideNav/SideNav::Portal::Target
.This is because the types for Portal and Portal::Target are a union of the types from
ember-stargate
and our own args. For our components, we expose thetargetName
argument as the way consumers can change the name or target argument.I decided to delete the PortalSignature and PortalTarget signatures entirely because none of those args are passed to the components so if a consumer used them it wouldn't do anything.
Example Hds::AppSideNav::Portal
Notice
@target
,@renderInPlace
, and@fallback
are not forwarded to thePortal
component.handlebars

types

π External links
π Component checklist
π¬ Please consider using conventional comments when reviewing this PR.