📂 Excel-ent

https://img.shields.io/npm/v/excel-ent

https://img.shields.io/npm/l/excel-ent

🗃️ Sumário

Versão 4

Descrição

excel-ent é uma biblioteca auxiliar que simplifica a exportação de dados para XLSX e CSV usando a biblioteca SheetJS CE por baixo dos panos. Agora podendo ser usada tanto via client browser ou backend server.

Instalação

yarn add excel-ent

# or with npm

npm install excel-ent --save

💻 Usando o excel-ent

O Excel-ent fornece três funções principais para exportar dados: exportmeExcel, exportmeToCsv e exportmeExcelAdvanced.

→ exportmeExcel

exportmeExcel(data: any[], fileName: string, 
  exportAs: {
    type: 'buffer' | 'base64' | 'download' | 'filepath';
    path?: string; // Obrigatório se o tipo for 'filepath'
  }, 
  options?: {
    headerStyle?: XLSX.CellStyle;
    bodyStyle?: XLSX.CellStyle;
    columnWidths?: number[];
    rowHeights?: number[];
    globalRowHeight?: number;
    sheetProps?: XLSX.FullProperties;
    stripedRows?: boolean;
})

Parâmetros

• data: Obrigatório, deve ser um array de objetos ou do tipo **PaginatedObjectContentProps **(se voce precisar de multiplas abas de planilhas)
• fileName: Obrigatório, o nome do arquivo gerado.
• options: Opcional, recebe os seguintes atributos:
  • headerStyle e bodyStyle: Ambos recebem estilos no formato XLSX.CellStyle. Você pode verificar as opções disponíveis aqui no xlsx-js-style
  • columnWidths: Um array de valores numéricos indicando a largura mínima de cada coluna.
  • rowHeights: Um array de valores numéricos indicando a altura mínima de cada linha.
  • globalRowHeight: Um valor numérico que define uma altura mínima para TODAS as linhas na matriz.
  • sheetProps: Propriedades adicionais para a planilha, seguindo XLSX.FullProperties. Você pode verificar a documentação oficial para mais detalhes...
  • stripedRows: Opcional, alterna as cores das linhas entre branco (customizável via estilização da célula) e cinza claro (F2F2F2) para melhorar a legibilidade dos dados.