ruby-on-rails - 尝试将 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()，因此为了使用此方法，必须在 jquery 之后加载 select2 库 lib，否则找不到 jquery 引用，因此无法注册 jquery 函数，因此出现错误 $(...).select2不是函数 将被抛出。

<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 时，这个lib 会被加载。因此，尽管您设置了按如下顺序导入它们:

import "jquery";
import "select2";

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

幸运的是，gem importmap-rails支持预加载 pin 模块 ( modulepreload )，所以基于此我想出了一个解决方案:在 select2

之前预加载 jquery

# 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”的刺激 Controller 上，你可以加载“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”并将其加载到您的布局 View 中

// 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，reference