1.0.0 • Published 5 years ago

@mcsoft/tabla-paginada v1.0.0

Weekly downloads
1
License
MIT
Repository
gitlab
Last release
5 years ago

Tabla Paginada

Componente de React que genera una tabla paginada la cual puede ser ordenada por los campos de la misma, así como filtrar los resultados.

Software Type Language Software License Version Downloads

Nota: Este componente requiere de Font Awesome 5 y BootStrap 4 para funcionar correctamente.

Instalación

npm install --save @mcsoft/tabla-paginada

Uso

import McComponente from '@mcsoft/tabla-paginada';

class Ejemplo extends Component {
  render () {
    return (
      <McComponente />
    )
  }
}

Props (Obligatorios)

PropiedadTipoDescripción
eventoCambiarOrdenamientoFunctionEvento que se ejecuta cuando se presiona un encabezado de la tabla para ordenar los registros mostrados por un campo específico. eventoCambiarOrdenamiento(ordenamiento: object) - ordenamiento: object - Objeto con los parámetros de ordenamiento. - ordenamiento.orden: string - Orden en que se mostrarán los registros 'asc'|'desc'. - ordenamiento.ordenadoPor: string - Campo por el que se ordenarán los registros.
eventoCambiarPaginaActualFunctionEvento que se ejecuta cuando se presiona un botón de página específica. eventoCambiarPaginaActual(numeroPagina: number) - numeroPagina: number - Número de página requerida.
eventoCambiarRegistrosPorPaginaFunctionEvento que se ejecuta cuando se cambia la cantidad de registros que se mostrarán por página. eventoCambiarRegistrosPorPagina(cantidadRegistroPorPagina: number) - cantidadRegistroPorPagina: number - Cantidad de registros a mostrar por página.
eventoObtenerRegistrosFunctionEvento que se ejecuta cada que hay un cambio que requiera obtener de nuevo los registros a mostrar. eventoObtenerRegistros(numeroPagina: number, cantidadRegistroPorPagina: number, ordenadoPor: string, orden: string, criterioBusqueda: string) - numeroPagina: number - Número de página requerida. - cantidadRegistroPorPagina: number - Cantidad de registros a mostrar por página. - ordenadoPor: string - Campo por el que se ordenarán los registros. - orden: string - Orden en que se mostrarán los registros 'asc'|'desc'. - criterioBusqueda: string - Criterio de busqueda para filtrar los registros.
eventoSeleccionarRegistroFunctionEvento que se ejecuta cuando se hace clic sobre un registro de la tabla. eventoSeleccionarRegistro(registroId: any) - registroId: any - Id del registro seleccionado
registrosEncabezadosArray<object>Arreglo de objetos con la configuracion de los encabezados de la tabla. - atributo: string - Atributo del registro que se mostrará en las celdas de la tabla. - claseEncabezado: string - Clase que se aplicará en el encabezado. - campo: string - Nombre del campo (Como aparece en la base de datos). - formatoFecha: string - Formato para la fecha en caso de que el campo sea tipo 'fecha' (Default: 'DD/MM/YYYY'). - titulo: string - Nombre del campo (Como aparecerá en el encabezado de la tabla).
registrosListaArray<object>Arreglo de objetos con los registros que se mostrarán en la tabla.
registrosMostrandoFinalnumberÚltimo registro mostrado en la página actual.
registrosMostrandoInicialnumberPrimer registro mostrado en la página actual.
registrosMostrandoPorPaginanumberCantidad de registros que serán mostrados en cada página.
registrosOrdenadoPorstringCampo por el que se ordenarán los registros.
registrosPaginaActualnumberPágina actualmente seleccionada.
registrosPaginaFinalnumberÚltima página existente.
registrosTotalnumberCantidad total de registros.

Props (Opcionales)

PropiedadTipoPredeterminadoDescripción
cantidadBotonesnumber3Controla la cantidad de botones de páginas que se mostrarán tanto antes como despues del botón de la página actual.
iconoBuscarstring'fas fa-search'Icono (FontAwesome) que se mostrará en el boton de buscar.
iconoOrdenAscendentestring'fas fa-sort-alpha-down'Icono (FontAwesome) que se mostrará en el encabezado cuando los registros esten ordenados de manera ascendente.
iconoOrdenDescendentestring'fas fa-sort-alpha-up'Icono (FontAwesome) que se mostrará en el encabezado cuando los registros esten ordenados de manera ascendente.
iconoSinResultadosstring'fas fa-list-ul'Icono (FontAwesome) que se mostrará la lista de registros recibida este vacía.
registrosMostrandoPorPaginaOpcionesArray<string>'20','50','100'Arreglo de cadenas con las opciones a mostrar de registros por página.
registrosOrdenstring'asc'Orden en que se mostrarán los registros 'asc'|'desc'.
textoobjectObjeto con los textos personalizados del componente.
texto.botonAnteriorstring'Anterior'Texto del botón de página anterior
texto.botonPrimerastring'Primera'Texto del botón de la primera página.
texto.botonSiguientestring'Siguiente'Texto del botón de página siguiente.
texto.botonUltimastring'Última'Texto del botón de la última página.
texto.buscarstring'Buscar'Texto que parecerá en el campo de texto de busqueda.
texto.limpiarstring'Limpiar'Texto que parecerá en el boton de limpiar del campo de busqueda.
texto.paginastring'Página'Parte del texto Página # de #.
texto.paginaDestring'de'Parte del texto Página # de #.
texto.resultadosAlstring'al'Parte del texto Mostrando resultados del # al # de #.
texto.resultadosDestring'de'Parte del texto Mostrando resultados del # al # de #.
texto.resultadosMostrando'Mostrando resultados del'PendienteParte del texto Mostrando resultados del # al # de #.
texto.resultadosPorPaginastring'Resultados por página'Texto que se mostrará junto al selector de resultados por página.
texto.sinResultadosDescripcionstring'No se encontraron resultados.'Mensaje que se mostrará cuando la lista de registros este vacía.
texto.sinResultadosTitulostring'Sin resultados'Título que se mostrará cuando la lista de registros este vacía.
1.0.0

5 years ago