Framework7 Autocomplete

In Framework7, autocomplete is a mobile friendly and touch optimized component, which can be as dropdown or in standalone way. You can create and initialize Autocomplete instance by using the JavaScript method:

Here, parameters are required objects used to initialize the Autocomplete instance.

Autocomplete Parameters in Framework7

Following is a list of autocomplete parameters in Framework7:

Index	Parameter	Type	Description
1)	openIn	string	It defines how to open an Autocomplete which could be used as dropdown, popup or page.
2)	source	function (autocomplete, query, render)	It uses autocomplete instance, search query and renders function to pass matched items with array.
3)	valueProperty	string	It specifies the item value of matched item object's key.
4)	limit	number	It displays the limited number of items in autocomplete per query.
5)	preloader	boolean	Preloader can be used to specify autocomplete layout by setting it to true.
6)	preloaderColor	string	It specifies the preloader color. By default, the color is "black".
7)	value	array	Defines the array with default selected values.
8)	textProperty	string	It specifies the item value of matched item object's key, which can be used as a title of displayed options.

Standalone Autocomplete Parameters

Index	Parameter	Type	Description
1)	opener	string or HTMLElement	It is string or html element parameter, which will open the standalone autocomplete page.
2)	popupclosetext	string	It is used to close the autocomplete popup.
3)	backtext	string	It provides the back link when autocomplete is opened as page.
4)	pagetitle	string	It specifies the autocomplete page title.
5)	searchbarplaceholdertext	string	It specifies the search bar placeholder text.
6)	searchbarcanceltext	string	It defines the search bar cancel button text.
7)	notfoundtext	string	It displays the text when there is no matched element found.
8)	multiple	boolean td>	It allows to select multiple selection by setting it to true.
9)	navbartheme	string	It specifies the color theme for navbar.
10)	backonselect	boolean	When the user picks value, the autocomplete will be closed by setting it to true.
11)	formtheme	string	It specifies the color theme for form.

Dropdown Autocomplete Parameters

A list of dropdown autocomplete parameter:

Index	Parameter	Type	Description
1)	input	string or HTML Element	It is string or HTML element used for text input.
2)	dropdownPlaceholderText	string	It specifies the dropdown placeholder text.
3)	updateInputValueOnSelect	boolean	It is used to update the input value on select by setting it to true.
4)	expandInput	boolean	You can expand the text input in List View to make full screen wide during dropdown visible by setting item-input it to true.

Autocomplete Callbacks Functions

Index	Parameter	Type	Description
1)	onChange	function (autocomplete, value)	Whenever the autocomplete value is changed, this callback function will be executed.
2)	onOpen	function (autocomplete)	Whenever autocomplete is opened, this callback function will be executed.
3)	onClose	function (autocomplete)	Whenever autocomplete is closed, this callback function will be executed.

Autocomplete Templates

Index	Parameter	Type	Description
1)	navbarTemplate	string	It is standalone autocomplete navbar template.
2)	itemTemplate	string	It is standalone template7 form item.
3)	dropdownTemplate	string	It is template7 dropdown template.
4)	dropdownItemTemplate	string	It is template7 dropdown list item.
5)	dropdownPlaceholderTemplate	string	It is template7 dropdown placeholder item.

Autocomplete Properties

Following is a list of autocomplete properties in Framework7:

Index	Properties	Description
1)	myAutocomplete.params	Defines the initialization parameters that are passes with object.
2)	myAutocomplete.value	It defines the array with selected values.
3)	myAutocomplete.opened	It opens the Autocomplete if it is set to true.
4)	myAutocomplete.dropdown	It specifies an instance of Autocomplete dropdown.
5)	myAutocomplete.popup	It specifies an instance of Autocomplete popup.
6)	myAutocomplete.page	It specifies an instance of Autocomplete page.
7)	myAutocomplete.pageData	It defines Autocomplete page data.
8)	myAutocomplete.searchbar	It defines Autocomplete searchbar instance.

Autocomplete Methods

Following is a list of autocomplete methods:

Index	Methods	Description
1)	myAutocomplete.open()	It opens the Autocomplete, which could be used as dropdown, popup or page.
2)	myAutocomplete.close()	It closes the Autocomplete.
3)	myAutocomplete.showPreloader()	It shows the Autocomplete preloader.
4)	myAutocomplete.hidePreloader()	It hides the Autocomplete preloader.
5)	myAutocomplete.destroy()	It ruins the Autocomplete preloader instance and removes all events.

Autocomplete Example

Let's take an example to demonstrate the use of all the autocomplete parameters in the 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>

Test it Now

Next TopicFramework7 Infinite Scroll

← prev next →