How do you add a custom Stimulus controller in Administrate v1.0?

[bagaze]

• What would you like to be able to do? Can you provide some examples?

I am trying to update our implementation of Administrate to the 1.0.0 version. In order to clean some of our custom fields, I would like to leverage Stimulus to handle these fields interaction using Javascript.

But I can't find a way to expose custom Stimulus controller to Administrate so that I can use them in our custom fields.

• How could we go about implementing that?

Explain how to add custom Stimulus controller to Administrate in its documentation

• Can you think of other approaches to the problem?

No

[nickcharlton]

As we changed the bundling method, it's a bit tricky now. I had a similar problem on a client project recently, but it wasn't about adding Stimulus controllers but rather a JavaScript dependency, but I thought sharing it might be valuable:

# app/controllers/admin/application_controller.rb
module Admin
  class ApplicationController < Administrate::ApplicationController
+    helper_method :chartkick_importmap

+    def chartkick_importmap
+      importmap = Importmap::Map.new
+      importmap.pin "chartkick", to: "chartkick.js"
+      importmap.pin "Chart.bundle", to: "Chart.bundle.js"
+
+      importmap
+    end
  end
end

## app/views/layouts/administrate/application.html.erb
  <%= render "javascript" %>

+  <!-- Start additional importmap_tags -->
+  <%= javascript_inline_importmap_tag(chartkick_importmap.to_json(resolver: self)) %>
+  <script type="module">import "chartkick"</script>
+  <script type="module">import "Chart.bundle"</script>
+  <!-- End additional importmap_tags -->
</head>

I'm creating a new ImportMap and then putting it on the page, by overriding the application layout.

I don't think this is a great solution though, it'd be nice to make this a lot easier to do, especially when it comes to Stimulus controllers. The only thought I do have is to override the application.js and see if that's a way to register your additional controllers.

Can anyone think of a nicer way?

(I think once we've figured out a nice way to acheive it, we can perhaps look at adding a helper method to ease registering them. Once your field is complex enough, it's makes installing it much more onerous.)