Framework7 - 自动完成

描述

autocomplete自动完成是 Framework7 的移动友好且触摸优化的组件,可以作为下拉列表或独立方式。您可以使用 JavaScript 方法创建和初始化自动完成实例 −

myApp.autocomplete(parameters)

其中 parameters 是用于初始化自动完成实例的必需对象。

自动完成参数

下表列出了 Framework7 中可用的自动完成参数 −

S.No 参数 &描述 类型 默认
1

openIn

它定义如何打开可用作下拉菜单、弹出窗口或页面的自动完成功能。

string 页面
2

它使用自动完成实例、搜索查询和渲染函数通过数组传递匹配的项目。

函数(自动完成、查询、渲染) -
3

valueProperty

指定匹配项对象的键的项值。

string id
4

limit

每个查询在自动完成中显示的项目数量限制。

number -
5

preloader

Preloader 可用于通过以下方式指定自动完成布局将其设置为 true。

boolean false
6

preloaderColor

它指定预加载器颜色。默认情况下,颜色为"黑色"。

string -
7

value

定义具有默认选定值的数组。

array -
8

textProperty

指定匹配的 item 对象的 key 的 item 值,可用作显示选项的标题。

string text

独立自动完成参数

下表列出了 Framework7 中可用的独立自动完成参数 −

S.No 参数 &描述 类型 默认
1

opener

它是字符串或 HTML 元素参数,将打开独立的自动完成页面。

字符串或 HTMLElement -
2

popupCloseText

用于关闭自动完成弹出窗口。

string 'Close'
3

backText

当自动完成作为页面打开时,它提供返回链接。

string 'Back'
4

pageTitle

它指定自动完成页面标题。

string -
5

searchbarPlaceholderText

它指定搜索栏占位符文本。

string '搜索'
6

searchbarCancelText

定义搜索栏取消按钮文本。

string '取消'
7

notFoundText

未找到匹配元素时显示文本。

string '未找到任何内容'
8

multiple

设置为 true 允许选择多项。

boolean false
9

navbarTheme

指定导航栏的颜色主题。

string -
10

backOnSelect

当用户选择值时,设置为 true 即可关闭自动完成功能。

boolean false
11

formTheme

指定表单的颜色主题。

string -

下拉自动完成参数

下表列出了 Framework7 中可用的下拉自动完成参数 −

S.No 参数 &描述 类型 默认
1

input

用于文本输入的字符串或 HTML 元素。

字符串或 HTMLElement -
2

dropdownPlaceholderText

指定下拉占位符文本。

string -
3

updateInputValueOnSelect

您可以通过将其设置为 true 来更新选择时的输入值。

boolean true
4

expandInput

您可以通过将 item-input 设置为 true 来扩展列表视图中的文本输入,以便在下拉时全屏显示。

boolean false

自动完成回调函数

下表列出了 Framework7 中可用的下拉自动完成参数 −

S.No 参数 &描述 类型 默认
1

onChange

每当自动完成值发生变化时,都会执行此回调函数。

function (autocomplete, value) -
2

onOpen

每当打开自动完成时,都会执行此回调函数。

function (autocomplete) -
3

onClose

每当自动完成关闭时,都会执行此回调函数。

function (autocomplete) -

自动完成模板

下表列出了 Framework7 中可用的下拉自动完成参数 −

S.No 参数 &描述 类型 默认
1

navbarTemplate

它是独立的自动完成导航栏模板。

string -
2

itemTemplate

它是独立的模板7表单项。

string -
3

dropdownTemplate

这是template7下拉模板。

string -
4

dropdownItemTemplate

这是template7下拉列表项。

string -
5

dropdownPlaceholderTemplate

这是template7下拉占位符项。

string -

默认模板

以下是上述定义的模板参数的默认模板代码片段 −

navbarTemplate

<div class = "navbar {{#if navbarTheme}}theme-{{navbarTheme}}{{/if}}">
   <div class = "navbar-inner">
      <div class = "left sliding">
         {{#if material}}
            <a href = "#" class = "link {{#if inPopup}}close-popup{{else}}back{{/if}} icon-only">
               <i class = "icon icon-back"></i>
            </a>
         {{else}}
            <a href = "#" class = "link {{#if inPopup}}close-popup{{else}}back{{/if}}">
               <i class = "icon icon-back"></i>
               {{#if inPopup}}
                  <span>{{popupCloseText}}</span>
               {{else}}
                  <span>{{backText}}</span>
               {{/if}}
            </a>
         {{/if}}
      </div>

      <div class = "center sliding">{{pageTitle}}</div>
      {{#if preloader}}
         <div class = "right">
            <div class = "autocomplete-preloader preloader 
               {{#if preloaderColor}}
                  preloader-{{preloaderColor}}
               {{/if}}">
            </div>
         </div>
      {{/if}}
   </div>
</div>
 

itemTemplate

<li>
   <label class = "label-{{inputType}} item-content">
      <input type = "{{inputType}}" name = "{{inputName}}" value = "{{value}}" {{#if selected}}checked{{/if}}>
      {{#if material}}
         <div class = "item-media">
            <i class = "icon icon-form-{{inputType}}"></i>
         </div>
            
         <div class = "item-inner">
            <div class = "item-title">{{text}}</div>
         </div>
      {{else}}
         {{#if checkbox}}
            <div class = "item-media">
               <i class = "icon icon-form-checkbox"></i>
            </div>
         {{/if}}
            
         <div class = "item-inner">
            <div class = "item-title">{{text}}</div>
         </div>
      {{/if}}
   </label>
</li>
 

dropdownTemplate

<div class = "autocomplete-dropdown">
   <div class = "autocomplete-dropdown-inner">
      <div class = "list-block">
         <ul></ul>
      </div>
   </div>
   
   {{#if preloader}}
      <div class = "autocomplete-preloader preloader 
         {{#if preloaderColor}}
            preloader-{{preloaderColor}}
         {{/if}}">
         {{#if material}}
            {{materialPreloaderHtml}}
         {{/if}}
      </div>
   {{/if}}
</div>
 

dropdownItemTemplate

<li>
   <label class = "{{#unless placeholder}}label-radio{{/unless}} item-content" data-value = "{{value}}">
      <div class = "item-inner">
         <div class = "item-title">{{text}}</div>
      </div>
   </label>
</li>
 

dropdownPlaceholderTemplate

<li class = "autocomplete-dropdown-placeholder">
   <div class = "item-content">
      <div class = "item-inner">
         <div class = "item-title">{{text}}</div>
      </div>
   </label>
</li>
 

自动完成方法

下表指定了 Framework7 中可用的自动完成方法 −

S.No 方法 &描述
1

myAutocomplete.params

定义与对象一起传递的初始化参数。

2

myAutocomplete.value

它定义具有选定值的数组。

3

myAutocomplete.opened

如果设置为 true,则打开自动完成功能。

4

myAutocomplete.dropdown

它指定自动完成的一个实例下拉菜单。

5

myAutocomplete.popup

它指定自动完成弹出窗口的一个实例。

6

myAutocomplete.page

它指定自动完成页面的一个实例。

7

myAutocomplete.pageData

它定义自动完成页面数据。

8

myAutocomplete.searchbar

它定义自动完成搜索栏实例。

自动完成属性

下表指定了 Framework7 中可用的自动完成方法 −

S.No 属性 &描述
1

myAutocomplete.open()

打开自动完成功能,可用作下拉菜单、弹出窗口或页面。

2

myAutocomplete.close()

关闭自动完成功能。

3

myAutocomplete.showPreloader()

显示自动完成预加载器。

4

myAutocomplete.hidePreloader()

隐藏自动完成预加载器。

5

myAutocomplete.destroy()

它会破坏自动完成预加载器实例并删除所有事件。

示例

以下示例演示了在 Framework7 中隐藏自动完成参数的使用 −

<!DOCTYPE html>
<html>

   <head>
      <meta name = "viewport" content = "width = device-width, initial-scale = 1, 
         maximum-scale = 1, minimum-scale = 1, user-scalable = no, minimal-ui" />
      <meta name = "apple-mobile-web-app-capable" content = "yes" />
      <meta name = "apple-mobile-web-app-status-bar-style" content = "black" />
      <title>Autocomplete</title>
      <link rel = "stylesheet" 
         href = "https://cdnjs.cloudflare.com/ajax/libs/framework7/1.4.2/css/framework7.ios.min.css" />
      <link rel = "stylesheet" 
         href = "https://cdnjs.cloudflare.com/ajax/libs/framework7/1.4.2/css/framework7.ios.colors.min.css" />
   </head>

   <body>
      <div class = "views">
         <div class = "view view-main">
            <div class = "pages">
               <div data-page = "home" class = "page navbar-fixed">
               
                  <div class = "navbar">
                     <div class = "navbar-inner">
                        <div class = "left"> </div>
                        <div class = "center">Autcomplete</div>
                        <div class = "right"> </div>
                     </div>
                  </div>
               
                  <div class = "page-content">
                     <div class = "content-block-title">Simple Dropdown Autocomplete</div>
                     <div class = "list-block">
                        <ul>
                           <li class = "item-content">
                              <div class = "item-title label">Country</div>
                              <div class = "item-input">
                                 <input type = "text" placeholder = "Country" id = "autocomplete-dropdown">
                              </div>
                           </li>
                        </ul>
                     </div>
                  
                     <div class = "content-block-title">Dropdown With Input Expand</div>
                     <div class = "list-block">
                        <ul>
                           <li class = "item-content">
                              <div class = "item-title label">Country</div>
                              <div class = "item-input">
                                 <input type = "text" placeholder = "Country" id = "autocomplete-dropdown-expand">
                              </div>
                           </li>
                        </ul>
                     </div>
                  
                     <div class = "content-block-title">Dropdown With All Values</div>
                     <div class = "list-block">
                        <ul>
                           <li class = "item-content">
                              <div class = "item-title label">Country</div>
                              <div class = "item-input">
                                 <input type = "text" placeholder = "Country" id = "autocomplete-dropdown-all">
                              </div>
                           </li>
                        </ul>
                     </div>
                  
                     <div class = "content-block-title">Dropdown With Placeholder</div>
                     <div class = "list-block">
                        <ul>
                           <li class = "item-content">
                              <div class = "item-title label">Country</div>
                              <div class = "item-input">
                                 <input type = "text" placeholder = "Country" id = "autocomplete-dropdown-placeholder">
                              </div>
                           </li>
                        </ul>
                     </div>
                  
                     <div class = "content-block-title">Simple Standalone Autocomplete</div>
                     <div class = "list-block">
                        <ul>
                           <li>
                              <a href = "#" id = "autocomplete-standalone" class = "item-link item-content autocomplete-opener">
                                 <input type = "hidden">
                                 <div class = "item-inner">
                                    <div class = "item-title">Favorite Country</div>
                                    <div class = "item-after"></div>
                                 </div>
                              </a>
                           </li>
                        </ul>
                     </div>
                  
                     <div class = "content-block-title">Popup Standalone Autocomplete</div>
                     <div class = "list-block">
                        <ul>
                           <li>
                              <a href = "#" id = "autocomplete-standalone-popup" class = "item-link item-content autocomplete-opener">
                                 <input type = "hidden">
                                 <div class = "item-inner">
                                    <div class = "item-title">Favorite Country</div>
                                    <div class = "item-after"></div>
                                 </div>
                              </a>
                           </li>
                        </ul>
                     </div>
                  
                     <div class = "content-block-title">Multiple Values Standalone Autocomplete</div>
                     <div class = "list-block">
                        <ul>
                           <li>
                              <a href = "#" id = "autocomplete-standalone-multiple" class = "item-link item-content autocomplete-opener">
                                 <input type = "hidden">
                                 <div class = "item-inner">
                                    <div class = "item-title">Favorite Countries</div>
                                    <div class = "item-after"></div>
                                 </div>
                              </a>
                           </li>
                        </ul>
                     </div>
                  </div> 
                  
               </div>
            </div>
         </div>
      </div>
      
      <script type  =  "text/javascript" 
         src  =  "https://cdnjs.cloudflare.com/ajax/libs/framework7/1.4.2/js/framework7.min.js"></script>
         
      <script>
         var myApp  =  new Framework7();
         var $$  =  Dom7;
         var mainView  =  myApp.addView('.view-main');
         
         // Countries data array
         var countries  =  ('India Africa Australia NewZealand England WestIndies Scotland Zimbabwe Srilanka Bangladesh').split(' ');

         // Simple Dropdown
         var autocompleteDropdownSimple  =  myApp.autocomplete ({
            input: '#autocomplete-dropdown',
            openIn: 'dropdown',
            
            source: function (autocomplete, query, render) {
               var results  =  [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               
               // 可以找到匹配的项目
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
               // 通过传递带有结果项的数组来显示项目
               render(results);
            }
         });

         // Dropdown with input expand
         var autocompleteDropdownExpand = myApp.autocomplete ({
            input: '#autocomplete-dropdown-expand',
            openIn: 'dropdown',
            expandInput: true,   // expandInput 用作列表视图中的项目输入,将扩展到全屏宽度
                                 //during dropdown
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               // Find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) results.push(countries[i]);
               }
               // 通过传递带有结果项的数组来显示项目
               render(results);
            }
         });

         // Dropdown with all values
         var autocompleteDropdownAll = myApp.autocomplete ({
            input: '#autocomplete-dropdown-all',
            openIn: 'dropdown',
            
            source: function (autocomplete, query, render) {
               var results = [];
               
               // 可以找到匹配的项目
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
               // 通过传递带有结果项的数组来显示项目
               render(results);
            }
         });

         // Dropdown with placeholder
         var autocompleteDropdownPlaceholder = myApp.autocomplete ({
            input: '#autocomplete-dropdown-placeholder',
            openIn: 'dropdown',
            dropdownPlaceholderText: 'Type as "India"',
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               
               // 可以找到匹配的项目
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
                  
               // 通过传递带有结果项的数组来显示项目
               render(results);
            }
         });

         // Simple Standalone
         var autocompleteStandaloneSimple = myApp.autocomplete ({
            openIn: 'page', //open in page
            opener: $$('#autocomplete-standalone'), //打开自动完成的链接
            backOnSelect: true, //go back after we select something
            
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               
               // 可以找到匹配的项目
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
               // 通过传递带有结果项的数组来显示项目
               render(results);
            },
               
            onChange: function (autocomplete, value) {
               // 此处将项目文本值添加到 item-after
               $$('#autocomplete-standalone').find('.item-after').text(value[0]);
               
               // 您可以将项目值添加到输入值中
               $$('#autocomplete-standalone').find('input').val(value[0]);
            }
         });

         // Standalone Popup
         var autocompleteStandalonePopup = myApp.autocomplete ({
            openIn: 'popup', // Opens the Autocomplete in page
            opener: $$('#autocomplete-standalone-popup'), // 它将打开独立的自动完成弹出窗口
            backOnSelect: true, //选择项目后,返回页面
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
            
               // 可以找到匹配的项目
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) results.push(countries[i]);
               }
            
               // 通过传递带有结果项的数组来显示项目
               render(results);
            },
            
            onChange: function (autocomplete, value) {
               // 此处将项目文本值添加到 item-after
               $$('#autocomplete-standalone-popup').find('.item-after').text(value[0]);
               
               // 您可以将项目值添加到输入值中
               $$('#autocomplete-standalone-popup').find('input').val(value[0]);
            }
         });

         // Multiple Standalone
         var autocompleteStandaloneMultiple = myApp.autocomplete ({
            openIn: 'page', //Opens the Autocomplete in page
            opener: $$('#autocomplete-standalone-multiple'), //打开自动完成的链接
            multiple: true, //Allow multiple values
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               
               // 可以找到匹配的项目
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) results.push(countries[i]);
               }
               
               // 通过传递带有结果项的数组来显示项目
               render(results);
            },
            
            onChange: function (autocomplete, value) {
               // 此处将项目文本值添加到 item-after
               $$('#autocomplete-standalone-multiple').find('.item-after').text(value.join(', '));
               
               // 您可以将项目值添加到输入值中
               $$('#autocomplete-standalone-multiple').find('input').val(value.join(', '));
            }
         });
      </script>
   </body>

</html>

输出

让我们执行以下步骤来查看上述代码的工作原理 −

  • 将上述 HTML 代码保存为服务器根文件夹中的 autocomplete.html 文件。

  • 以 http://localhost/autocomplete.html 的形式打开此 HTML 文件,输出显示如下。

  • 此示例提供了简单下拉列表、包含所有值的下拉列表、包含占位符的下拉列表、独立自动完成等中的值自动完成。