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.

Sign up for GitHub

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

Jump to bottom

fix(#16882) Menu's target prop fix #17145

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

fix(#16882) Menu's target prop fix #17145

wants to merge 6 commits into from

Conversation

NabeelAyubee
Copy link
Contributor

@NabeelAyubee NabeelAyubee commented Aug 12, 2024 •
edited

Closes #16882

Renamed the target prop to menuTarget for the Menu component to improve clarity.
Added the menuTarget prop to MenuButton and OverflowMenu components, allowing consumers to specify the DOM element into which the menu is portaled.

Changelog

Changed

  • The target prop has been renamed to menuTarget for improved clarity.
  • The menuTarget prop has been added to the MenuButton components to provide better control over menu rendering.
  • Added support for backward compatibility
  • Hide menuTarget prop from actions in storybook
  • Added deprecation warning for target prop

Testing / Reviewing

Testing / Reviewing

  • Run yarn test to ensure that there are no code errors.
  • Verify that the menuTarget prop correctly specifies the HTML element into which the menu is portaled. Ensure that the menu items are rendered in the target element as expected.
  • Check the Storybook integration to ensure the new prop name is reflected and functioning correctly.

@NabeelAyubee NabeelAyubee requested a review from a team as a code owner August 12, 2024 16:15
@NabeelAyubee
Copy link
Contributor Author

I have read the DCO document and I hereby sign the DCO.

@netlify Netlify
Copy link

netlify bot commented Aug 12, 2024 •
edited

✅ Deploy Preview for v11-carbon-react ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 009877c
🔍 Latest deploy log https://app.netlify.com/sites/v11-carbon-react/deploys/66c5a2542c67110008cbfcf4
😎 Deploy Preview https://deploy-preview-17145--v11-carbon-react.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.

@netlify Netlify
Copy link

netlify bot commented Aug 12, 2024 •
edited

✅ Deploy Preview for carbon-elements ready!

Name Link
🔨 Latest commit 009877c
🔍 Latest deploy log https://app.netlify.com/sites/carbon-elements/deploys/66c5a2548c8783000863052c
😎 Deploy Preview https://deploy-preview-17145--carbon-elements.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.

@NabeelAyubee NabeelAyubee mentioned this pull request Aug 12, 2024
Open
2 tasks
tay1orjones
tay1orjones requested changes Aug 12, 2024
View reviewed changes
Copy link
Member

@tay1orjones tay1orjones left a comment

Choose a reason for hiding this comment

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

Thanks again for taking this on! I don't think we should rename the target prop if possible. It makes the internal logic simpler, we can avoid the codemod, and consumers don't have to change any existing usages.

packages/react/src/components/Menu/Menu.tsx Outdated Show resolved Hide resolved
packages/react/src/components/MenuButton/index.tsx Outdated Show resolved Hide resolved
packages/upgrade/transforms/update-menu-target-prop.js Outdated Show resolved Hide resolved
tay1orjones
tay1orjones approved these changes Aug 19, 2024
View reviewed changes
Copy link
Member

@tay1orjones tay1orjones left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@NabeelAyubee
Copy link
Contributor Author

Hi @alisonjoseph & @emyarod , Can you please review the PR ? I've got one approval.

emyarod
emyarod approved these changes Aug 20, 2024
View reviewed changes
Copy link
Member

@emyarod emyarod 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 to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tay1orjones tay1orjones tay1orjones approved these changes

@emyarod emyarod emyarod approved these changes

@alisonjoseph alisonjoseph Awaiting requested review from alisonjoseph alisonjoseph is a code owner automatically assigned from carbon-design-system/developers-system-reviewers

Assignees
No one assigned
Labels
status: failing CI 🙅‍♂️ status: one more review 👀
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Bug]: MenuButton and OverflowMenu cannot configure the Menu's target prop
4 participants
@NabeelAyubee @tay1orjones @emyarod @2nikhiltom