ruby-on-rails - 如何在 Rails 中设置 jquery-ui 自动完成

Question

我需要一些关于如何实现 jquery-ui autocomplete 的帮助在我的 Rails 应用程序中。

我想向用户可以输入客户名称的文本字段添加自动完成功能。由于可能有数百个客户，我需要“远程”提取建议的自动完成值，例如从表中(至少这是我的理解)。

我无法理解的要点是如何向自动完成文本框提供建议值。我已经阅读了 jquery-ui 文档，但我似乎在这件事上有点密集。

所以我真正想要的是一个如何让它在 Rails 应用程序中工作的例子，不一定是关于如何构建 javascript 的完整描述(这就是 jquery-ui 团队为我所做的 =))。

例如，如何为自动完成准备数据，以及如何将自动完成功能附加到文本框。

Answer 1

好吧，我上面的问题从来没有得到答案，所以我最终不得不自己弄清楚。我想我应该发布我想出的解决方案，以防其他人想知道同样的事情。

您应该知道的第一件事是，这是我第一次使用 javascript，而且我刚刚掌握了 Rails。所以无论如何，请随意编辑、评论任何你认为我在这方面出错的地方。对与错，至少我知道它以我想要的方式运作。

我认为展示这一点的最佳方式是举例。所以以下是我如何让自动完成小部件在我的应用程序中工作。即使您不明白发生了什么，您也可以继续将以下代码放入您的应用程序中，然后我们可以通过示例了解每个部分的工作方式。在此之后，您应该掌握如何修改它以供您使用或对其进行折射。

在您的 Rails 应用程序中包含 JQUERY UI。

下载 jQuery UI 的副本并放置 jquery-ui-1.8.2.custom.min.js 在您的 /public/javascript 目录。还要确保您有 jQuery 本身的副本，并且它也在同一文件夹中。

在您的 中包含 jQuery UI 文件和 jQuery 文件application.html.erb 像这样的文件。(您可以随意命名文件，只要它们匹配即可)

<%= javascript_include_tag 'jquery.min', 'jquery-ui-1.8.2.custom.min.js' %>

在您下载 jQuery UI 时，您将拥有一个包含所有 CSS 数据的文件夹。名称将根据您选择的主题而有所不同，例如我选择了主题' 库比蒂诺 '。将包含 CSS 数据的整个文件夹放入“ ”中/public/stylesheets/ '。然后像这样在 application.html.erb 中包含 CSS 文件。

<%= stylesheet_link_tag 'cupertino/jquery-ui-1.8.2.custom' %>

示例自动完成 JAVASCRIPT

现在获取以下代码块并将其放入您的“ ”之一中。新品 ' 意见。您可以在任何 View 中使用它，但要意识到我实际上是从属于名为“links_controller”的 Controller 的现有 View 中获取它的，并且它正在从“people_controller”中提取数据。希望您对 Rails 有足够的了解，以找出您需要更改的内容，以便这对您有用。

-- 开始一大块代码 --

    <script type="text/javascript">
    $(function() {

 // Below is the name of the textfield that will be autocomplete    
    $('#select_origin').autocomplete({
 // This shows the min length of charcters that must be typed before the autocomplete looks for a match.
            minLength: 2,
 // This is the source of the auocomplete suggestions. In this case a list of names from the people controller, in JSON format.
            source: '<%= people_path(:json) %>',
  // This updates the textfield when you move the updown the suggestions list, with your keyboard. In our case it will reflect the same value that you see in the suggestions which is the person.given_name.
            focus: function(event, ui) {
                $('#select_origin').val(ui.item.person.given_name);
                return false;
            },
 // Once a value in the drop down list is selected, do the following:
            select: function(event, ui) {
 // place the person.given_name value into the textfield called 'select_origin'...
                $('#select_origin').val(ui.item.person.given_name);
 // and place the person.id into the hidden textfield called 'link_origin_id'. 
        $('#link_origin_id').val(ui.item.person.id);
                return false;
            }
        })
 // The below code is straight from the jQuery example. It formats what data is displayed in the dropdown box, and can be customized.
        .data( "autocomplete" )._renderItem = function( ul, item ) {
            return $( "<li></li>" )
                .data( "item.autocomplete", item )
 // For now which just want to show the person.given_name in the list.
                .append( "<a>" + item.person.given_name + "</a>" )
                .appendTo( ul );
        };
    });
    </script>



<h1>New link</h1>

<% form_for(@link) do |f| %>
  <%= f.error_messages %>

<!-- Place the following text fields in your form, the names are not important. What is important is that they match the names in your javascript above -->
  <p>
        Select which person you want to link:<br /> 
<!-- This is the textfield that will autocomplete. What is displayed here is for the user to see but the data will not go anywhere -->
        <input id="select_origin"/>
<!-- This is the hidden textfield that will be given the Persons ID based on who is selected. This value will be sent as a parameter -->
      <input id="link_origin_id" name="link[origin_id]" type="hidden"/>
  </p>
<!-- end of notes -->
  <p>
    <%= f.label :rcvd_id %><br />
    <%= f.text_field :rcvd_id %>
  </p>
  <p>
    <%= f.label :link_type %><br />
    <%= f.text_field :link_type %>
  </p>
  <p>
    <%= f.label :summary %><br />
    <%= f.text_area :summary %>
  </p>
  <p>
    <%= f.label :active %><br />
    <%= f.check_box :active %>
  </p>
  <p>
    <%= f.submit 'Create' %>
  </p>
<% end %>

-- 结束大块代码 --

好的，现在连接点。

为自动完成提供数据作为建议

让我们首先连接一些自动完成文本字段可以显示在下拉建议中的数据。我们将使用的格式是 JSON，但如果您不熟悉它，请不要担心......我也不熟悉 =)。知道它是一种格式化文本的方法，以便您/其他应用程序的其他部分可以使用它，就足够了。

文本字段自动完成所需的数据在“ ”中指定。来源: ' 选项。因为我们想将人员姓名及其 ID 列表发送到自动完成功能，所以我们将以下内容作为源。

source: '<%= people_path(:json) %>'  

上面的 rails 助手将转换为字符串“ /people.json ”。您无需在“ /people.json ”处创建页面。您需要做的是告诉您的 people_controller 在收到 .json 格式的/people 请求时该做什么。将以下内容放入您的 people_controller 中:

def index  
# I will explain this part in a moment.
  if params[:term]
    @people = Person.find(:all,:conditions => ['given_name LIKE ?', "#{params[:term]}%"])
  else
    @people = Person.all
  end

  respond_to do |format|  
    format.html # index.html.erb  
# Here is where you can specify how to handle the request for "/people.json"
    format.json { render :json => @people.to_json }
    end
end

现在我们将@people 中的所有人都发送到自动完成文本字段。这就引出了下一点。

用于自动完成建议的过滤数据，基于输入

自动完成文本字段如何知道如何根据您输入的内容过滤结果？

分配给文本字段的自动完成小部件会将您在文本字段中输入的任何内容作为参数发送到您的源:。发送的参数是“ term ”。因此，如果您要在文本字段中输入“Joe”，我们将执行以下操作:

/people.json?term=joe

这就是为什么我们在 Controller 中有以下内容:

# If the autocomplete is used, it will send a parameter 'term', so we catch that here
    if params[:term]
# Then we limit the number of records assigned to @people, by using the term value as a filter.
      @people = Person.find(:all,:conditions => ['given_name LIKE ?', "#{params[:term]}%"])
# In my example, I still need to access all records when I first render the page, so for normal use I assign all. This has nothing to do with the autocomplete, just showing you how I used it in my situation.
    else
      @people = Person.all
    end

既然我们已经根据输入到自动完成文本字段中的内容限制了分配给 @people 的记录数量，我们现在可以将其转换为 JSON 格式以提供自动完成建议。

respond_to do |format|  
      format.html # index.html.erb  
      format.json { render :json => @people.to_json }
    end 

现在，只需查看“代码大块”中的注释，它应该可以解释其余部分是如何联系在一起的。

最后，您的页面上应该有一个充当自动完成功能的文本字段和一个隐藏字段，它将参数中的 ID 发送到您的 Controller 。

自定义您自己的自动完成

一旦理解了上述内容并希望对其进行修改以供使用，您应该知道从 Controller 返回的 JSON 格式如下所示:

[{"person":{"id":1,"given_name":"joe","middle_name":"smith","family_name":"jones","nationality":"australian"}}]

在这种情况下，从 javascript 中的 JSON 字符串访问不同值的方法是:

ui.item.person.name_of_some_attribute_such_as_given_name

漂亮，简单。很像在 Rails 中访问 ActiveRecord 属性。

最后一点。我花了很多时间寻找一种不同的方式来提供隐藏值，因为我认为这个函数应该已经内置到 jquery 小部件中。然而，这种情况并非如此。 jQuery 官方示例中清楚地表明，发送不同值然后选择作为参数的方法是使用隐藏字段。

好吧，我希望这对某人有所帮助。

戴尔