@gecosuy/angular-components-find-and-select
v17.0.0
Published
Librería conteniendo un componente genérico para listar un conjunto de elementos y permitir seleccionar uno o varios de ellos.
Downloads
18
Readme
FindAndSelect
Librería conteniendo un componente genérico para listar un conjunto de elementos y permitir seleccionar uno o varios de ellos.
Uso
<div>
<h1>Titulo</h1>
<gecos-find-and-select #fas [mode]="'scroll'" [columns]="columns" [fetchPage]="fetchPage"> </gecos-find-and-select>
<button (click)="onAcceptClick(fas.getSelectedItems())">Aceptar</button>
</div>
Los Inputs mas importantes son:
mode
: indica el modo en que se va visualizar el componente- table: El componente se visualiza en forma de tabla y muestra un paginador en la parte inferior
- scroll: El componente se visualiza en forma lista scrolleable y se muestra un botón para cargar la próxima página
- infinityScroll: El componente se visualiza en forma lista scrolleable y se utiliza el scroll para cargar las siguientes páginas
fetchItems
: funcion que recibe parámetros de paginado y filtro universal y debe retornar la página de elementos correspondientescolumns
: metadata de las columnas que se quieren mostrar, revisar el interface FindAndSelectColumnfixedListHeight
: Valor CSS a dar al height del listado. Necesario por ejemplo cuando se quiere utilizar el componente dentro de un diálogo, en este caso se recomienda establecer un valor en 'vh' entre un 40 y 60.
Ver los demás Inputs viendo la clase del componente.
El titulo y los potenciales botones de Aceptar y Cancelar NO son parte del componente, por lo que deben agregarse dentro de la vista o diálogo padre.
El componente cuenta con un método getSelectedItems()
que puede ser invocado en cualquier momento. Una buena forma de trabajar el botón Aceptar es como se muestra en el ejemplo anterior, donde se le da un nombre al componente en el html y mismo en el html se invoca el getSelectedItems().
Uso dentro de diálogo
La librería cuenta con un componente FindAndSelectDialog que pretende ser un diálogo ya implementado que puede ser usado pasando un template del FindAndSelectComponent que mostrar. Resuelve el ya tener el componente de diálogo con título y acciones, además de manejar correctamente el scroll interno del FindAndSelectComponent dentro del diálogo.
Pero aún no está operativo este componente porque no se ha podido encontrar la forma de acceder al FindAndSelectComponent interno del template para acceder a sus selected items para retornarlos en el close del diálogo.
Mientras no se resuelve el problema anterior, la librería cuenta con otro diálogo genérico, el InternalFindAndSelectDialogComponent que cumple el mismo objetivo pero se invoca de diferente forma, en lugar de tener el find-and-select component instanciado en el cliente y pasar el template, se pasa en el dialog data un objeto con los valores para todos los inputs del componente (varios opcionales que tomarán valores por defecto si no se pasan). Para ver un uso de este diálogo ver la app de tester el diálogo 3.
Theming
Variables CSS
Las siguientes variables CSS son utilizadas por el componente y pueden ser redefinidas por el cliente para customizar.
--find-and-select-line-padding
: padding de cada item--find-and-select-line-color-hover
: color de background de los items cuando estan hover--find-and-select-line-color-selected
: color de background del item seleccionado
Clases CSS generadas
Las siguientes clases CSS son agregadas a las diferentes secciones del componente y pueden ser utilizadas desde fuera para customizar.
find-and-select
: wrapper de todo el componentefind-and-select__header
: header del componente donde se encuentra el filterfind-and-select__header__filter
: seción del filtro universalfind-and-select__header__clear
: icono de limpiar la seleccionfind-and-select__body
: body del componente donde se encuentra la lista/tabla y el paginador de la tablafind-and-select__body__list
: sección del listado de elementosfind-and-select__body__list__labels
: primera fila que corresponde a los labels de las columnasfind-and-select__body__list__item
: cada fila del listadofind-and-select__body__paginator
: paginador de la tablafind-and-select__body__paginator__go-to
: componente para seleccionar el número de páginafind-and-select__body__paginator__go-to__label
: label de "Ir a" del componente para seleccionar el número de páginafind-and-select__body__paginator__go-to__select
: select del componente para seleccionar el número de páginafind-and-select__body__loading--filter
: indicador de loading cuando se aplica filtrofind-and-select__status
: sección que muestra status de los elementos cargados hasta el momentofind-and-select__status__message
: mensaje de elementos cargados hasta el momentofind-and-select__status__more
: boton de cargar mas elementosfind-and-select__status__loading--page
: indicador de loading cuando se piden mas elementos (nueva página)