Descripción general de Web Components ComboBox

    Web Components ComboBox es un editor ligero que permite a los usuarios seleccionar, filtrar y agrupar fácilmente diferentes opciones predefinidas en una lista proporcionada. El componente también admite opciones para Web Components navegación con teclado ComboBox, plantillas para personalizar cómo se muestran los elementos, el encabezado y el pie de página.

    El componente ComboBox Ignite UI for Web Components proporciona una lista de opciones entre las que los usuarios pueden realizar una selección. Muestra todas las opciones en una lista virtualizada de elementos, lo que significa que el ComboBox puede mostrar simultáneamente miles de registros, donde se pueden seleccionar una o más opciones. Además, el componente cuenta con filtrado sensible a mayúsculas y minúsculas, agrupación, enlace de datos complejos y más.

    Web Components ComboBox Example

    Getting Started with Web Components ComboBox

    En primer lugar, debe instalar el Ignite UI for Web Components ejecutando el siguiente comando:

    npm install igniteui-webcomponents

    Antes de usar elIgcComboComponent componente, necesitas registrarlo junto con sus componentes adicionales y el CSS necesario:

    import { defineComponents, IgcComboComponent }
from 'igniteui-webcomponents';
import 'igniteui-webcomponents/themes/light/bootstrap.css';

defineComponents(IgcComboComponent);

    Para una introducción completa al Ignite UI for Web Components, lee el tema Empezar.

    [!WARNING] The IgcComboComponent component doesn't work with the standard <form> element. Use Form instead.

    Luego, vincularemos una serie de objetos a la fuente de datos combinada utilizada para crear la lista de opciones.

    interface City {
    id: string;
    name: string;
}

const cities: City[] = [
    { name: 'London', id: 'UK01' },
    { name: 'Sofia', id: 'BG01'},
    { name: 'New York', id: 'NY01'}
];

export class Sample {
    private combo: IgcComboComponent<City>;

    constructor() {
        this.combo = document.getElementById('basic-combo') as IgcComboComponent<City>;
        this.combo.data = cities;
    }
}

    <igc-combo id='basic-combo' display-key='name' value-key='id' value='["BG01"]'></igc-combo>

    Data value and display properties

    Cuando el combo está vinculado a una lista de datos complejos (es decir, objetos), necesitamos especificar una propiedad que el control utilizará para manejar la selección de elementos. El componente expone las siguientes propiedades:

    • T-requerió, sivalueKey se omite, esto debe establecerse como "objeto", de lo contrario debe coincidir con el tipo de propiedad devalueKey.
    • valueKey-Opcional, requerido para objeto de datos complejo - Determina qué campo de la fuente de datos se usará para hacer selecciones. SivalueKey se omite, la API de selección usará referencias a objetos para seleccionar elementos.
    • displayKey-Opcional, recomendado para objetos de datos complejos - Determina qué campo en la fuente de datos se usa como valor de visualización. Si no se especifica ningún valordisplayKey, la combinación usará el especificadovalueKey (si es que lo hay). En nuestro caso, queremos que la combinación muestre elname de cada ciudad y use elid campo para la selección de objetos y como el valor subyacente de cada uno. Por lo tanto, proporcionamos estas propiedades a las combinacionesvalueKey ydisplayKey respectivamente.

    [!Note] When the data source consists of primitive types (e.g. strings, numbers, etc.), do not specify a valueKey and/or displayKey.

    Setting Value

    El componente ComboBox expone unvalue getter y un setter además de un atributo, que también se llama valor. Puedes usar el atributo valor para establecer los elementos seleccionados en la inicialización de componentes.

    Si quieres leer el valor, es decir, la lista de elementos seleccionados actualmente, o actualizar el valor, usa el receptor y el colocador respectivamente. El que obtiene el valor devolverá una lista de todos los elementos seleccionados tal y como los representavalueKey. Del mismo modo, si quieres actualizar la lista de elementos seleccionados usando el valorador, deberías proporcionar una lista de elementos según élvalueKey.

    Ejemplo:

    const combo = document.getElementById('basic-combo') as IgcComboComponent<City>;

// Given the overview example from above this will return ['BG01']
console.log(combo.value);

// Change the selected items to New York and London
combo.value = ['NY01', 'UK01'];

    Selection API

    El componente combinado expone API que le permiten cambiar los elementos seleccionados actualmente.

    Además de seleccionar elementos de la lista de opciones por interacción del usuario, puedes seleccionar elementos de forma programática. Esto se hace mediante losselect métodos y (ydeselect métodos). Puedes pasar una variedad de elementos a ambos métodos. Si los métodos se llaman sin argumentos, todos los elementos serán seleccionados o deseleccionados dependiendo de qué método se llame. Si has especificado avalueKey para tu componente de combo, entonces deberías pasar las teclas de valor de los objetos que quieres seleccionar/deseleccionar:

    Seleccionar/deseleccionar algunos elementos

    // Select/deselect items by their IDs as valueKey is set to 'id'
combo.select(['BG01', 'BG02', 'BG03', 'BG04']);
combo.deselect(['BG01', 'BG02', 'BG03', 'BG04']);

    Seleccionar/deseleccionar todos los elementos

    // Select/deselect all items
combo.select();
combo.deselect();

    Si se omite lavalueKey propiedad, tendrás que listar los elementos que deseas seleccionar/deseleccionar como referencias a objetos:

    // Select/deselect values by object references when no valueKey is provided
combo.select([cities[1], cities[5]]);
combo.deselect([cities[1], cities[5]]);

    Validation

    El componente Ignite UI for Web Components Combo soporta la mayoría de lasIgcInputComponent propiedades, comorequired,disabled,autofocus,invalid, etc. El componente también expone dos métodos vinculados a su validación:

    • reportValidity- comprueba la validez y devuelve true si el componente cumple con las restricciones de validación.
    • checkValidity- un envoltorio alrededor de reportValidity para cumplir con la API de entrada nativa.

    Keyboard Navigation

    Cuando el componente combinado está enfocado y la lista de opciones no está visible:

    • Abra la lista de opciones usando las teclas Abajo/Alt + Abajo.

    Cuando el componente combinado está enfocado y la lista de opciones está visible:

    • Usar la tecla Abajo activará el siguiente elemento de la lista.
    • Usar la tecla Arriba activará el elemento anterior de la lista. Si el primer elemento ya está activo, centrará la entrada.
    • El uso de las HOME teclas o END activará el primer o el último elemento de la lista.
    • Usando la SPACE clave se seleccionará el elemento activo.
    • Al usar la ENTER clave, se seleccionará el elemento activo y se cerrará la lista de opciones.
    • El uso de las ESC teclas o TAB/SHIFT + TAB, se cerrará la lista de opciones.

    Styling

    Puedes cambiar la apariencia delIgcComboComponent componente y sus elementos utilizando las partes CSS expuestas que se enumeran a continuación:

    Nombre de la pieza Descripción
    label La etiqueta de texto encapsulado.
    input El campo de entrada principal.
    native-input La entrada nativa del campo de entrada principal.
    prefix El contenedor de prefijo.
    suffix El contenedor del sufijo.
    toggle-icon El contenedor del icono de alternancia.
    clear-icon El contenedor de iconos claros.
    case-icon Un contenedor de ícono de caso que presenta contenido dentro del sufijo de la entrada del filtro.
    helper-text El contenedor de texto auxiliar.
    search-input El campo de entrada de búsqueda.
    list-wrapper La lista de opciones de contenedor.
    list El cuadro de lista de opciones.
    item Representa cada elemento de la lista de opciones.
    group-header Representa cada encabezado en la lista de opciones.
    active Se agrega a la lista de piezas del artículo cuando el artículo está activo.
    selected Se adjunta a la lista de piezas del artículo cuando se selecciona el artículo.
    checkbox Representa cada casilla de verificación de cada elemento de la lista.
    checkbox-indicator Representa el indicador de casilla de verificación de cada elemento de la lista.
    checked Se adjunta a la lista de piezas de la casilla de verificación cuando la casilla de verificación está marcada.
    header El contenedor que contiene el contenido del encabezado.
    footer El contenedor que contiene el contenido del pie de página.
    empty El contenedor que contiene el contenido vacío.

    Usando las partes CSS, tenemos control total sobre el estilo Combo.

    igc-combo::part(search-input) {
  background-color: var(--ig-gray-100);
  border-radius: 2px;
}

igc-combo::part(input) {
  background-color: var(--ig-gray-100);
}

igc-combo::part(prefix) {
  background-color: var(--ig-secondary-50);
  color: var(--ig-primary-500);
}

igc-combo::part(toggle-icon) {
  color: var(--ig-primary-500);
}

    API Reference

    Additional Resources