Elemento input (type=search)

Si no sabes lo que es un elemento o cómo debes usarlo, te recomiendo leer el tutorial "Tags y atributos en HTML" que puedes encontrar en la sección de tutoriales HTML.

Descripción

El elemento input, teniendo el valor "search" en su atributo type, representa un campo de texto de una sola línea para propósitos de búsqueda. El control asociado a este campo es una caja de texto que permite a los usuarios editar una sola línea de texto regular. Los controles de búsqueda son útiles para recopilar líneas cortas de texto que los agentes procesadores o programas del lado cliente usarán como parámetros para conducir operaciones de búsqueda.

Un campo de texto regular y un campo de búsqueda son muy similares. La diferencia entre ellos es principalemente estilística: los navegadores pueden representar sus controles de manera diferente, de acuerdo a su propósito.

El contenido del atributo value en este elemento representa al valor incial del control. Este valor es el que será mostrado cuando el documento es cargado y cuando un botón de reinicio es presionado en el formulario.

Ejemplos

En nuestro primer ejemplo recrearemos un formulario de búsqueda básico. En la entrada de búsqueda, haremos uso del atributo placeholder, el cual ha sido introducido en HTML5. Este atributo nos permite dar una pista acerca de la información que se espera sea provista en el control, como ejemplos o descripciones cortas. Esta pista será mostrada dentro del control (como si fuera el valor) sólo cuando el control no tenga un valor real. Cuando el usuario comience a tipear, el texto de placeholder será removido del control.

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Búsqueda de música: <input type="search" name="busquedamusica" placeholder="Canción, autor, álbum...">
    <input type="submit" value="Buscar">
  </p>
</form>

Búsqueda de música:

En el segundo ejemplo, usaremos algunos atributos más: size para establecer el ancho del control como un número de caracteres visibles y maxlength para establecer el número máximo de caracteres que el valor puede tomar.

Los autores no deberían confiar en los atributos minlength y maxlength. Los usuarios podrían enviar la información del formulario con navegadores que (algunos intencionalmente) no soportan estas características.

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Busca un código: <input type="search" name="busquedacodigo" size="4" maxlength="4">
    <input type="submit" value="Buscar">
  </p>
</form>

Busca un código:

Ahora probemos otro atributo nuevo en HTML5: list. Este atributo enlaza al control con un elemento datalist al referenciar su atributo id. El datalist asociado provee un número de sugerencias que los usuarios pueden elegir para rellenar automáticamente el valor del control.

El soporte provisto por los navegadores para datalist es incompleto. Los autores pueden tener que recurrir a programas para proveer esta funcionalidad consistentemente.

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Busca entre nuestros modelos: <input type="search" name="busquedamodelos" list="listamodelos">
    <input type="submit" value="Buscar">
  </p>
</form>
<datalist id="listamodelos">
  <option value="Camaro">
  <option value="Corvette">
  <option value="Impala">
  <option value="Colorado">
</datalist>

Busca entre nuestros modelos:

Nuestro ejemplo final combina dos atributos, también nuevos en HTML5, que habitualmente trabajan juntos. Estos son pattern y required. Su importancia se vuelve evidente cuando el autor necesita establecer un conjunto de reglas acerca del formato de la información que puede ser ingresada en un control.

El atributo pattern, ayuda estableciendo expresiones regulares que cualquier valor ingresado debe acatar. Cuando está presente, el atributo title toma particular relevancia, ya que es responsable de proveer una explicación acerca de las reglas que aplican en el campo. Los navegadores pueden usar esta información para componer el mensaje de error que se muestra al usuario luego de un intento fallido de envío.

Por otra parte, el atributo required impide a los usuarios dejar el campo vacío. Ambos atributos, juntos, indican que el control debe ser rellenado y especifican cómo debe ser rellenado.

La presencia de estos atributos implica que el envío del formulario será interrumpido hasta que sus requerimientos sean satisfechos. Los navegadores mostrarán mensajes de error cuando el usuario intente enviar campos que no cumplen las premisas.

Una expresión regular es una secuencia de caracteres que forman un patrón de búsqueda, principalmente para su uso en correspondencia de patrones y cadenas u operaciones estilo búsqueda y reemplazo.

El soporte provisto por los navegadores para el atributo required es incompleto. Los autores pueden tener que recurrir a programas para proveer esta funcionalidad consistentemente.

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar por código: <input type="search" name="busquedacodigo" pattern="[A-Za-z0-9]{8,20}" title="Un código válido consiste en una cadena con 8 a 20 caracteres, cada uno de los cuales es una letra o un dígito" required>
    <input type="submit" value="Buscar">
  </p>
</form>

Buscar por código:

Atributos

Atributos específicos

autofocus

Un valor booleano que instruye al navegador a establecer el enfoque sobre este control cuando el documento termina de cargarse o cuando el cuadro de diálogo (dialog) donde el control se encuentra es mostrado. Si el atributo tiene el valor "autofocus" o la cadena vacía (""), o si simplemente está presente, el control debería obtener el enfoque tan pronto como sea posible, luego de que la página o cuadro de diálogo hayan sido cargados.

Ejemplo

<p><input type="search" name="campobusqueda" autofocus></p>

dirname

Un nombre para un nuevo campo especialmente creado con el fin de transmitir la direccionalidad del texto ingresado. Este atributo, nuevo en HTML5, permite a los autores manipular correctamente los valores enviados con cualquier direccionalidad de texto, al agregar un campo que es enviado con el formulario. El nombre de ese campo será el valor de este atributo.

Siendo relativamente nuevo, el soporte provisto por los navegadores para el atributo dirname es incompleto. Los autores deberían revisar el soporte cuando la información es recibida en el servidor.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    <input type="search" name="campobusqueda" dirname="campobusqueda-dir">
    <input type="submit" value="Buscar">
  </p>
</form>

disabled

Un valor booleano que indica si el control se encuentra deshabilitado o no. Si el atributo toma el valor "disabled" o la cadena vacía (""), o si está simplemente presente, el control estará deshabilitado.

Los controles deshabilitados son representados en color gris (si son visibles), son impedidos para interactuar con el usuario y, lo más importante, sus valores (si lo tienen) no son enviados cuando el formulario es despachado.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    <input type="search" name="campobusqueda" disabled>
    <input type="submit" value="Buscar">
  </p>
</form>

form

El valor del atributo id del formulario con el que este control está asociado.

Este atributo es nuevo en HTML5 y ayuda a definir la pertenencia de los controles en formularios anidados o distantes.

Ejemplo

<p><input type="search" name="campobusqueda" form="formulario1"></p>
<form id="formulario1" action="../../form-result.php" method="post" target="_blank">
  <p><input type="submit" value="Buscar"></p>
</form>

list

Un identificador que concuerda con el valor del atributo id del elemento datalist con el que este control está asociado. El datalist referenciado por este atributoproveerá un número de sugerencias que los usuarios pueden escoger para autocompletar el control.

El soporte provisto por los navegadores para datalist es incompleto. Los autores pueden tener que recurrir a programas para proveer esta funcionalidad consistentemente.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar mascotas: <input type="search" name="campobusqueda" list="listamascotas">
    <input type="submit" value="Search"></p>
  </p>
</form>
<datalist id="listamascotas">
  <option value="Perro">
  <option value="Gato">
  <option value="Conejo">
  <option value="Loro">
</datalist>

Buscar mascotas:

maxlength

Un entero que indica el número máximo de caracteres que el valor de este control puede tener.

Los autores no deberían confiar en el atributo maxlength. Los usuarios podrían enviar la información del formulario con navegadores que (algunos intencionalmente) no soportan estas características.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar código: <input type="search" name="buscarcodigo" maxlength="2">
    <input type="submit" value="Buscar">
  </p>
</form>

Buscar código:

minlength

Un entero que indica el número mínimo de caracteres que el valor de este control puede tener.

Los autores no deberían confiar en el atributo minlength. Los usuarios podrían enviar la información del formulario con navegadores que (algunos intencionalmente) no soportan estas características.

El soporte provisto por los navegadores para el atributo minlength es extremadamente bajo (hasta el 18/12/2014). Los autores no deberían confiar en este atributo hasta que el soporte crezca.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar código: <input type="search" name="buscarcodigo" minlength="1">
    <input type="submit" value="Buscar">
  </p>
</form>

Buscar código:

name

Un nombre para el control. Este nombre será enviado por el navegador al agente procesador, emparejado con el contenido del atributo value. Ambos atributos juntos conformarán un par nombre-valor que será utilizado para procesar la información del formulario.

Actualmente, el valor isindex, antiguamente utilizado de manera especial por algunos navegadores e incluido en el estándar HTML, no está permitido en este atributo.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar ciudad: <input type="search" name="buscarciudad">
    <input type="submit" value="Buscar">
  </p>
</form>

Buscar ciudad:

pattern

Una expresión regular para comparar con el valor del control antes de que el formulario sea enviado. Este atributo puede ser usado para especificar un formato que los usuarios tendrán que respetar a la hora de completar el campo. Si este patrón no es respetado, un mensaje de error será mostrado durante el envío y el proceso será cancelado (a menos que el atirbuto formnovalidate esté presente en el formulario o en el botón de envío).

El atributo title toma un significado especial cuando este atributo está presente: se espera que éste provea una explicación acerca de las reglas que aplican en el campo. Los navegadores pueden usar la información de title para componer el mensaje de error que es mostrado al usuario cuando el proceso de envío es cancelado.

Una expresión regular es una secuencia de caracteres que forman un patrón de búsqueda, principalmente para su uso en correspondencia de patrones y cadenas u operaciones estilo búsqueda y reemplazo.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar por código: <input type="search" name="buscarporcodigo" pattern="[A-Z0-9]{4,10}" title="Un código válido debe tener entre 4 y 10 caracteres de logitud, donde cada carácter puede ser una letra mayúscula o un dígito">
    <input type="submit" value="Buscar">
  </p>
</form>

Buscar por código:

placeholder

Una línea de texto que se supone provee una pista acerca de cómo debería ser rellenado el campo, como ejemplos o descripciones cortas. Los navegadores pueden mostrar los contenidos de este atributo en el control mientras este no tiene un valor. Tan pronto como el usuario comience a escribir su propio texto, el texto placeholder debería desaparecer del control.

Los autores no deberían utilizar este atributo para reemplazar a la etiqueta. Las etiquetas están pensdas para proveer un título, mientras que el texto placeholder debería dar una pequeña pista acerca de cómo rellenar el campo. Además, es de esperarse el texto placeholder desaparezca cuando el usuario comience a escribir en el control.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Busca rpor estado: <input type="search" name="buscarporestado" placeholder="Kansas, Arizona, Colorado...">
    <input type="submit" value="Buscar">
  </p>
</form>

Busca rpor estado:

readonly

Un valor booleano que instruye al navegador a impedir que el usuario cambie el valor del control. Si este atributo tiene el valor "readonly" o la cadena vacía (""), o si simplemente está presente, el usuario no tendrá premitido hacer cambios al valor en el control.

Aunque este atributo previene que el valor del control sea editado, no toda interacción es bloqueada: los usuario aún podrán seleccionar y copiar el texto en el control.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Búsqueda de usuarios: <input type="search" name="busquedausuarios" value="samwise4855" readonly>
    <input type="submit" value="Buscar">
  </p>
</form>

Búsqueda de usuarios:

required

Un valor booleano que indica si este control puede ser dejado en blanco o no. Si este atributo tiene el valor "required" o la cadena vacía (""), o si está siplemente presente, el usuario tendrá que rellenar el control a fin de poder enviar el formulario.

Si un control con el atributo required presente es dejado en blanco, los navegadores que soporten este mecanismo arrojarán un error previo al envío y cancelarán el proceso inmediatamente.

El soporte provisto por los navegadores para el atributo required es incompleto. Los autores pueden tener que recurrir a programas para proveer esta funcionalidad consistentemente.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Búsqueda de títulos: <input type="search" name="busquedatitulos" required>
    <input type="submit" value="Buscar">
  </p>
</form>

Búsqueda de títulos:

size

Un entero para ser usado como ancho del elemento, como un número de caracteres que deberian ser visibles en el control simultáneamente.

Como los caracteres normalmente no tienen el mismo ancho, los navegadores pueden definir el ancho de carácter de acuerdo a ciertos criterios (como ancho promedio o máximo).

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>
    Buscar por codigo: <input type="search" name="buscarporcodigo" size="4">
    <input type="submit" value="Buscar">
  </p>
</form>

Buscar por codigo:

type

Un valor que indica el tipo de campo que representa este elemento. Existen veintidós valores posibles (insensibles a mayúsculas/minúsculas):

  • hidden: un control oculto utilizado para enviar información al servidor, típicamente manejado por programas.
  • text: un control usado para la entrada de una sola línea de texto.
  • search: igaul a text pero con fines de búsqueda.
  • tel: un control usado para proveer un número de teléfono.
  • url: una caja de texto usada para el ingreso de un único URL absoluto.
  • email: un control diseñado para editar una o más direcciones de e-mail.
  • password: una caja de texto para la edición de contraseñas, donde los caracteres son representados por puntos.
  • date: un control para ingresar una fecha específica.
  • month: un control para ingresar un mes específico.
  • week: un control para ingresar una semana específica.
  • time: un control para ingresar una hora específica.
  • datetime-local: un control para ingresar una fecha y hora local específica.
  • number: un control para ingresar un número.
  • range: un control para ingresar uno o dos números dentro de un rango.
  • color: un control para ingresar un color.
  • checkbox: un control para ingresar un valor booleano (verdadero/falso).
  • radio: un control para elegir una única opción entre varias.
  • file: un control usado para subir archivos al servidor.
  • submit: un botón usado para enviar el formulario.
  • image: igual a submit pero con la habilidad de verse como una imagen en lugar de usar la apariencia predeterminada de los botones.
  • reset: un botón usado para reiniciar los controles del formulario a sus valores iniciales.
  • button: un botón sin una acción predeterminada asociada.

Cuando este atributo está ausente, el elemento se comporta como si tuviera el valor "text".

Ejemplo

<input type="search" name="searchstring">

value

Un valor inicial para el control, que será establecido cuando la página se cargue y cuando el botón de reinicio sea presionado.

Ejemplo

<form action="../../form-result.php" method="post" target="_blank">
  <p>Búsqueda de títulos: <input type="search" name="busquedatitulos" value="Un hombre sin honor"></p>
  <p>
    <input type="submit" value="Buscar">
    <input type="reset" value="Restaurar formulario">
  <p>
</form>

Búsqueda de títulos:

Atributos globales

Para más información acerca de los atributos globales refiérete a esta lista de atributos gloables en HTML5.

Eventos

Eventos globales

Para más información acerca de los eventos globales refiérete a esta lista de eventos globales en HTML5.