Framework7 - Autocomplete

Descrição

O Autocomplete é um componente otimizado para toque e móvel do Framework7, que pode ser suspenso ou autônomo. Você pode criar e inicializar a instância do Autocomplete usando o método JavaScript -

myApp.autocomplete(parameters)

Onde os parâmetros são objetos obrigatórios usados para inicializar a instância do Autocomplete.

Parâmetros de preenchimento automático

A tabela a seguir lista os parâmetros de preenchimento automático disponíveis no Framework7 -

S.Não	Parâmetros e descrição	Tipo	Padrão
1	openIn Ele define como abrir um Autocomplete que pode ser usado como lista suspensa, popup ou página.	corda	página
2	source Ele usa instância de autocomplete, consulta de pesquisa e função de renderização para passar itens correspondentes com array.	função (preenchimento automático, consulta, renderização)	-
3	valueProperty Ele especifica o valor do item da chave do objeto de item correspondente.	corda	Eu iria
4	limit Ele exibe o número limitado de itens no preenchimento automático por consulta.	número	-
5	preloader O pré-carregador pode ser usado para especificar o layout de preenchimento automático definindo-o como verdadeiro.	boleano	falso
6	preloaderColor Ele especifica a cor do pré-carregador. Por padrão, a cor é "preto".	corda	-
7	value Define a matriz com os valores padrão selecionados.	matriz	-
8	textProperty Ele especifica o valor do item da chave do objeto de item correspondente, que pode ser usado como um título das opções exibidas.	corda	texto

Parâmetros de preenchimento automático autônomo

A tabela a seguir lista os parâmetros de preenchimento automático autônomo disponíveis no Framework7 -

S.Não	Parâmetros e descrição	Tipo	Padrão
1	opener É um parâmetro de string ou elemento HTML, que abrirá a página autocomplete autônoma.	string ou HTMLElement	-
2	popupCloseText É usado para fechar o pop-up de preenchimento automático.	corda	'Fechar'
3	backText Ele fornece o link de retorno quando o preenchimento automático é aberto como página.	corda	'De volta'
4	pageTitle Ele especifica o título da página de preenchimento automático.	corda	-
5	searchbarPlaceholderText Ele especifica o texto do espaço reservado da barra de pesquisa.	corda	'Pesquisa'
6	searchbarCancelText Ele define o texto do botão de cancelamento da barra de pesquisa.	corda	'cancelar'
7	notFoundText Ele exibe o texto quando nenhum elemento correspondente é encontrado.	corda	'Nada encontrado'
8	multiple Permite selecionar a seleção múltipla definindo-a como verdadeira.	boleano	falso
9	navbarTheme Ele especifica o tema de cores para navbar.	corda	-
10	backOnSelect Quando o usuário escolhe o valor, o preenchimento automático será fechado configurando-o como verdadeiro.	boleano	falso
11	formTheme Ele especifica o tema de cores do formulário.	corda	-

Parâmetros de preenchimento automático suspenso

A tabela a seguir lista os parâmetros de preenchimento automático suspenso disponíveis no Framework7 -

S.Não	Parâmetros e descrição	Tipo	Padrão
1	input É uma string ou elemento HTML usado para entrada de texto.	string ou HTMLElement	-
2	dropdownPlaceholderText Ele especifica o texto do marcador de posição suspenso.	corda	-
3	updateInputValueOnSelect Você pode atualizar o valor de entrada na seleção definindo-o como verdadeiro.	boleano	verdadeiro
4	expandInput Você pode expandir a entrada de texto no modo de exibição de lista para tornar a tela inteira visível durante o menu suspenso, definindo a entrada de item como verdadeira.	boleano	falso

Funções de preenchimento automático de retorno de chamada

A tabela a seguir lista os parâmetros de preenchimento automático suspenso disponíveis no Framework7 -

S.Não	Parâmetros e descrição	Tipo	Padrão
1	onChange Sempre que o valor de preenchimento automático for alterado, esta função de retorno de chamada será executada.	função (preenchimento automático, valor)	-
2	onOpen Sempre que o preenchimento automático for aberto, esta função de retorno de chamada será executada.	função (autocompletar)	-
3	onClose Sempre que o autocomplete for fechado, esta função de retorno de chamada será executada.	função (autocompletar)	-

Modelos de preenchimento automático

A tabela a seguir lista os parâmetros de preenchimento automático suspenso disponíveis no Framework7 -

S.Não	Parâmetros e descrição	Tipo	Padrão
1	navbarTemplate É um template autocomplete navbar autônomo.	corda	-
2	itemTemplate É um item de formulário template7 autônomo.	corda	-
3	dropdownTemplate É o modelo suspenso template7.	corda	-
4	dropdownItemTemplate É o item da lista suspensa template7.	corda	-
5	dropdownPlaceholderTemplate É um item de espaço reservado de dropdown template7.	corda	-

Modelos padrão

A seguir estão os trechos de código do modelo padrão para os parâmetros dos modelos definidos acima -

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>

Métodos de preenchimento automático

A tabela a seguir especifica os métodos de preenchimento automático disponíveis no Framework7 -

S.Não	Métodos e Descrição
1	myAutocomplete.params Define os parâmetros de inicialização que são passados com o objeto.
2	myAutocomplete.value Ele define a matriz com os valores selecionados.
3	myAutocomplete.opened Ele abre o Autocomplete se estiver definido como verdadeiro.
4	myAutocomplete.dropdown Ele especifica uma instância do menu suspenso Autocomplete.
5	myAutocomplete.popup Ele especifica uma instância de pop-up de preenchimento automático.
6	myAutocomplete.page Ele especifica uma instância de página de preenchimento automático.
7	myAutocomplete.pageData Ele define os dados da página de preenchimento automático.
8	myAutocomplete.searchbar Ele define a instância da barra de pesquisa do Autocomplete.

Propriedades de preenchimento automático

A tabela a seguir especifica os métodos de preenchimento automático disponíveis no Framework7 -

S.Não	Propriedades e descrição
1	myAutocomplete.open() Ele abre o Autocomplete, que pode ser usado como menu suspenso, pop-up ou página.
2	myAutocomplete.close() Ele fecha o Autocomplete.
3	myAutocomplete.showPreloader() Mostra o pré-carregador do Autocomplete.
4	myAutocomplete.hidePreloader() Ele oculta o pré-carregador do Autocomplete.
5	myAutocomplete.destroy() Ele destrói a instância do pré-carregador de Autocomplete e remove todos os eventos.

Exemplo

O exemplo a seguir demonstra o uso de parâmetros de preenchimento automático ocultos no 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>

Resultado

Vamos realizar as seguintes etapas para ver como funciona o código fornecido acima -

Salve o código HTML fornecido acima como autocomplete.html arquivo na pasta raiz do servidor.
Abra este arquivo HTML como http: //localhost/autocomplete.html e a saída é exibida conforme mostrado abaixo.
O exemplo fornece preenchimento automático de valores em lista suspensa simples, lista suspensa com todos os valores, lista suspensa com espaço reservado, preenchimento automático autônomo etc.

↰ Previous page Next page ↱