ngx-board - npm Package Compare versions

Comparing version 0.3.2 to 0.4.0

lib/board-column.d.ts

@@ -11,3 +11,6 @@ import { BoardCard } from './board-card';
     style?: any;
-    classlist?: string[];
+    classlist?: string[] | string;
+    disabled?: boolean;
+    data?: any;
+    predicate?: () => boolean;
 }

lib/board/board.component.d.ts

@@ -19,2 +19,3 @@ import { CdkDragDrop } from '@angular/cdk/drag-drop';
     reachedEnd: EventEmitter<BoardColumn<any>>;
+    defaultEnterPredicateFn: () => boolean;
     /**
@@ -21,0 +22,0 @@ * Emits an event with the clicked item as a parameter.

package.json

 {
   "name": "ngx-board",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "peerDependencies": {
@@ -5,0 +5,0 @@ "@angular/common": ">=14.0.0",

README.md

@@ -47,11 +47,47 @@ # ngx-board
 ```
-```typescript
-interface BoardColumn<T = any> {
-  title: string;
-  cards: Array<BoardCard<T>>;
-}
-```
-```typescript
-interface BoardCard<T = any> {
-```
+
+### Interfaz Board
+
+La interfaz `Board` representa un tablero completo.
+
+Sus propiedades son:
+
+- **id** (opcional): número unique que identifica el tablero.
+- **title**: título del tablero (requerido).
+- **description** (opcional): descripción del tablero.  
+- **color** (opcional): color de fondo del tablero.
+- **columns** (opcional): arreglo de columnas (tipado como `BoardColumn[]`) en el tablero.
+- **classlist** (opcional): arreglo de clases CSS para el tablero.
+- **style** (opcional): objeto de estilos CSS para el tablero.
+
+### Interfaz BoardColumn
+
+La interfaz `BoardColumn` representa una columna en un tablero. 
+
+Sus propiedades son:
+
+- **id** (opcional): número unique que identifica la columna.
+- **index** (opcional): posición de la columna en el tablero.
+- **boardId** (opcional): id del tablero al que pertenece la columna.
+- **title**: título de la columna (requerido).  
+- **description** (opcional): descripción de la columna.
+- **color** (opcional): color de fondo de la columna.
+- **cards**: arreglo de tarjetas (tipado como `BoardCard[]`) en la columna (requerido).
+- **style** (opcional): objeto de estilos CSS para la columna.
+- **classlist** (opcional): arreglo o string de clases CSS para la columna. 
+- **disabled** (opcional): booleano que indica si la columna está deshabilitada.
+- **data** (opcional): cualquier dato adicional para asociar a la columna.
+- **predicate** (opcional): función que devuelve un booleano para controlar visibilidad de la columna.
+
+Aquí un ejemplo para documentar la interfaz BoardCard en el README:
+
+### Interfaz BoardCard
+
+- **id** (opcional): número único que identifica la tarjeta.
+- **title**: título de la tarjeta (requerido).
+- **description** (opcional): descripción de la tarjeta.
+- **data** (opcional): cualquier dato custom para asociar a la tarjeta.
+- **classlist** (opcional): arreglo de clases CSS para la tarjeta.
+- **style** (opcional): objeto de estilos CSS para la tarjeta.
+
 ## Inputs
@@ -58,0 +94,0 @@ | Input | Description |

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

158079

increased by6.38%

Lines of code

904

increased by2.84%

Number of lines in readme file

203

increased by21.56%

No dependency changes