Edição de células de grade de Web Components

A Ignite UI for Web Components Cell Editing no Web Components Grid fornece uma ótima capacidade de manipulação de dados do conteúdo de células individuais dentro do componente Web Components Grid e vem com uma API poderosa para operações React CRUD. É um recurso fundamental em aplicativos como planilhas, tabelas de dados e grades de dados, permitindo que os usuários adicionem, editem ou atualizem dados dentro de células específicas. Por padrão, a Grid no Ignite UI for Web Components é usada na edição de células. E devido ao modelo de edição de células padrão, haverá diferentes editores com base no tipo de dados da coluna Top of Form.

Além disso, você pode definir seus próprios modelos personalizados para ações de atualização de dados e substituir o comportamento padrão para confirmar e descartar quaisquer alterações.

Web Components Grid Cell Editing and Edit Templates Example

Edição de células

Editing through UI

Você pode entrar no modo de edição para uma célula específica, quando uma célula editável estiver em foco de uma das seguintes maneiras:

• no clique duplo;
• em clique único - Um clique único entrará no modo de edição somente se a célula selecionada anteriormente estava no modo de edição e a célula selecionada atualmente for editável. Se a célula selecionada anteriormente não estava no modo de edição, um clique único selecionará a célula sem entrar no modo de edição;
• na tecla pressione Enter;
• ao pressionar a tecla F2;

Você pode sair do modo de edição sem confirmar as alterações de uma das seguintes maneiras:

• ao pressionar a tecla Escape;
• quando você executa operações de classificação, filtragem, pesquisa e ocultação;

Você pode sair do modo de edição e confirmar as alterações de uma das seguintes maneiras:

• na tecla pressione Enter;
• ao pressionar a tecla F2;
• ao pressionar a tecla Tab;
• com um único clique em outra célula - quando você clica em outra célula no IgcGridComponent, suas alterações serão enviadas.
• Operações como paginação, redimensionamento, fixar ou mover sairão do modo de edição e as alterações serão enviadas.

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

Editing through API

Você também pode modificar o valor da célula por meio da API IgcGridComponent, mas somente se a chave primária estiver definida:

public updateCell() {
    this.grid1.updateCell(newValue, rowID, 'ReorderLevel');
}

Outra maneira de atualizar a célula é diretamente através do método update da Cell:

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

Cell Editing Templates

Você pode ver e aprender mais sobre modelos de edição de células padrão no tópico de edição geral.

Se você quiser fornecer um modelo personalizado que será aplicado a uma célula, você pode passar esse modelo para a própria célula ou para seu cabeçalho. Primeiro crie a coluna como você normalmente faria:

<igc-column
    field="Race"
    data-type="string"
    editable="true"
    id="column1">
</igc-column>

e passe os modelos para esta coluna no arquivo index.ts:

constructor() {
    var grid1 = document.getElementById('grid1') as IgcGridComponent;
    var column1 = document.getElementById('column1') as IgcColumnComponent;
    var column2 = document.getElementById('column2') as IgcColumnComponent;
    var column3 = document.getElementById('column3') as IgcColumnComponent;

    grid1.data = this.webGridCellEditSampleRoleplay;
    column1.inlineEditorTemplate = this.webGridCellEditCellTemplate;
    column2.inlineEditorTemplate = this.webGridCellEditCellTemplate;
    column3.inlineEditorTemplate = this.webGridCellEditCellTemplate;
}


public webGridCellEditCellTemplate = (ctx: IgcCellTemplateContext) => {
    let cellValues: any = [];
    let uniqueValues: any = [];
    for(const i of (this.webGridCellEditSampleRoleplay as any)){
        const field: string = ctx.cell.column.field;
        if(uniqueValues.indexOf(i[field]) === -1 )
        {
            cellValues.push(html`<igc-select-item value=${i[field]}>${(i[field])}</igc-select-item>`);
            uniqueValues.push(i[field]);
        }
    }
    return html`
        <igc-select style="width:100%; height:100%" size="large" @igcChange=${(e: any) => ctx.cell.editValue = e.detail.value}>
            ${cellValues}
        </igc-select>
    `;
}

Uma amostra funcional do acima pode ser encontrada aqui para referência futura:

Grid Excel Style Editing

Usar a Edição de Estilo do Excel permite que o usuário navegue pelas células da mesma forma que faria usando o Excel e edite-as rapidamente.

A implementação dessa funcionalidade personalizada pode ser feita utilizando os eventos do IgcGridComponent. Primeiro, conectamos aos eventos keydown da grade e, a partir daí, podemos implementar duas funcionalidades:

• Modo de edição constante

public keydownHandler(event) {
  const key = event.keyCode;
  const grid = this.grid;
  const activeElem = grid.navigation.activeNode;

  if ((key >= 48 && key <= 57) ||
      (key >= 65 && key <= 90) ||
      (key >= 97 && key <= 122)) {
        // Number or Alphabet upper case or Alphabet lower case
        const columnName = grid.getColumnByVisibleIndex(activeElem.column).field;
        const cell = grid.getCellByColumn(activeElem.row, columnName);
        if (cell && !grid.crudService.cellInEditMode) {
            grid.crudService.enterEditMode(cell);
            cell.editValue = event.key;
        }
    }
}

• Navegação Enter / Shift+Enter​

if (key == 13) {
    let thisRow = activeElem.row;
    const column = activeElem.column;
    const rowInfo = grid.dataView;

    // to find the next eligible cell, we will use a custom method that will check the next suitable index
    let nextRow = this.getNextEditableRowIndex(thisRow, rowInfo, event.shiftKey);

    // and then we will navigate to it using the grid's built in method navigateTo
    this.grid.navigateTo(nextRow, column, (obj) => {
        obj.target.activate();
        this.grid.clearCellSelection();
        this.cdr.detectChanges();
    });
}

As principais partes para encontrar o próximo índice elegível seriam:

//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));

Confira o exemplo completo para referência futura:

Exemplo de edição de estilo Excel de grade de Web Components

Os principais benefícios da abordagem acima incluem:

• Modo de edição constante: digitar enquanto uma célula estiver selecionada entrará imediatamente no modo de edição com o valor digitado, substituindo o existente
• Quaisquer linhas sem dados são ignoradas ao navegar com Enter / Shift+Enter. Isso permite que os usuários percorram rapidamente seus 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.

O IgcGridComponent fornece uma API simples para operações CRUD básicas.

Adding a new record

O componente IgcGridComponent expõe o método addRow que adicionará os dados fornecidos à própria fonte de dados.

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

Updating data in the Grid

A atualização de dados na grade é obtida por meio dos métodos updateRow e updateCell mas somente se a PrimaryKey para a grade for definida. Você também pode atualizar diretamente uma célula e/ou um valor de linha por meio de seus respectivos métodos de atualização.

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

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

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

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

Deleting data from the Grid

Tenha em mente que o método deleteRow removerá a linha especificada somente se uma primaryKey for definida.

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

Cell Validation on Edit Event

Usando os eventos de edição do IgcGridComponent, podemos alterar como o usuário interage com o IgcGridComponent.

Neste exemplo, validaremos uma célula com base nos dados inseridos nela vinculando-a ao evento CellEdit. Se o novo valor da célula não atender aos nossos critérios predefinidos, impediremos que ela alcance a fonte de dados cancelando o evento.

A primeira coisa que precisamos fazer é vincular ao evento da grade:

constructor() {
    var grid = document.getElementById('grid') as IgcGridComponent;
    this.webGridCellEdit = this.webGridCellEdit.bind(this);
    grid.addEventListener("cellEdit", this.webGridCellEdit);
}

O CellEdit emite sempre que qualquer valor de célula está prestes a ser confirmado. Em nossa definição de CellEdit, precisamos ter certeza de que verificamos nossa coluna específica antes de tomar qualquer ação:

public webGridCellEdit(event: CustomEvent<IgcGridEditEventArgs>): void {
    const column = event.detail.column;
    if (column.field === 'UnitsOnOrder') {
            const rowData = event.detail.rowData;
            if (!rowData) {
                return;
            }
            if (event.detail.newValue > rowData.UnitsInStock) {
                event.cancel = true;
                alert("You cannot order more than the units in stock!");
            }
    }
}

Se o valor inserido em uma célula na coluna Unidades Encomendadas for maior que a quantidade disponível (o valor em Unidades em Estoque), a edição será cancelada e o usuário será alertado sobre o cancelamento.

O resultado da validação acima sendo aplicada ao nosso IgcGridComponent pode ser visto na demonstração abaixo:

Styling

Além dos temas predefinidos, a grade pode ser ainda mais personalizada ao definir algumas das propriedades CSS disponíveis. Caso você queira alterar algumas das cores, precisa definir uma classe para a grade primeiro:

<igc-grid class="grid"></igc-grid>

Em seguida, defina as propriedades CSS relacionadas para essa classe:

.grid {
    --ig-grid-edit-mode-color: orange;
    --ig-grid-cell-editing-background: lightblue;
}

Styling Example

API References

• IgcGridComponent

• IgcDatePickerComponent

Additional Resources

• Virtualização e desempenho
• Paginação
• Filtragem
• Classificação
• Resumos
• Fixação de coluna
• Redimensionamento de colunas
• Escolha
• Procurando