Blazor Grid Toolbar

    The Ignite UI for Blazor Toolbar in is a container for UI operations in the Blazor Grid. The Blazor toolbar is located at the top of the Blazor component, i.e., the Grid and it matches its horizontal size. The toolbar container can host any custom content or set of predefined UI controls. The default set for the Blazor Grid includes:

    • Ocultación de columna
    • Fijación de columnas
    • Exportación de Excel
    • Filtrado avanzado

    La barra de herramientas y los componentes de interfaz de usuario predefinidos admiten eventos Blazor y exponen API para desarrolladores.

    Blazor Toolbar Grid Example

    Los componentes predefinidosIgbGridToolbarActions yIgbGridToolbarTitle de interfaz se añaden dentro de laIgbGridToolbar y todo esto es necesario para tener una barra de herramientas que proporcione interacciones predeterminadas con las características correspondientes de la cuadrícula:

    <IgbGrid>
    <IgbGridToolbar>
        <IgbGridToolbarActions>
            <IgbGridToolbarAdvancedFiltering>
            </IgbGridToolbarAdvancedFiltering>
            <IgbGridToolbarHiding>
            </IgbGridToolbarHiding>
            <IgbGridToolbarPinning>
            </IgbGridToolbarPinning>
            <IgbGridToolbarExporter>
            </IgbGridToolbarExporter>
        </IgbGridToolbarActions>
    </IgbGridToolbar>
</IgbGrid>

    [!Note] As seen in the code snippet above, the predefined Actions UI components are wrapped in the IgbGridToolbarActions container. This way, the toolbar title is aligned to the left of the toolbar and the actions are aligned to the right of the toolbar.

    Por supuesto, cada una de estas UI se puede agregar de forma independiente entre sí o puede que no se agreguen en absoluto. De esta manera, el contenedor de la barra de herramientas quedará vacío:

    <IgbGrid>
    <IgbGridToolbar>
    </IgbGridToolbar>
</IgbGrid>

    Para obtener una visión completa de cada uno de los componentes predeterminados de la interfaz de usuario, continúe leyendo la sección Funciones a continuación.

    Características

    La barra de herramientas es excelente para separar la lógica/interacciones, lo que afecta a la cuadrícula en su conjunto.

    Como se muestra arriba, se puede configurar para proporcionar componentes predeterminados para controlar, ocultar columnas, fijar columnas, filtrar avanzado y exportar datos desde la cuadrícula.

    Estas funciones se pueden habilitar de forma independiente una de otra siguiendo un patrón similar al componente de tarjeta de la Ignite UI for Blazor.

    A continuación se enumeran las características principales de la barra de herramientas con código de ejemplo para cada una de ellas.

    Title

    Establecer un título para la barra de herramientas en tu cuadrícula se consigue usando elIgbGridToolbarTitle.

    Los usuarios pueden proporcionar cualquier cosa, desde texto simple hasta plantillas más complejas.

    <IgbGridToolbar>
    <IgbGridToolbarTitle>Grid toolbar title</IgbGridToolbarTitle>
</IgbGridToolbar>

    Actions

    AhíIgbGridToolbarActions es donde los usuarios pueden colocar acciones/interacciones en relación con la cuadrícula principal. Al igual que en la parte de título de la barra de herramientas, los usuarios pueden proporcionar cualquier cosa dentro de esa parte de plantilla, incluidos los componentes de interacción predeterminados de la barra de herramientas.

    <IgbGridToolbar>
    <IgbGridToolbarActions>
        <!--...-->
    </IgbGridToolbarActions>
</IgbGridToolbar>

    Fijación de columnas

    ElIgbGridToolbarPinning componente proporciona la interfaz predeterminada para interactuar con el fijamiento de columnas en la cuadrícula.

    El componente está configurado para funcionar desde el primer momento con la cuadrícula principal que contiene la barra de herramientas, así como varias propiedades de entrada para personalizar la interfaz de usuario, como el título del componente, el marcador de posición para la entrada del componente y la altura del menú desplegable.

    <IgbGridToolbar>
    <IgbGridToolbarActions>
        <IgbGridToolbarPinning Title="Grid pinned columns" Prompt="Filter column collection" ColumnListHeight="400px"></IgbGridToolbarPinning>
    </IgbGridToolbarActions>
</IgbGridToolbar>

    Ocultación de columna

    ProporcionaIgbGridToolbarHiding la interfaz predeterminada para interactuar con el ocultamiento de columnas. Expone las mismas propiedades de entrada para personalizar la interfaz, como el título del componente, el marcador de posición para la entrada del componente y la altura del propio desplegable.

    <IgbGridToolbar>
    <IgbGridToolbarActions>
        <IgbGridToolbarHiding Title="Grid column hiding" Prompt="Filter column collection" ColumnListHeight="400px"></IgbGridToolbarHiding>
    </IgbGridToolbarActions>
</IgbGridToolbar>

    Filtrado avanzado

    El componente Filtrado avanzado de la barra de herramientas proporciona la interfaz de usuario predeterminada para la función Filtrado avanzado. El componente expone una forma de cambiar el texto predeterminado del botón.

    <IgbGridToolbar>
    <IgbGridToolbarActions>
        <IgbGridToolbarAdvancedFiltering></IgbGridToolbarAdvancedFiltering>
    </IgbGridToolbarActions>
</IgbGridToolbar>

    Data Exporting

    Como en el resto de las acciones de la barra de herramientas, la exportación se realiza desde elIgbGridToolbarExporter punto de vista inicial.

    El componente exportador de la barra de herramientas expone varias propiedades de entrada para personalizar tanto la interfaz de usuario como la experiencia de exportación.

    Estas van desde cambiar el texto de la pantalla, activar/desactivar opciones en el desplegable o personalizar el nombre del archivo generado. Para referencia completa, consulta la documentaciónToolbarExporter de la API.

    A continuación se muestra un fragmento que muestra algunas de las opciones que se pueden personalizar a través de la plantilla Blazor:

    <IgbGridToolbar>
    <IgbGridToolbarActions>
        <IgbGridToolbarExporter ExportCSV="true" ExportExcel="true" Filename="exported_data"></IgbGridToolbarExporter>
    </IgbGridToolbarActions>
</IgbGridToolbar>

    Además de cambiar el nombre del archivo exportado, el usuario puede configurar aún más las opciones del exportador esperando elToolbarExporting evento y personalizando la entrada de opciones en las propiedades del evento.

    [!Note] By default when exporting to CSV the exporter exports using a comma separator and uses a '.csv' extension for the output file. You can customize these exporting parameters by subscribing to events of the exporter or changing the values of the exporter options fields. You can also cancel the export process by setting the cancel field of the event args to true.

    El siguiente fragmento de código demuestra la suscripción al evento de exportación de la barra de herramientas y la configuración de las opciones del exportador:

    <IgbGridToolbarExporter ExportStartedScript="WebGridToolbarExporting"></IgbGridToolbarExporter>

    // In Javascript
igRegisterScript("WebGridToolbarExporting", (evt) => {
        const args = evt.detail;
        const options = args.options;
        options.fileName = `Report_${new Date().toDateString()}`;
        args.exporter.columnExporting.subscribe((columnArgs) => {
                columnArgs.cancel = columnArgs.header === 'Athlete' || columnArgs.header === 'Country';
        });
}, false);

    El siguiente ejemplo demuestra cómo personalizar los archivos exportados:

    Exporting Indicator

    Cuando se utiliza el componente exportador de la barra de herramientas predeterminado, cada vez que se realiza una operación de exportación, la barra de herramientas mostrará un indicador de progreso mientras la operación está en curso.

    Además, los usuarios pueden establecer la propiedad de barra de herramientasShowProgress y usarla para sus propias operaciones de larga duración o simplemente como otra forma de señalar una acción que está ocurriendo en la cuadrícula.

    El ejemplo que se utiliza a continuación tiene una cantidad significativa de datos, a fin de aumentar el tiempo necesario para exportar los datos para que se pueda ver la barra de progreso. Además cuenta con otro botón que simula una operación de larga duración en la red:

    Custom Content

    Si la parte de acciones del componente de la barra de herramientas no es suficiente para un caso de uso particular, la barra de herramientas en sí tiene una proyección de contenido general donde los usuarios pueden proporcionar una interfaz de usuario adicional. Si el usuario necesita la instancia de grid respectiva para llamadas o enlaces de API, puede crear una variable de referencia de plantilla.

    Aquí hay un fragmento de muestra:

    <IgbGrid>
    <IgbGridToolbar>
        <IgbGridToolbarTitle>title</IgbGridToolbarTitle>
        @*
            Everything between the toolbar tags except the default toolbar components
            will be projected as custom content.
        *@
        <IgbGridToolbarActions>
        </IgbGridToolbarActions>
    </IgbGridToolbar>
</IgbGrid>

    El siguiente ejemplo demuestra cómo agregar un botón adicional a la barra de herramientas para borrar el conjunto de clasificación haciendo clic en los encabezados de las columnas:

    Styling

    Además de los temas predefinidos, la cuadrícula se puede personalizar aún más configurando algunas de las propiedades CSS disponibles. En caso de que desee cambiar algunos de los colores, primero debe establecer una clase para la cuadrícula:

    <IgbGrid class="grid"></IgbGrid>

    Luego configure las propiedades CSS relacionadas para esa clase:

    .grid {
    --ig-grid-toolbar-background-color: #2a2b2f;
    --ig-grid-toolbar-title-text-color: #ffcd0f;
    --ig-grid-toolbar-dropdown-background: #2a2b2f;
}

    Demo

    API References

    El servicio Grid Toolbar tiene algunas API más para explorar, que se enumeran a continuación.

    Grid Events:

    • ToolbarExporting

    Additional Resources

    Nuestra comunidad es activa y siempre da la bienvenida a nuevas ideas.