尝试将 select2 与 Rails 7 上的 Importmaps 一起使用

Question

我正在尝试在新的 Rails 7 应用程序上使用 Select2，但遇到的困难如下：

我已将其固定到导入映射中并像这样导入：

pin "application", preload: true
pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
pin_all_from "app/javascript/controllers", under: "controllers"
pin "trix"
pin "@rails/actiontext", to: "actiontext.js"
pin "select2", to: "https://ga.jspm.io/npm:select2@4.1.0-rc.0/dist/js/select2.js"
pin "jquery", to: "https://ga.jspm.io/npm:jquery@3.6.0/dist/jquery.js"

（最后两行是在我运行 bin/importmap pin select2 时添加的）

import "jquery";
import "select2";
import "@hotwired/turbo-rails";
import "controllers";
import "trix";
import "@rails/actiontext";

（已将 jquery 和 select2 移至末尾和开头 - 没有改变任何事情）。

当我处于表单中时，我可以使用 $ 访问元素，如下所示：

$('#book_genre_ids');
...(returns the element)

但是当我在控制台中手动尝试在元素上运行 select2() 时，会发生以下情况：

$('#book_genre_ids').select2();
VM574:1 Uncaught TypeError: $(...).select2 is not a function
    at <anonymous>:1:22

我确实检查了网络源（chrome控制台），我可以从gap.jspm.io找到npm：jquery@3.6.0/dist和npm：select2@4.1.0-rc.0/dist。我发现一些资源指向正在加载的多个jquery库，但我在控制台的网络源中没有找到比上面更多的资源...

Answer 1

Select2 会将自身注册为 jQuery 函数.select2()，因此为了使用此方法，select2必须在 lib 之后加载 lib jquery，否则无法找到jquery引用，因此无法注册函数，因此会抛出jquery错误。$(...).select2 is not a function

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.3/js/select2.min.js" />

但是，它import是异步加载的，因此不能保证当select2查找时jquery，会加载该库。因此，尽管您按如下顺序设置导入它们：

import "jquery";
import "select2";

当需要的时候仍然没有select2找到。jquery

幸运的是，gem importmap-rails支持预加载 pin 模块（modulepreload），所以基于此我想出了一个解决方案： preload jquerybeforeselect2

# config/importmap.rb
pin "jquery", to: "https://ga.jspm.io/npm:jquery@3.6.0/dist/jquery.js", preload: true
pin "select2", to: "https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js"

然后我按照Rails7设置“@hotwired/stimulus”的方式设置“jquery”

// app/javascript/controllers/application.js
import { Application } from "@hotwired/stimulus"
...
import jQuery from "jquery"
window.jQuery = jQuery // <- "select2" will check this
window.$ = jQuery
...

现在在需要“select2”的刺激控制器上，您可以加载“select2”

// app/javascript/controllers/demo_controller.js
import { Controller } from "@hotwired/stimulus"
import "select2"

export default class extends Controller {
  initialize() {
    $('.js-example-basic-multiple').select2();
  }
// ...

注意：您的“select2”CDN“https://ga.jspm.io/npm:select2@4.1.0-rc.0/dist/js/select2.js”源包含import e from"jquery";在第一行，因此它不起作用在此解决方案中，所以我建议使用官方 cdn 链接：“https://cdn.jsdelivr.net/npm/select2@4.1.0-rc.0/dist/js/select2.min.js”。

更新

如果您不想使用刺激，您可以固定另一个 js 文件来设置“select2”并将其加载到布局视图中

// app/javascript/utils.js
import "select2"

$(document).ready(function () {
  $('.js-example-basic-multiple').select2();
});

# config/importmap.rb
...
pin "utils"

# app/views/products/show.html.erb
<%= javascript_import_module_tag("utils") %>
...

注意：你必须使用javascript_import_module_tag，而不是javascript_importmap_tags，引用