Descripción general Blazor ComboBox

Blazor ComboBox es un editor liviano 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 la navegación con el teclado Blazor ComboBox y plantillas para personalizar cómo se muestran los elementos, el encabezado y el pie de página.

El componente Ignite UI for Blazor ComboBox 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 ComboBox puede mostrar simultáneamente miles de registros, donde se pueden seleccionar una o más opciones. Además, el componente presenta filtrado, agrupación, enlace de datos complejos que distingue entre mayúsculas y minúsculas y más.

Blazor ComboBox Example

Getting Started with Blazor ComboBox

Para comenzar con el componente IgbCombo, primero debemos registrar su módulo de la siguiente manera:

// in Program.cs file

builder.Services.AddIgniteUIBlazor(typeof(IgbComboModule));

También deberá vincular un archivo CSS adicional para aplicar el estilo al componente IgbCombo. Es necesario colocar lo siguiente en el archivo wwwroot/index.html de un proyecto Blazor Web Assembly o en el archivo Pages/_Host.cshtml de un proyecto Blazor Server:

<link href="_content/IgniteUI.Blazor/themes/light/bootstrap.css" rel="stylesheet" />

[!WARNING] The IgbCombo 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.

<IgbCombo Id="basic-combo" DisplayKey="name" ValueKey="id" Data="Data" />

@code {
    private class City {
        public string Id { get; set; }
        public string Name { get; set; }
        public string Country { get; set; }
    }

    private List<City> Data = new List<City> {
        new City {
            Id = "UK01",
            Name = "London",
            Country = "United Kingdom",
        },
        new City {
            Id = "BG01",
            Name = "Sofia",
            Country = "Bulgaria",
        },
        new City {
            Id = "US01",
            Name = "New York",
            Country = "United States",
        },
    };
}

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:

ValueKey: opcional, obligatorio para objetos de datos complejos: determina qué campo de la fuente de datos se utilizará para realizar selecciones. Si se omite ValueKey, la API de selección utilizará referencias de objetos para seleccionar elementos.
DisplayKey: opcional, recomendado para objetos de datos complejos: determina qué campo de la fuente de datos se utiliza como valor de visualización. Si no se especifica ningún valor para DisplayKey, el combo utilizará la ValueKey especificada (si corresponde). En nuestro caso, queremos que el combo muestre el name de cada ciudad y use el campo id para la selección de elementos y como valor subyacente para cada elemento. Por lo tanto, proporcionamos estas propiedades a ValueKey y DisplayKey del combo 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 un captador y definidor Value además de un atributo, que también se denomina valor. Puede utilizar el atributo de valor para configurar los elementos seleccionados en la inicialización del componente.

Si desea leer el valor, es decir, la lista de elementos seleccionados actualmente, o actualizar el valor, utilice el captador y definidor de valores respectivamente. El captador de valores devolverá una lista de todos los elementos seleccionados representados por ValueKey. Del mismo modo, si desea actualizar la lista de elementos seleccionados utilizando el definidor de valores, debe proporcionar una lista de elementos por su ValueKey.

Example:

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 mediante la interacción del usuario, puede seleccionar elementos mediante programación. Esto se hace mediante los métodos select y deselect. Puede pasar una variedad de elementos a ambos métodos. Si los métodos se llaman sin argumentos, todos los elementos se seleccionarán/deseleccionarán dependiendo del método que se llame. Si ha especificado una ValueKey para su componente combinado, entonces debe pasar las claves de valor de los elementos que desea seleccionar/deseleccionar:

Seleccionar/deseleccionar algunos elementos:

<IgbCombo
    @ref="Combo"
    Label="Cities"
    Placeholder="Pick a city"
    Data="Data"
    ValueKey="Id"
    DisplayKey="Name">
</IgbCombo>

@code {
    private List<City> Data;
    private IgbCombo Combo;
    private object[] Cities;

    protected override void OnInitialized() {
        this.Data = SampleData.Cities;
        this.Cities = new object[] { "UK01", "UK02", "UK03", "UK04", "UK05" };
    }

    public void SelectCities() {
        this.Combo.Select(Cities);
    }

    public void DeselectCities() {
        this.Combo.Deselect(Cities);
    }
}

Seleccionar/deseleccionar todos los elementos:

@code {
    public void SelectAll() {
        this.Combo.Select(new object[] {});
    }

    public void DeselectAll() {
        this.Combo.Deselect(new object[] {});
    }
}

Si se omite la propiedad ValueKey, deberá enumerar los elementos que desea seleccionar/deseleccionar como referencias de objetos:

Validation

El componente Ignite UI for Blazor Combo admite la mayoría de las propiedades IgbInput, como Required, Disabled, Autofocus, Invalid, etc. El componente también expone dos métodos vinculados a su validación:

reportValidity: comprueba la validez y devuelve verdadero si el componente satisface las restricciones de validación.
checkValidity: un contenedor alrededor de reportValidity para cumplir con la API de entrada nativa.

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 teclas Inicio o Fin activará el primero o el último elemento de la lista.
Usando la tecla Espacio se seleccionará el elemento activo.
Usar la tecla Enter seleccionará el elemento activo y cerrará la lista de opciones.
Usar las teclas Esc o Tab/Shift + Tab cerrará la lista de opciones.

Styling Blazor ComboBox

Puede cambiar la apariencia de la Ignite UI for Blazor IgbCombo y sus elementos utilizando las partes CSS expuestas que se enumeran a continuación:

CSS Parts

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.

API Reference

IgbCombo