React Grid para Ignite UI for React para

La Ignite UI for React es un contenedor para las operaciones de la interfaz de usuario en React Grid. La barra de herramientas React está ubicada en la parte superior del componente React, es decir, IgrGrid y coincide con su tamaño horizontal. El contenedor de la barra de herramientas puede alojar cualquier contenido personalizado o un conjunto de controles de interfaz de usuario predefinidos. El conjunto predeterminado para React Grid incluye:

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

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

Las Actions predefinidas y los componentes de la interfaz de usuario title se agregan dentro de IgrGridToolbar y todo esto es necesario para tener una barra de herramientas que proporcione interacciones predeterminadas con las funciones de cuadrícula correspondientes:

<IgrGrid>
    <IgrGridToolbar key="toolbar">
        <IgrGridToolbarTitle key="toolbarTitle">
            <span key="toolbarTitleText">Grid Toolbar<span>
        </IgrGridToolbarTitle>
        <IgrGridToolbarActions key="toolbarActions">
            <IgrGridToolbarAdvancedFiltering key="advancedFiltering"></IgrGridToolbarAdvancedFiltering>
            <IgrGridToolbarPinning key="pinning"></IgrGridToolbarPinning>
            <IgrGridToolbarHiding key="hiding"></IgrGridToolbarHiding>
            <IgrGridToolbarExporter key="export"></IgrGridToolbarExporter>
        </IgrGridToolbarActions>
    </IgrGridToolbar>
</IgrGrid>

[!Note] As seen in the code snippet above, the predefined Actions UI components are wrapped in the IgrGridToolbarActions 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:

<IgrGrid>
    <IgrGridToolbar key="toolbar">
    </IgrGridToolbar>
</IgrGrid>

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 entre sí siguiendo un patrón similar al componente de tarjeta de la suite Ignite UI for React.

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 su cuadrícula se logra utilizando IgrGridToolbarTitle.

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

<IgrGridToolbar key="toolbar">
    <IgrGridToolbarTitle key="toolbarTitle">
        <span key="toolbarTitleText">Grid toolbar title<span>
    </IgrGridToolbarTitle>
</IgrGridToolbar>

Actions

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

<IgrGridToolbar key="toolbar">
    <IgrGridToolbarActions key="toolbarActions">

    </IgrGridToolbarActions>
</IgrGridToolbar>

Fijación de columnas

El componente IgrGridToolbarPinning proporciona la interfaz de usuario predeterminada para interactuar con la fijación 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.

<IgrGridToolbar key="toolbar">
    <IgrGridToolbarActions key="toolbarActions">
        <IgrGridToolbarPinning key="pinning" title="Grid pinned columns" prompt="Filter column collection" columnListHeight="400px"></IgrGridToolbarPinning>
    </IgrGridToolbarActions>
</IgrGridToolbar>

Ocultación de columna

IgrGridToolbarHiding proporciona la interfaz de usuario predeterminada para interactuar con la ocultación de columnas. Expone las mismas 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.

<IgrGridToolbar key="toolbar">
    <IgrGridToolbarActions key="toolbarActions">
        <IgrGridToolbarHiding key="hiding" title="Grid column hiding" prompt="Filter column collection" columnListHeight="400px"></IgrGridToolbarHiding>
    </IgrGridToolbarActions>
</IgrGridToolbar>

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.

<IgrGridToolbar key="toolbar">
    <IgrGridToolbarActions key="toolbarActions">
        <IgrGridToolbarAdvancedFiltering key="advancedFiltering"></IgrGridToolbarAdvancedFiltering>
    </IgrGridToolbarActions>
</IgrGridToolbar>

Data Exporting

Al igual que con el resto de las acciones de la barra de herramientas, la exportación se realiza a través de IgrGridToolbarExporter listo para usar.

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.

Estos van desde cambiar el texto que se muestra hasta habilitar/deshabilitar opciones en el menú desplegable y personalizar el nombre del archivo generado. Para obtener una referencia completa, consulte la documentación de la API de ToolbarExporter.

Aquí hay un fragmento que muestra algunas de las opciones que se pueden personalizar a través de la plantilla React:

<IgrGridToolbar key="toolbar">
    <IgrGridToolbarActions key="toolbarActions">
        <IgrGridToolbarExporter key="export" exportCSV="true" exportExcel="true" filename="exported_data"></IgrGridToolbarExporter>
    </IgrGridToolbarActions>
</IgrGridToolbar>

Además de cambiar el nombre del archivo exportado, el usuario puede configurar aún más las opciones del exportador esperando el evento ToolbarExporting 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:

function configureExport(evt: IgrGridToolbarExportEventArgs) {
    const args = evt.detail;
    const options: IgrExporterOptionsBase = args.options;

    options.fileName = `Report_${new Date().toDateString()}`;
    (args.exporter as any).columnExporting.subscribe((columnArgs: any) => {
            columnArgs.cancel = columnArgs.header === 'Athlete' || columnArgs.header === 'Country';
    });
}

<IgrGrid toolbarExporting={configureExport}>
</IgrGrid>

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 configurar la propiedad ShowProgress la barra de herramientas y utilizarla para sus propias operaciones de larga duración o simplemente como otra forma de indicar una acción que tiene lugar 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:

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:

<IgrGrid className="grid"></IgrGrid>

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.

Additional Resources

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

React Grid Toolbar

React Toolbar Grid Example