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

append_javascript_pack_tag does not work inside a view component #495

Closed
m0g opened this issue Jun 18, 2024 · 3 comments
Closed

append_javascript_pack_tag does not work inside a view component #495

m0g opened this issue Jun 18, 2024 · 3 comments
Labels
bug

Comments

@m0g
Copy link

m0g commented Jun 18, 2024

Notice: A bug is a crash or incorrect behavior. If you have a debugging or troubleshooting question, please open a discussion on the Discussions Tab. Otherwise, remove this line and fill out the following sections.

Hello there,
I'm having an issue regarding shakapacker and view_components. I'm filling a bug report here, because I assume the issue is on shakapacker's side. Please correct me if I'm wrong.

The problem I am experiencing, is that it is currently not possible to append javascript pack tag from within a view component.

Expected behavior:

Hello should be displayed in the console

Actual behavior:

Hello is not displayed in the console

Small, reproducible repo:

app/views/layouts/application.html.erb

<html>
  <body>
    <%= render(FooterComponent.new) %>
    <%= javascript_pack_tag 'static' %>
  </body>
</html>

app/components/footer_component.html.erb

<% append_javascript_pack_tag 'cookie_banner' %>
<% append_stylesheet_pack_tag 'cookie_banner' %>
<footer class="border-t border-me-gray-400 py-8 bg-me-gray-100">
  my footer
</footer>

app/components/footer_component.rb

class FooterComponent < ViewComponent::Base
end

app/javascript/packs/cookie_banner.js

console.log('hello');

Setup environment:

  • Ruby version: 3.2.4 (2024-04-23 revision af471c0e01) [arm64-darwin23]
  • Rails version: 7.1.3.4
  • Shakapacker version: 8.0.0
@m0g m0g added the bug label Jun 18, 2024
@tomdracz
Copy link
Collaborator

Had a look at this and I think this is something to do with rendering contexts.

We rely on instance variables being available on instance of ActionView IIRC

shakapacker/lib/shakapacker/helper.rb

Line 209 in dc921a2

@javascript_pack_tag_queue ||= {

Testing this out and prying in the view and footer component I can see that while both have access to javascript_pack_tag_queue for example, the one in view component is a different instance so it stores state local to that component.

This is different to plain rendering view or partial where same ActionView base will be reused so the state is global.

Not too familiar with view components rendering but can't see an easy way we could fix it on our end

@justin808
Copy link
Member

Is there a reason

  <%= javascript_pack_tag 'static' %>

is in the body and not the head?

@justin808
Copy link
Member

Closing for now. Seems to be either a doc issue or a patch is needed for view compnents.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@justin808 @m0g @tomdracz