Cómo crear un campo de autocompletar en su formulario

¿Le gustaría crear un campo de autocompletar en su formulario? La funcionalidad de autocompletar puede mejorar significativamente la experiencia del usuario proporcionando sugerencias a medida que escribe, ahorrando tiempo y garantizando la coherencia de los datos. En este artículo, mostraremos cómo utilizar JavaScript para implementar la función de autocompletar en un campo de entrada de texto con una lista de respuestas preaprobadas.

Creación del formulario

Comenzaremos creando un nuevo formulario y añadiendo nuestros campos, que incluirán al menos un campo de formulario de Texto en una línea. Si necesita ayuda para crear su formulario, consulte esta útil guía.

cree su formulario y añada sus campos

Crear un campo de autocompletar

Ahora es el momento de añadir este fragmento a su sitio. Si necesitas ayuda sobre dónde y cómo añadir un fragmento personalizado a tu sitio, consulta este tutorial.

/**
 * Turn any Single Line Text field into an autocomplete field
 *
 * @link https://wpforms.com/developers/how-to-create-an-autocomplete-field-in-your-form/
 */
  
function wpf_dev_text_autocomplete( ) {
?>
 
<script>
function autocomplete(inp, arr) {

  /*the autocomplete function takes two arguments,
  the text field element and an array of possible autocompleted values:*/
  var currentFocus;

  /*execute a function when someone writes in the text field:*/
  inp.addEventListener("input", function(e) {
      var a, b, i, val = this.value;

      /*close any already open lists of autocompleted values*/
      closeAllLists();
      if (!val) { return false;}
      currentFocus = -1;

      /*create a DIV element that will contain the items (values):*/
      a = document.createElement("DIV");
      a.setAttribute("id", this.id + "autocomplete-list");
      a.setAttribute("class", "autocomplete-items");

      /*append the DIV element as a child of the autocomplete container:*/
      this.parentNode.appendChild(a);

      /*for each item in the array...*/
      for (i = 0; i < arr.length; i++) {

        /*check if the item starts with the same letters as the text field value:*/
        if (arr[i].substr(0, val.length).toUpperCase() == val.toUpperCase()) {

          /*create a DIV element for each matching element:*/
          b = document.createElement("DIV");

          /*make the matching letters bold:*/
          b.innerHTML = "<strong>" + arr[i].substr(0, val.length) + "</strong>";
          b.innerHTML += arr[i].substr(val.length);

          /*insert a input field that will hold the current array item's value:*/
          b.innerHTML += "<input type='hidden' value='" + arr[i] + "'>";

          /*execute a function when someone clicks on the item value (DIV element):*/
          b.addEventListener("click", function(e) {

              /*insert the value for the autocomplete text field:*/
              inp.value = this.getElementsByTagName("input")[0].value;

              /*close the list of autocompleted values,
              (or any other open lists of autocompleted values:*/
              closeAllLists();
          });
          a.appendChild(b);
        }
      }
  });

  /*execute a function presses a key on the keyboard:*/
  inp.addEventListener("keydown", function(e) {
      var x = document.getElementById(this.id + "autocomplete-list");
      if (x) x = x.getElementsByTagName("div");
      if (e.keyCode == 40) {

        /*If the arrow DOWN key is pressed,
        increase the currentFocus variable:*/
        currentFocus++;

        /*and and make the current item more visible:*/
        addActive(x);
      } else if (e.keyCode == 38) { //up

        /*If the arrow UP key is pressed,
        decrease the currentFocus variable:*/
        currentFocus--;

        /*and and make the current item more visible:*/
        addActive(x);
      } else if (e.keyCode == 13) {

        /*If the ENTER key is pressed, prevent the form from being submitted,*/
        e.preventDefault();
        if (currentFocus > -1) {

          /*and simulate a click on the "active" item:*/
          if (x) x[currentFocus].click();
        }
      }
  });

  function addActive(x) {

    /*a function to classify an item as "active":*/
    if (!x) return false;

    /*start by removing the "active" class on all items:*/
    removeActive(x);
    if (currentFocus >= x.length) currentFocus = 0;
    if (currentFocus < 0) currentFocus = (x.length - 1);

    /*add class "autocomplete-active":*/
    x[currentFocus].classList.add("autocomplete-active");
  }

  function removeActive(x) {

    /*a function to remove the "active" class from all autocomplete items:*/
    for (var i = 0; i < x.length; i++) {
      x[i].classList.remove("autocomplete-active");
    }
  }

  function closeAllLists(elmnt) {

    /*close all autocomplete lists in the document,
    except the one passed as an argument:*/
    var x = document.getElementsByClassName("autocomplete-items");
    for (var i = 0; i < x.length; i++) {
      if (elmnt != x[i] && elmnt != inp) {
        x[i].parentNode.removeChild(x[i]);
      }
    }
  }

  /*execute a function when someone clicks in the document:*/
  document.addEventListener("click", function (e) {
      closeAllLists(e.target);
  });
}

/*An array containing all the programming class names*/
var classes = ["JavaScript","HTML/CSS","Python","C","C+","C++","Java","TypeScript","Pearl","R","SQL","PHP"];

/*initiate the autocomplete function on the "myInput" element, and pass along the countries array as possible autocomplete values:*/
autocomplete(document.getElementById("wpforms-3241-field_6"), classes);
</script>

<?php
}
 
add_action( 'wpforms_wp_footer_end', 'wpf_dev_text_autocomplete', 30 );

El autocomplete(document.getElementById("wpforms-3241-field_6"), classes); se centrará específicamente en el formulario ID 3241 y el campo ID 6 y cuando se haga clic en ese campo, se activará este fragmento y se intentará realizar un autocomplete basado en los caracteres que se escriben en el campo mientras se busca dentro de la lista de clases que tenemos aquí en el fragmento.

var classes = ["JavaScript", "HTML/CSS", "Python", "C", "C+", "C++", "Java", "TypeScript", "Pearl", "R", "SQL", "PHP"];

Tendrá que actualizar la lista de clases para que coincida con lo que necesita para su campo. También tendrá que actualizar el wpforms-3241-campo_6 para que coincida con sus propios IDs. Para obtener ayuda en la búsqueda de sus IDs, por favor revise este tutorial.

Añadir el CSS

Nuestro último paso es añadir algo de CSS. Copia y pega este CSS en tu sitio. Si necesitas ayuda sobre cómo y dónde añadir CSS personalizado, consulta este tutorial.

.autocomplete-items div {
  padding: 10px;
  cursor: pointer;
  background-color: #f6f6f6;
  border: 1px solid #cccccc;
  font-size: 12px;
}

/*when hovering an item:*/
.autocomplete-items div:hover {
  background-color: #e9e9e9; 
}

/*when navigating through the items using the arrow keys:*/
.autocomplete-active {
  background-color: #1E90FF !important; 
  color: #ffffff; 
}

Y ya está. Hemos convertido con éxito un campo de texto de una sola línea en un campo de autocompletar. ¿Desea agregar un campo selector de color a su formulario? Consulte nuestro tutorial sobre Cómo agregar un selector de color a su formulario.

ahora tiene un campo de autocompletar

Acción de referencia

wpforms_wp_footer_end