ngx-dabd-grupo01
v6.0.0
Published
El `TableComponent` es un componente reutilizable que muestra una tabla con soporte para paginación, búsqueda, exportación y renderizado de contenido personalizado mediante plantillas.
Downloads
2,324
Readme
TableComponent
El TableComponent
es un componente reutilizable que muestra una tabla con soporte para paginación, búsqueda, exportación y renderizado de contenido personalizado mediante plantillas.
Instalación
Primero, debes importar el componente en el módulo o componente donde desees utilizarlo:
import { TableComponent } from "./table.component";
Uso básico
A continuación se presenta un ejemplo básico de cómo usar el TableComponent
:
<app-table [items]="items" [columns]="columns" [pagination]="pagination" [isLoading]="isLoading"> </app-table>
Inputs
items:
any[]
(Requerido)- Los datos que se mostrarán en la tabla. Cada elemento del array representa una fila de la tabla.
columns:
TableColumn[]
(Requerido)- Definición de las columnas que se mostrarán en la tabla. Cada columna tiene un
headerName
(nombre que aparece en el encabezado de la tabla) y unaccessorKey
(clave que indica qué propiedad delitem
se debe mostrar).
- Definición de las columnas que se mostrarán en la tabla. Cada columna tiene un
isLoading:
boolean | null
(Opcional, por defecto:false
)- Muestra un indicador de carga en la tabla si su valor es
true
.
- Muestra un indicador de carga en la tabla si su valor es
pagination:
TablePagination
(Opcional)- Objeto que maneja la paginación de la tabla. Incluye propiedades como
totalItems
,page
,size
, y métodos para cambiar de página o ajustar la cantidad de ítems por página.
- Objeto que maneja la paginación de la tabla. Incluye propiedades como
height:
string
(Opcional, por defecto:'580px'
)- Define la altura de la tabla, útil para hacer la tabla con desplazamiento (scroll).
showSearchBar:
boolean
(Opcional, por defecto:true
)- Muestra u oculta la barra de búsqueda en la parte superior de la tabla.
showExportOptions:
boolean
(Opcional, por defecto:true
)- Muestra u oculta los botones de exportación (PDF y Excel).
Outputs
- searchValueChange:
EventEmitter<string>
- Emite el valor de búsqueda cada vez que se cambia en la barra de búsqueda.
Ejemplos de uso
1. Ejemplo Básico: Items, Columns e isLoading
Componente HTML (basic-table.component.html
)
<app-table [items]="items" [columns]="columns" [isLoading]="isLoading"></app-table>
Componente TypeScript (basic-table.component.ts
)
import { Component, OnInit } from "@angular/core";
import { Observable, of } from "rxjs";
import { delay } from "rxjs/operators";
import { TableColumn } from "path-to-table-component"; // Ajustar la ruta
@Component({
selector: "app-basic-table",
templateUrl: "./basic-table.component.html",
styleUrls: ["./basic-table.component.css"],
})
export class BasicTableComponent implements OnInit {
// Properties
items: any[] = [];
columns: TableColumn[] = [];
isLoading: boolean = true;
// Simulando un servicio con datos de ejemplo
private dataService = {
getItems: (): Observable<any[]> => {
return of([
{ id: 1, name: "Item 1", description: "Description 1" },
{ id: 2, name: "Item 2", description: "Description 2" },
{ id: 3, name: "Item 3", description: "Description 3" },
]).pipe(delay(2000)); // Simula un retraso en la carga de los datos
},
};
ngOnInit(): void {
// Configuración de las columnas de la tabla
this.columns = [
{ headerName: "ID", accessorKey: "id" },
{ headerName: "Name", accessorKey: "name" },
{ headerName: "Description", accessorKey: "description" },
];
// Cargar los datos y simular el proceso de carga
this.loadData();
}
loadData(): void {
this.isLoading = true;
this.dataService.getItems().subscribe((data) => {
this.items = data;
this.isLoading = false;
});
}
}
Explicación
Inputs Utilizados
items
: Un array de objetos que representa los datos de la tabla. En este ejemplo, cada objeto tieneid
,name
ydescription
.columns
: Un array de objetos de tipoTableColumn
, donde cada columna especifica unheaderName
y unaccessorKey
para mapear los datos deitems
.isLoading
: Un booleano que indica si los datos aún están cargándose. Mientras esté entrue
, se mostrará un estado de carga.
2. Ejemplo con componentes añadidos
- Un botón que permite recargar los datos.
- Un
select
que simula ser un filtro para los elementos de la tabla.
Ejemplo con Botón y Select de Filtro
Componente HTML (filter-table.component.html
)
<!-- Tabla que muestra los datos -->
<app-table [items]="filteredItems" [columns]="columns" [isLoading]="isLoading">
<!-- Select para simular filtro -->
<select id="filter" [(ngModel)]="selectedFilter" (change)="filterItems()">
<option value="">All</option>
<option *ngFor="let item of originalItems" [value]="item.name">{{ item.name }}</option>
</select>
<!-- Botón para recargar los datos -->
<button (click)="reloadData()">Reload Data</button>
</app-table>
Componente TypeScript (filter-table.component.ts
)
import { Component, OnInit } from "@angular/core";
import { Observable, of } from "rxjs";
import { delay } from "rxjs/operators";
import { TableColumn } from "path-to-table-component"; // Ajustar la ruta
@Component({
selector: "app-filter-table",
templateUrl: "./filter-table.component.html",
styleUrls: ["./filter-table.component.css"],
})
export class FilterTableComponent implements OnInit {
// Properties
originalItems: any[] = [];
filteredItems: any[] = [];
columns: TableColumn[] = [];
isLoading: boolean = true;
selectedFilter: string = "";
// Simulando un servicio con datos de ejemplo
private dataService = {
getItems: (): Observable<any[]> => {
return of([
{ id: 1, name: "Item 1", description: "Description 1" },
{ id: 2, name: "Item 2", description: "Description 2" },
{ id: 3, name: "Item 3", description: "Description 3" },
]).pipe(delay(2000)); // Simula un retraso en la carga de los datos
},
};
ngOnInit(): void {
// Configuración de las columnas de la tabla
this.columns = [
{ headerName: "ID", accessorKey: "id" },
{ headerName: "Name", accessorKey: "name" },
{ headerName: "Description", accessorKey: "description" },
];
// Cargar los datos iniciales
this.loadData();
}
loadData(): void {
this.isLoading = true;
this.dataService.getItems().subscribe((data) => {
this.originalItems = data;
this.filteredItems = data; // Inicialmente, mostrar todos los datos
this.isLoading = false;
});
}
filterItems(): void {
if (this.selectedFilter === "") {
this.filteredItems = this.originalItems; // Si no hay filtro, mostrar todos
} else {
this.filteredItems = this.originalItems.filter((item) => item.name === this.selectedFilter);
}
}
reloadData(): void {
// Recargar los datos simulando una nueva obtención del servicio
this.loadData();
}
}
3. Ejemplo con Paginación
Componente HTML (pagination-table.component.html
)
<app-table
[items]="(items$ | async) || []"
[columns]="columns"
[pagination]="{
totalItems: (totalItems$ | async) || 0,
page: page,
size: size,
onPageChange: onPageChange,
onPageSizeChange: onPageSizeChange
}"
[isLoading]="isLoading$ | async"
[showSearchBar]="true"
[showExportOptions]="true"
>
</app-table>
Componente TypeScript (pagination-table.component.ts
)
@Component({
selector: "app-item-list",
standalone: true,
imports: [CommonModule, TableComponent],
templateUrl: "./item-list.component.html",
})
export class ItemListComponent {
// Servicios
private itemService = inject(ItemService);
// Propiedades
items$: Observable<ItemResponseDto[]> = this.itemService.items$;
totalItems$: Observable<number> = this.itemService.totalItems$;
isLoading$: Observable<boolean> = this.itemService.isLoading$;
page: number = 1;
size: number = 10;
columns: TableColumn[] = [
{ headerName: "Id", accessorKey: "item_id" },
{ headerName: "Project Name", accessorKey: "project_name" },
{ headerName: "Start Date", accessorKey: "start_date" },
{ headerName: "End Date", accessorKey: "end_date" },
];
// Métodos
ngOnInit(): void {
this.loadItems();
}
loadItems(): void {
this.itemService.getAllItems(this.page, this.size).subscribe();
}
onPageChange = (page: number): void => {
this.page = page;
this.loadItems();
};
onPageSizeChange = (size: number): void => {
this.size = size;
this.loadItems();
};
}
- Para agregar un formateo personalizado a una columna de la tabla, como en el ejemplo donde añadiste un botón a la columna "Actions", puedes usar una plantilla Angular (
ng-template
) concellRenderer
. Aquí te muestro cómo hacerlo, utilizando un ejemplo en el que se añade un botón para ver detalles y otro para eliminar en la columna "Acciones" de una tabla.
Paso 1: Crear el ng-template
con los botones (en el HTML del componente)
<ng-template #actionsTemplate let-item>
<button class="btn btn-primary btn-sm me-2" (click)="goToDetails(item.item_id)">Ver más</button>
<button class="btn btn-danger btn-sm" (click)="deleteItem(item.item_id)">Eliminar</button>
</ng-template>
Paso 2: Configurar la tabla para utilizar el cellRenderer
en la columna "Acciones" (en el archivo .ts
del componente)
@Component({
selector: "app-item-list",
standalone: true,
imports: [CommonModule, TableComponent, MainContainerComponent],
templateUrl: "./item-list.component.html",
styleUrls: ["./item-list.component.css"],
})
export class ItemListComponent {
// Services:
private readonly router = inject(Router);
private itemService = inject(ItemService);
private modalService = inject(NgbModal);
// Properties:
items$: Observable<Item[]> = this.itemService.items$;
totalItems$: Observable<number> = this.itemService.totalItems$;
page: number = 1;
size: number = 10;
@ViewChild("actionsTemplate") actionsTemplate!: TemplateRef<any>;
columns: TableColumn[] = [];
// Methods:
ngOnInit(): void {
this.loadItems();
}
ngAfterViewInit(): void {
setTimeout(() => {
this.columns = [
{ headerName: "Id", accessorKey: "item_id" },
{ headerName: "Description", accessorKey: "description" },
{
headerName: "Actions",
accessorKey: "actions",
cellRenderer: this.actionsTemplate, // Asignamos el cellRenderer con la plantilla
},
];
});
}
loadItems(): void {
this.itemService.getAllItems(this.page, this.size).subscribe((response) => {
this.itemService.setItems(response.items);
this.itemService.setTotalItems(response.total);
});
}
onPageChange = (page: number): void => {
this.page = page;
this.loadItems();
};
onPageSizeChange = (size: number): void => {
this.size = size;
this.loadItems();
};
goToDetails(id: number): void {
this.router.navigate(["items", id]);
}
deleteItem(id: number): void {
// Lógica para eliminar el item
console.log(`Item con ID ${id} eliminado`);
}
}
Explicación:
@ViewChild('actionsTemplate') actionsTemplate!: TemplateRef<any>;
: Esto nos permite acceder alng-template
dentro del componente, y lo asignamos a la columna "Actions" mediantecellRenderer
.- Plantilla
#actionsTemplate
: Aquí defines los botones personalizados (Ver más y Eliminar) que se renderizan en la columna "Acciones". cellRenderer: this.actionsTemplate
: UsamoscellRenderer
para que la tabla renderice esta plantilla personalizada en la columna "Acciones".
Interfaces
TableColumn
export interface TableColumn {
headerName: string; // El nombre del encabezado de la columna
accessorKey: string; // La clave del dato en los ítems para mostrar en la columna
cellRenderer?: TemplateRef<any>; // Opcional: un template para renderizar contenido personalizado
}
TablePagination
export interface TablePagination {
totalItems: number; // Total de ítems en la tabla
page: number; // Página actual
size: number; // Tamaño de la página (cantidad de ítems por página)
onPageChange: (page: number) => void; // Método que se llama al cambiar la página
onPageSizeChange: (itemsPerPage: number) => void; // Método que se llama al cambiar el tamaño de ítems por página
}
Descripción
El servicio de Toasts proporciona una forma sencilla de mostrar mensajes emergentes (toasts) en la aplicación. Los toasts pueden mostrar mensajes de éxito, error o cualquier otro mensaje personalizado utilizando plantillas.
Instalación
Asegúrate de tener las dependencias necesarias instaladas en tu proyecto Angular:
npm install @ng-bootstrap/ng-bootstrap
Uso
1. Integración del Componente
Para mostrar los toasts, primero debes agregar el componente ToastsContainer
en tu app.component.html
o en cualquier otro componente donde desees que aparezcan los toasts. Ejemplo:
<app-custom-nav-bar />
<router-outlet />
<app-toasts aria-live="polite" aria-atomic="true"></app-toasts>
2. Uso del ToastService
Inyecta el ToastService
en el componente donde desees mostrar los toasts. Luego, puedes usar sus métodos para mostrar mensajes de éxito, error o mensajes personalizados.
Ejemplo de Uso
import { Component } from "@angular/core";
import { ToastService } from "./toast-service";
@Component({
selector: "app-example",
templateUrl: "./example.component.html",
})
export class ExampleComponent {
constructor(private toastService: ToastService) {}
showSuccess() {
this.toastService.sendSuccess("¡Operación exitosa!");
}
showError() {
this.toastService.sendError("¡Ocurrió un error!");
}
showCustomTemplate() {
const customTemplate = `
<div>Mensaje de plantilla personalizada</div>
`;
this.toastService.show({
template: customTemplate,
classname: "bg-info text-light",
delay: 5000,
});
}
}
3. Métodos del ToastService
sendSuccess(message: string)
: Muestra un mensaje de éxito.sendError(message: string)
: Muestra un mensaje de error.show(toast: Toast)
: Muestra un toast utilizando un objetoToast
.remove(toast: Toast)
: Elimina un toast específico.clear()
: Limpia todos los toasts.
4. Uso de Mensajes
- Mensaje de Éxito:
this.toastService.sendSuccess("¡La operación fue exitosa!");
- Mensaje de Error:
this.toastService.sendError("¡Ha ocurrido un error en la operación!");
- Mensaje Personalizado: Si deseas mostrar un mensaje utilizando una plantilla personalizada:
this.toastService.show({
template: customTemplate,
classname: "bg-warning text-dark",
delay: 7000,
});
Personalización
Puedes personalizar el aspecto de los toasts mediante las clases de Bootstrap. Los parámetros classname
, delay
, y context
permiten un control total sobre la apariencia y el comportamiento de los toasts.
Ejemplo Completo
import { Component } from "@angular/core";
import { ToastService } from "./toast-service";
@Component({
selector: "app-example",
template: `
<button (click)="showSuccess()">Mostrar Éxito</button>
<button (click)="showError()">Mostrar Error</button>
<button (click)="showCustomTemplate()">Mostrar Plantilla Personalizada</button>
`,
})
export class ExampleComponent {
constructor(private toastService: ToastService) {}
showSuccess() {
this.toastService.sendSuccess("¡Operación exitosa!");
}
showError() {
this.toastService.sendError("¡Ocurrió un error!");
}
showCustomTemplate() {
const customTemplate = `
<div>Mensaje de plantilla personalizada</div>
`;
this.toastService.show({
template: customTemplate,
classname: "bg-info text-light",
delay: 5000,
});
}
}
ExcelExportService
ExcelExportService
es un servicio de Angular diseñado para exportar datos a archivos Excel (.xlsx). Utiliza la biblioteca SheetJS (xlsx) para facilitar la creación y descarga de archivos Excel desde datos estructurados en formato JSON.
Instalación
Para utilizar este servicio, primero asegúrate de tener la biblioteca xlsx
instalada en tu proyecto Angular:
npm install xlsx
Uso
Importación
Importa el ExcelExportService
en el módulo de tu aplicación:
import { ExcelExportService } from "./path/to/excel-export.service";
Inyección de Dependencias
Asegúrate de inyectar el servicio en el componente donde lo necesites:
import { Component } from "@angular/core";
import { ExcelExportService } from "./path/to/excel-export.service";
@Component({
selector: "app-your-component",
templateUrl: "./your-component.component.html",
})
export class YourComponent {
constructor(private excelExportService: ExcelExportService) {}
// Ejemplo de uso...
}
Exportación de Datos
Para exportar datos a Excel, llama al método exportToExcel
con los parámetros necesarios:
const data = [
{ id: 1, name: "John Doe", age: 30 },
{ id: 2, name: "Jane Smith", age: 25 },
];
const columns = [
{ header: "ID", accessor: (item) => item.id },
{ header: "Nombre", accessor: (item) => item.name },
{ header: "Edad", accessor: (item) => item.age },
];
this.excelExportService.exportToExcel(data, columns, "mi_archivo", "Hoja1");
Parámetros del Método exportToExcel
data : Un arreglo de objetos que representan los datos que deseas exportar.
columns : Un arreglo de objetos que definen las columnas del archivo Excel, cada uno con:
header : El nombre de la columna que aparecerá en el archivo Excel.
accessor : Una función que toma un elemento de datos y devuelve el valor que se colocará en la celda correspondiente.
fileName : El nombre del archivo que se generará (sin la extensión
.xlsx
).sheetName : El nombre de la hoja de cálculo dentro del archivo Excel.
Ejemplo Completo
import { Component } from "@angular/core";
import { ExcelExportService } from "./path/to/excel-export.service";
@Component({
selector: "app-example",
template: `<button (click)="export()">Exportar a Excel</button>`,
})
export class ExampleComponent {
constructor(private excelExportService: ExcelExportService) {}
export(): void {
const data = [
{ id: 1, name: "John Doe", age: 30 },
{ id: 2, name: "Jane Smith", age: 25 },
];
const columns = [
{ header: "ID", accessor: (item) => item.id },
{ header: "Nombre", accessor: (item) => item.name },
{ header: "Edad", accessor: (item) => item.age },
];
this.excelExportService.exportToExcel(data, columns, "mi_archivo", "Hoja1");
}
}