Prevent ActionMenu's show_button slot from rendering its content more than once #2538
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 76f261f The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
jonrohan
approved these changes
Jan 24, 2024
| @@ -241,7 +241,9 @@ def initialize( | |||
| # | |||
| # @param system_arguments [Hash] The arguments accepted by <%= link_to_component(Primer::Alpha::Overlay) %>'s `show_button` slot. | |||
| def with_show_button(**system_arguments, &block) | |||
| @overlay.with_show_button(**system_arguments, id: "#{@menu_id}-button", controls: "#{@menu_id}-list", &block) | |||
| @overlay.with_show_button(**system_arguments, id: "#{@menu_id}-button", controls: "#{@menu_id}-list") do |button| | |||
| evaluate_block(button, &block) | |||
There was a problem hiding this comment.
Hah yeah, all credit to @BlakeWilliams for figuring out the block.binding.receiver fix (which is what evaluate_block uses to work its magic).
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are you trying to accomplish?
Providing content to
ActionMenu'swith_show_buttonslot causes a double render.Integration
No changes necessary in production.
Risk Assessment
What approach did you choose and why?
The issue is that the block provided to
with_show_buttonis forwarded toOverlayand ultimately evaluated inOverlay's view context. I made use of our shiny newevaluate_blockmethod that evaluates blocks in their receiver's view context (i.e. the receiver of the block's binding).Anything you want to highlight for special attention from reviewers?
I wasn't able to write a viable test using
render_inlinesince I needed to actually run everything through the Rails render stack. I ended up adding a test helper calledrender_inline_erb. Would love some 👀 on it.Accessibility
Merge checklist
- [ ] Added/updated documentation- [ ] Added/updated previews (Lookbook)- [ ] Tested in Chrome- [ ] Tested in Firefox- [ ] Tested in Safari- [ ] Tested in Edge