Framework7-オートコンプリート

説明

オートコンプリートは、Framework7のモバイルフレンドリーでタッチに最適化されたコンポーネントであり、ドロップダウンまたはスタンドアロンの方法で使用できます。JavaScriptメソッドを使用してオートコンプリートインスタンスを作成および初期化できます-

myApp.autocomplete(parameters)

どこのパラメータは、オートコンプリートのインスタンスを初期化するために使用されるオブジェクトを必要としています。

オートコンプリートパラメータ

次の表に、Framework7で使用可能なオートコンプリートパラメータを示します。

S.No	パラメータと説明	タイプ	デフォルト
1	openIn ドロップダウン、ポップアップ、またはページとして使用できるオートコンプリートを開く方法を定義します。	ストリング	ページ
2	source オートコンプリートインスタンス、検索クエリを使用し、関数をレンダリングして、一致したアイテムを配列で渡します。	関数（オートコンプリート、クエリ、レンダリング）	-
3	valueProperty 一致したアイテムオブジェクトのキーのアイテム値を指定します。	ストリング	id
4	limit クエリごとにオートコンプリートで制限された数のアイテムが表示されます。	数	-
5	preloader プリローダーを使用して、trueに設定することでオートコンプリートレイアウトを指定できます。	ブール値	false
6	preloaderColor プリローダーの色を指定します。デフォルトでは、色は「黒」です。	ストリング	-
7	value デフォルトで選択された値で配列を定義します。	アレイ	-
8	textProperty 一致したアイテムオブジェクトのキーのアイテム値を指定します。これは、表示されるオプションのタイトルとして使用できます。	ストリング	テキスト

スタンドアロンのオートコンプリートパラメータ

次の表に、Framework7で使用可能なスタンドアロンオートコンプリートパラメーターを示します。

S.No	パラメータと説明	タイプ	デフォルト
1	opener これは文字列またはHTML要素パラメータであり、スタンドアロンのオートコンプリートページを開きます。	文字列またはHTMLElement	-
2	popupCloseText オートコンプリートポップアップを閉じるために使用されます。	ストリング	'閉じる'
3	backText オートコンプリートをページとして開いたときにバックリンクを提供します。	ストリング	'バック'
4	pageTitle オートコンプリートページのタイトルを指定します。	ストリング	-
5	searchbarPlaceholderText 検索バーのプレースホルダーテキストを指定します。	ストリング	'探す'
6	searchbarCancelText 検索バーのキャンセルボタンのテキストを定義します。	ストリング	'キャンセル'
7	notFoundText 一致する要素が見つからない場合は、テキストが表示されます。	ストリング	'何も見つかりません'
8	multiple trueに設定することで、複数選択を選択できます。	ブール値	false
9	navbarTheme ナビゲーションバーのカラーテーマを指定します。	ストリング	-
10	backOnSelect ユーザーが値を選択すると、オートコンプリートはtrueに設定して閉じられます。	ブール値	false
11	formTheme フォームのカラーテーマを指定します。	ストリング	-

ドロップダウンオートコンプリートパラメータ

次の表に、Framework7で使用可能なドロップダウンオートコンプリートパラメーターを示します。

S.No	パラメータと説明	タイプ	デフォルト
1	input テキスト入力に使用される文字列またはHTML要素です。	文字列またはHTMLElement	-
2	dropdownPlaceholderText ドロップダウンプレースホルダーテキストを指定します。	ストリング	-
3	updateInputValueOnSelect trueに設定すると、selectの入力値を更新できます。	ブール値	true
4	expandInput item-inputをtrueに設定すると、リストビューで入力したテキストを展開して、ドロップダウン中に全画面を表示できるようになります。	ブール値	false

オートコンプリートコールバック関数

次の表に、Framework7で使用可能なドロップダウンオートコンプリートパラメーターを示します。

S.No	パラメータと説明	タイプ	デフォルト
1	onChange オートコンプリート値が変更されるたびに、このコールバック関数が実行されます。	関数（オートコンプリート、値）	-
2	onOpen オートコンプリートが開かれるたびに、このコールバック関数が実行されます。	関数（オートコンプリート）	-
3	onClose オートコンプリートが閉じられるたびに、このコールバック関数が実行されます。	関数（オートコンプリート）	-

オートコンプリートテンプレート

次の表に、Framework7で使用可能なドロップダウンオートコンプリートパラメーターを示します。

S.No	パラメータと説明	タイプ	デフォルト
1	navbarTemplate スタンドアロンのオートコンプリートナビゲーションバーテンプレートです。	ストリング	-
2	itemTemplate スタンドアロンのtemplate7フォームアイテムです。	ストリング	-
3	dropdownTemplate template7ドロップダウンテンプレートです。	ストリング	-
4	dropdownItemTemplate template7ドロップダウンリストアイテムです。	ストリング	-
5	dropdownPlaceholderTemplate template7ドロップダウンプレースホルダーアイテムです。	ストリング	-

デフォルトのテンプレート

以下は、上記で定義されたテンプレートパラメータのデフォルトのテンプレートコードスニペットです-

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;
               }
               
               // You can find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
               // Display the items by passing array with result items
               render(results);
            }
         });

         // Dropdown with input expand
         var autocompleteDropdownExpand = myApp.autocomplete ({
            input: '#autocomplete-dropdown-expand',
            openIn: 'dropdown',
            expandInput: true,   // expandInput used as item-input in List View will be expanded to full screen wide
                                 //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]);
               }
               // Display the items by passing array with result items
               render(results);
            }
         });

         // Dropdown with all values
         var autocompleteDropdownAll = myApp.autocomplete ({
            input: '#autocomplete-dropdown-all',
            openIn: 'dropdown',
            
            source: function (autocomplete, query, render) {
               var results = [];
               
               // You can find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
               // Display the items by passing array with result items
               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;
               }
               
               // You can find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
                  
               // Display the items by passing array with result items
               render(results);
            }
         });

         // Simple Standalone
         var autocompleteStandaloneSimple = myApp.autocomplete ({
            openIn: 'page', //open in page
            opener: $$('#autocomplete-standalone'), //link that opens autocomplete
            backOnSelect: true, //go back after we select something
            
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               
               // You can find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) 
                     results.push(countries[i]);
               }
               // Display the items by passing array with result items
               render(results);
            },
               
            onChange: function (autocomplete, value) {
               // Here add the item text value to item-after
               $$('#autocomplete-standalone').find('.item-after').text(value[0]);
               
               // You can add item value to input value
               $$('#autocomplete-standalone').find('input').val(value[0]);
            }
         });

         // Standalone Popup
         var autocompleteStandalonePopup = myApp.autocomplete ({
            openIn: 'popup', // Opens the Autocomplete in page
            opener: $$('#autocomplete-standalone-popup'), // It will open standalone autocomplete popup
            backOnSelect: true, //After selecting item, then go back to page
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
            
               // You can find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) results.push(countries[i]);
               }
            
               // Display the items by passing array with result items
               render(results);
            },
            
            onChange: function (autocomplete, value) {
               // Here add the item text value to item-after
               $$('#autocomplete-standalone-popup').find('.item-after').text(value[0]);
               
               // You can add item value to input value
               $$('#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'), //link that opens autocomplete
            multiple: true, //Allow multiple values
            source: function (autocomplete, query, render) {
               var results = [];
               if (query.length === 0) {
                  render(results);
                  return;
               }
               
               // You can find matched items
               for (var i = 0; i < countries.length; i++) {
                  if (countries[i].toLowerCase().indexOf(query.toLowerCase()) >= 0) results.push(countries[i]);
               }
               
               // Display the items by passing array with result items
               render(results);
            },
            
            onChange: function (autocomplete, value) {
               // Here add the item text value to item-after
               $$('#autocomplete-standalone-multiple').find('.item-after').text(value.join(', '));
               
               // You can add item value to input value
               $$('#autocomplete-standalone-multiple').find('input').val(value.join(', '));
            }
         });
      </script>
   </body>

</html>

出力

上記のコードがどのように機能するかを確認するために、次の手順を実行してみましょう-

上記のHTMLコードを次のように保存します autocomplete.html サーバーのルートフォルダにあるファイル。
このHTMLファイルをhttp：//localhost/autocomplete.htmlとして開くと、出力が次のように表示されます。
この例では、単純なドロップダウン、すべての値を含むドロップダウン、プレースホルダーを使用したドロップダウン、スタンドアロンのオートコンプリートなどで値のオートコンプリートを提供しています。