Skip to content

JoseChirinos/plug-yei-input

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Yei Input

Yei Input, es un plugin para realizar busquedas con previsualización de imagenes.

Download

Descargar Yei Input

Requisitos:

Instalación:

  1. Incluir los estilos a nuestro archivo html
  <link rel="stylesheet" href="dist/yei-input.min.css">
  1. Incluir jQuery
  <script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
  1. Incluir yei-input
  <script src="dist/yei-input.min.js"></script>

Sobre su uso

Muy bien ahora para usar yei-input:

  1. Declarar un contenedor para nuestro buscador:
  <div id="yei-input"></div>
  1. Iniciar Yei.
  var yeiInput = new yei({
    element: "#yei-input",
    placeholder: "Buscar...",
    key:['name'],
    list:datos, // arraylist con objetos
    imageDefault: 'images/default.jpg',
    callback: function(res){
      // res: es un objeto resultante
      
      /*
      * Aqui tu código
      */
    }
  })

Opciones

Dentro de las opciones tenemos las siguientes:

  • element: aqui va el ID del contenedor donde estara nuestro buscador.

  • placeholder: es un texto ayuda, para mostrar en el input

  • key: es el valor que queremos buscar ej.

      {
        name: 'Samsung S9',
        detail: 'El mejor Smartphone'
        year: '2018'
      }

    Queremos que la busqueda se enfoque en el name y year:

      var yeiInput = new yei({
        element: "#yei-input",
        placeholder: "Buscar...",
        key:['name', 'year'], // indicamos que se enfoque en name y year
        list:datos, 
        imageDefault: 'images/default.jpg',
        callback: function(res){
          /*
          * Aqui tu código
          */
        }
      })
  • list: es un array con objetos, en el cual se realizara la busqueda ej:

  [
    {
      name: 'Samsung S9',
      detail: 'El mejor Smartphone'
      year: '2018'
    },
    {
      name: 'Huawei P20',
      detail: 'Disfruta de la mejor camara'
      year: '2018'
    },
    {
      name: 'iPhone X',
      detail: 'Tenemos animojis'
      year: '2018'
    }
  ]
  • imageDefault: es la imagen que se mostrara cuando no hay resultados o aun no se a buscado.

  • callback: como lo dice su nombre es un callback, que se ejecuta una ves que elegimos un item, te enviamos un res que es el objeto seleccionado.

Enjoy...!!!

Gracias por utilizar yei-input, Esta libreria mejorara mucho más, si quieres colaborar con el proyecto escribeme a mi cuenta de twitter, @JseChirinos.

About

Search with images, Jquery Plugin by Jose Chirinos

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors