React Edición de celdas de cuadrícula

La edición de celdas Ignite UI for React en React Grid proporciona una gran capacidad de manipulación de datos del contenido de celdas individuales dentro del componente React Grid y viene con una potente API para operaciones CRUD React. Es una característica fundamental en aplicaciones como hojas de cálculo, tablas de datos y cuadrículas de datos, lo que permite a los usuarios agregar, editar o actualizar datos dentro de celdas específicas. De forma predeterminada, la cuadrícula de Ignite UI for React se utiliza en la edición de celdas. Y debido a la plantilla de edición de celdas predeterminada, habrá diferentes editores basados en el tipo de datos de columna Top of Form.

Además, puede definir sus propias plantillas personalizadas para acciones de actualización de datos y anular el comportamiento predeterminado para confirmar y descartar cualquier cambio.

React Grid Cell Editing and Edit Templates Example

Edición de celdas

Editing through UI

Puede ingresar al modo de edición para una celda específica, cuando una celda editable está enfocada de una de las siguientes maneras:

al hacer doble clic;
con un solo clic: un solo clic ingresará al modo de edición solo si la celda seleccionada previamente estaba en modo de edición y la celda actualmente seleccionada es editable. Si la celda previamente seleccionada no estaba en modo de edición, un solo clic seleccionará la celda sin ingresar al modo de edición;
al presionar una ENTER tecla;
en la tecla presione F2;

Puede salir del modo de edición sin realizar los cambios de una de las siguientes maneras:

en la tecla presione Escape;
cuando realizas operaciones de ordenación, filtrado, búsqueda y ocultación;

Puede salir del modo de edición y confirmar los cambios de una de las siguientes maneras:

al presionar una ENTER tecla;
en la tecla presione F2;
al presionar una TAB tecla;
Con un solo clic a otra celda: al hacer clic en otra celda de laIgrGrid, tus cambios se enviarán.
operaciones como paginación, cambio de tamaño, anclar o mover saldrán del modo de edición y se enviarán los cambios.

[!Note] The cell remains in edit mode when you scroll vertically or horizontally or click outside the IgrGrid. This is valid for both cell editing and row editing.

Editing through API

También puedes modificar el valor de la celda a través de laIgrGrid API, pero solo si la clave primaria está definida:

function updateCell() {
    grid1Ref.current.updateCell(newValue, rowID, 'ReorderLevel');
}

Otra forma de actualizar celdas es directamente medianteUpdate el método de:Cell

function updateCell() {
    const cell = grid1Ref.current.getCellByColumn(rowIndex, 'ReorderLevel');
    // You can also get cell by rowID if primary key is defined
    // cell = grid1Ref.current.getCellByKey(rowID, 'ReorderLevel');
    cell.update(70);
}

Cell Editing Templates

Puede ver y obtener más información sobre las plantillas de edición de celdas predeterminadas en el tema de edición general.

Si desea proporcionar una plantilla personalizada que se aplicará a una celda, puede pasar dicha plantilla a la celda misma o a su encabezado. Primero cree la columna como lo haría normalmente:

<IgrColumn
    field="race"
    header="Race"
    dataType="string"
    editable={true}
    inlineEditorTemplate={this.webGridCellEditCellTemplate}>
</IgrColumn>

y pase las plantillas a esta columna en el archivo index.ts:

public webGridCellEditCellTemplate = (e: IgrCellTemplateContext) => {
    let cellValues: any = [];
    let uniqueValues: any = [];
    const cell = e.cell;
    const colIndex = cell.id.columnID;
    const field: string = this.grid1.getColumnByVisibleIndex(colIndex).field;
    let index = 0;
    for (const i of this.roleplayDataStats as any) {
      if (uniqueValues.indexOf(i[field]) === -1) {
        cellValues.push(
          <>
            <IgrSelectItem
              selected={e.cell.value == i[field]}
              value={i[field]}
            >
              <div>{i[field]}</div>
            </IgrSelectItem>
          </>
        );
        uniqueValues.push(i[field]);
      }
      index++;
    }
    return (
      <>
        <IgrSelect
          onChange={(x: any) => {
            setTimeout(() => {
              cell.editValue = x.target.value;
            });
          }}
        >
          {cellValues}
        </IgrSelect>
      </>
    );
  };

Puede encontrar una muestra funcional de lo anterior aquí para mayor referencia:

Grid Excel Style Editing

El uso de la edición de estilo de Excel permite al usuario navegar a través de las celdas tal como lo haría con Excel y editarlas muy rápidamente.

La implementación de esta funcionalidad personalizada puede hacerse utilizando los eventos de laIgrGrid. Primero nos conectamos a los eventos keydown de la cuadrícula, y a partir de ahí podemos implementar dos funcionalidades:

const gridRef = useRef<IgrGrid>();
useEffect(() => {
    gridRef.current.addEventListener("keydown", handleKeyDown);
    return () => {
        gridRef.current.removeEventListener("keydown", handleKeyDown);
    };
}, []);
<IgrGrid ref={gridRef} autoGenerate={false} data={NwindData} primaryKey="ProductID">
</IgrGrid>

[!Note] We are using the native browser keydown event instead of React’s synthetic onKeyDown event. When a cell enters edit mode and the ENTER key is pressed to move to the next row, the grid’s editing feature updates the cell value and closes the edit mode. As a result, the input element used for editing is removed from the DOM. Due to React’s event system optimizations, the onKeyDown synthetic event does not bubble up to the grid because the element no longer exists in the React tree at that moment. Therefore, using the native event listener is necessary to ensure the expected behavior.

Modo de edición constante

function handleKeyDown(event: KeyBoardEvent) {
    const code = event.code;
    const grid = event.currentTarget as IgrGrid;
    const activeElem = grid.selectedCells[0];

    if ((event.code >= "Digit0" && event.code <= "Digit9") || (event.code >= "KeyA" && event.code <= "KeyZ")
        || (event.code >= "Numpad0" && event.code <= "Numpad9" && event.code !== "Enter" && event.code !== "NumpadEnter")) {
        if (activeElem && !activeElem.editMode) {
            activeElem.editMode = true;
            activeElem.editValue = event.key;
        } else if (activeElem && activeElem.editMode) {
            event.preventDefault();
            activeElem.editValue = activeElem.editValue + event.key;
        }
    }
}

ENTER / SHIFT + ENTER navegación

if (code === "Enter" || code === "NumpadEnter") {
    const thisRow = activeElem.row.index;
    const dataView = grid.dataView;
    const nextRowIndex = getNextEditableRowIndex(thisRow, dataView, event.shiftKey);

    grid.navigateTo(nextRowIndex, activeElem.column.visibleIndex, (obj: any) => {
        obj.target.activate();
        grid.endEdit(true);
        grid.markForCheck();
    });
}

Las partes clave para encontrar el próximo índice elegible serían:

//first we check if the currently selected cell is the first or the last
if (currentRowIndex < 0 || (currentRowIndex === 0 && previous) || (currentRowIndex >= dataView.length - 1 && !previous)) {
    return currentRowIndex;
}
// in case using shift + enter combination, we look for the first suitable cell going up the field
if (previous) {
    return  dataView.findLastIndex((rec, index) => index < currentRowIndex && this.isEditableDataRecordAtIndex(index, dataView));
}
// or for the next one down the field
return dataView.findIndex((rec, index) => index > currentRowIndex && this.isEditableDataRecordAtIndex(index, dataView));

Consulte la muestra completa para obtener más referencias:

Ejemplo de edición de estilo de Excel de cuadrícula de React

Los principales beneficios del enfoque anterior incluyen:

Modo de edición constante: al escribir mientras se selecciona una celda, se ingresará inmediatamente al modo de edición con el valor ingresado, reemplazando el existente
Las filas que no son de datos se omiten al navegar con ENTER / SHIFT + ENTER. Esto permite a los usuarios recorrer rápidamente sus valores.

CRUD operations

[!Note] Please keep in mind that when you perform some CRUD operation all of the applied pipes like filtering, sorting and grouping will be re-applied and your view will be automatically updated.

ProporcionaIgrGrid una API sencilla para operaciones básicas de CRUD.

Adding a new record

ElIgrGrid componente expone eladdRow método que añadirá los datos proporcionados a la propia fuente de datos.

// Adding a new record
// Assuming we have a `getNewRecord` method returning the new row data.
const record = getNewRecord();
grid1Ref.current.addRow(record);

Updating data in the Grid

La actualización de datos en la cuadrícula se logra medianteupdateRow métodos yupdateCell pero solo si se define la clave primaria para la cuadrícula. También puedes actualizar directamente una celda y/o un valor de fila a través de sus respectivos métodos de actualización.

// Updating the whole row
grid1Ref.current.updateRow(newData, this.selectedCell.cellID.rowID);

// Just a particular cell through the Grid API
grid1Ref.current.updateCell(newData, this.selectedCell.cellID.rowID, this.selectedCell.column.field);

// Directly using the cell `update` method
selectedCell.update(newData);

// Directly using the row `update` method
const row = grid1Ref.current.getRowByKey(rowID);
row.update(newData);

Deleting data from the Grid

Por favor, ten en cuenta que esedeleteRow método eliminará la fila especificada solo si se define aprimaryKey.

// Delete row through Grid API
grid1Ref.current.deleteRow(selectedCell.cellID.rowID);
// Delete row through row object
const row = grid1Ref.current.getRowByIndex(rowIndex);
row.delete();

Cell Validation on Edit Event

Usando losIgrGrid eventos de edición, podemos modificar cómo el usuario interactúa con elIgrGrid.

En este ejemplo, validaremos una celda basándonos en los datos introducidos en ella al vincularse alCellEdit evento. Si el nuevo valor de la celda no cumple nuestros criterios predefinidos, impediremos que llegue a la fuente de datos cancelando el evento.

Lo primero que tenemos que hacer es enlazar al evento de la cuadrícula:

<IgrGrid onCellEdit={handleCellEdit}>
</IgrGrid>

SeCellEdit emite cuando el valor de cualquier célula está a punto de comprometerse. En nuestra definición de CellEdit, debemos asegurarnos de comprobar nuestra columna específica antes de tomar cualquier acción:

function handleCellEdit(args: IgrGridEditEventArgs): void {
    const column = args.detail.column;

    if (column.field === 'UnitsOnOrder') {
        const rowData = args.detail.rowData;
        if (!rowData) {
            return;
        }
        if (args.detail.newValue > rowData.UnitsInStock) {
            args.detail.cancel = true;
            alert("You cannot order more than the units in stock!");
        }
    }
}

Si el valor ingresado en una celda debajo de la columna Unidades en pedido es mayor que la cantidad disponible (el valor en Unidades en stock), la edición se cancelará y se alertará al usuario sobre la cancelación.

El resultado de la validación anterior aplicada a nuestroIgrGrid puede verse en la siguiente demostración:

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-edit-mode-color: orange;
    --ig-grid-cell-editing-background: lightblue;
}