@greenborn/vue-greenborn-crud 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -122,23 +122,43 @@ Con `permisos = []` no aparece ningún botón de acción.
|
|
|
122
122
|
{
|
|
123
123
|
field: 'precio', // columna (obligatorio)
|
|
124
124
|
headerName: 'Precio', // etiqueta (si falta, se usa field)
|
|
125
|
-
type: 'number', // text | number | date | boolean | select
|
|
126
|
-
form_type: 'number', // text | number | date | checkbox | select | textarea | email (si falta, se deduce de type)
|
|
125
|
+
type: 'number', // text | number | date | boolean | select | multiselect
|
|
126
|
+
form_type: 'number', // text | number | date | checkbox | select | multiselect | textarea | markdown | email (si falta, se deduce de type)
|
|
127
127
|
required: true, // validación cliente y marca "*"
|
|
128
128
|
sortable: true, // pasa a la columna
|
|
129
129
|
filterable: true, // pasa a la columna
|
|
130
130
|
writable: true, // false = no entra en el formulario (default true)
|
|
131
|
-
options: [{ value: 1, label: 'Activo' }], //
|
|
131
|
+
options: [{ value: 1, label: 'Activo' }], // select y multiselect (ver abajo)
|
|
132
|
+
filas: 6, // sólo textarea y markdown: filas del <textarea> (default 4)
|
|
132
133
|
css: 'text-end', // clase de la columna
|
|
133
134
|
}
|
|
134
135
|
```
|
|
135
136
|
|
|
136
137
|
Reglas:
|
|
137
138
|
|
|
138
|
-
- `form_type` por defecto: `boolean` -> `checkbox`; `text`, `number`, `date
|
|
139
|
+
- `form_type` por defecto: `boolean` -> `checkbox`; `select` -> `select`; `multiselect` -> `multiselect`; `text`, `number`, `date` -> igual que `type`. Un `form_type` fuera de la lista (`text`, `number`, `date`, `checkbox`, `select`, `multiselect`, `textarea`, `markdown`, `email`) lanza error al abrir el formulario.
|
|
139
140
|
- Sólo los campos con `writable !== false` aparecen en el formulario.
|
|
140
|
-
- Si se pasa `campos`, tiene prioridad sobre `fields_def` del back
|
|
141
|
-
- Los `required` se validan en el cliente (campo vacío o
|
|
141
|
+
- Si se pasa `campos`, tiene prioridad sobre `fields_def` del back para las columnas y el formulario. Si no se pasa, la primera respuesta de `GET /list` define los campos.
|
|
142
|
+
- Los `required` se validan en el cliente (campo vacío, sólo espacios o lista vacía en multiselect) y se marcan con `*`. Los campos `number` deben ser numéricos.
|
|
143
|
+
|
|
144
|
+
### Select y lookups
|
|
145
|
+
|
|
146
|
+
- `select` muestra un `<select>` con `options` (`{ value, label }`). Sin `required`, la primera opción es "— Seleccionar —" con valor vacío (se envía `null`). Con `required`, esa opción es deshabilitada y el cliente exige elegir una.
|
|
147
|
+
- Si `campos` (explícito) no trae `options` para un campo, se completan con las `options` del `fields_def` que devuelve `GET /list`, por nombre de campo. Las `options` propias del campo tienen prioridad.
|
|
148
|
+
- El valor enviado al back es el `value` de la opción tal cual.
|
|
149
|
+
- **Lookup en la tabla:** si la fila trae `<campo>_etiqueta`, la celda del campo muestra esa etiqueta. Si no viene, muestra el valor (o la etiqueta de `options` si la encuentra).
|
|
150
|
+
|
|
151
|
+
### Multiselect (relación N:M)
|
|
152
|
+
|
|
153
|
+
- `type: 'multiselect'` (o `form_type: 'multiselect'`) muestra una lista de checkboxes nativos con `options`. Sin opciones, muestra "Sin opciones disponibles.".
|
|
154
|
+
- El valor del registro y del formulario es un array de `value` (ids). Al guardar se envía el array completo (`[]` si no hay selección).
|
|
155
|
+
- En la tabla se muestran las etiquetas de `options` separadas por coma (no los ids).
|
|
156
|
+
|
|
157
|
+
### Textarea y markdown
|
|
158
|
+
|
|
159
|
+
- `form_type: 'textarea'`: `<textarea>` con `rows` tomado de `filas` (default 4). Texto plano, se envía tal cual.
|
|
160
|
+
- `form_type: 'markdown'`: igual, con la nota "Acepta markdown." y un botón "Vista previa". La vista previa usa `markdownAHtmlSeguro`: escapa todo el texto antes de aplicar un subconjunto fijo (encabezados `#` a `###`, `**negrita**`, `*cursiva*`, `` `código` `` y saltos de línea). No hay enlaces ni HTML crudo: el texto nunca produce etiquetas que no sean esas.
|
|
161
|
+
- En la tabla, las celdas de los campos definidos en `campos`/`fields_def` pasan por `valueFormatters` (TableEditor los inserta como HTML), así que el texto y las etiquetas se escapan. Los tipos `date`, `boolean`, `color` y `json` los formatea TableEditor antes de llegar a ese punto.
|
|
142
162
|
|
|
143
163
|
## Comportamiento
|
|
144
164
|
|
|
@@ -178,7 +198,7 @@ Devuelve:
|
|
|
178
198
|
| `tableConfig` | `computed` con la configuración para `<TableEditor :config>` (modo lazy, selección simple, botones según permisos). |
|
|
179
199
|
| `puede(accion)` | `true` si el usuario tiene `<recurso>.<accion>`. `accion`: `listar`, `crear`, `editar`, `eliminar`. |
|
|
180
200
|
| `permisosActuales` | `computed` con los permisos. |
|
|
181
|
-
| `camposEfectivos` | `computed` con los campos en uso (`campos` o los de `fields_def`; `null`
|
|
201
|
+
| `camposEfectivos` | `computed` con los campos en uso (`campos` o los de `fields_def`; con `campos` fijos, las `options` faltantes se toman de `fields_def`; `null` si no hay `campos` y todavía no llegó ninguna respuesta de `GET /list`). |
|
|
182
202
|
| `puedeListar` | `computed` booleano. |
|
|
183
203
|
| `onRowSelected(valor)` | Handler para el evento `rowSelected` del TableEditor. |
|
|
184
204
|
| `setTabla(instancia)` | Guarda la instancia del TableEditor (para `refresh`). |
|
|
@@ -190,7 +210,7 @@ Con `useCrud` el TableEditor se monta a mano: `<TableEditor :id="..." :api="crud
|
|
|
190
210
|
|
|
191
211
|
## Helpers exportados
|
|
192
212
|
|
|
193
|
-
Son funciones puras (sin Vue ni DOM)
|
|
213
|
+
Son funciones puras (sin Vue ni DOM) de `src/helpers.js`, testeadas con `node --test`. Las siguientes se exportan desde `src/index.js`:
|
|
194
214
|
|
|
195
215
|
| Helper | Uso |
|
|
196
216
|
|--------|-----|
|
|
@@ -205,6 +225,8 @@ Son funciones puras (sin Vue ni DOM), testeadas con `node --test`:
|
|
|
205
225
|
| `construirPayload(campos, valores)` | Payload para el back. |
|
|
206
226
|
| `extraerError(err)` | `{ message, errors }` desde un error HTTP (`err.response.data`), un `{ status: false, ... }` o un `Error`. |
|
|
207
227
|
|
|
228
|
+
Internos del paquete (en `src/helpers.js`, sin exportar desde `index.js`): `combinarOpciones`, `opcionesDeCampo`, `filasDeCampo`, `estaVacio`, `escaparHtml`, `etiquetaDeOpcion`, `textoCeldaCampo` (celda de tabla para lookups/multiselect), `formateadoresCeldas` (mapa `valueFormatters`) y `markdownAHtmlSeguro` (vista previa markdown).
|
|
229
|
+
|
|
208
230
|
## Demo
|
|
209
231
|
|
|
210
232
|
```bash
|
|
@@ -213,7 +235,7 @@ npm install
|
|
|
213
235
|
npm run dev # http://localhost:5175
|
|
214
236
|
```
|
|
215
237
|
|
|
216
|
-
La demo usa `demo/mockHttp.js` (http en memoria que responde con la forma del contrato) y permite alternar los permisos del usuario con checkboxes.
|
|
238
|
+
La demo usa `demo/mockHttp.js` (http en memoria que responde con la forma del contrato) y permite alternar los permisos del usuario con checkboxes. Incluye un lookup `categoria` (select con `categoria_etiqueta` en cada fila), un multiselect `etiquetas` (N:M, valor = array de ids), un `descripcion` textarea (`filas: 3`) y un `notas` markdown.
|
|
217
239
|
|
|
218
240
|
## Tests y build
|
|
219
241
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
.crud-modulo{--crud-text: #1f2937;--crud-muted: #6b7280;--crud-border: #d1d5db;--crud-bg: #ffffff;--crud-danger: #b91c1c;color:var(--crud-text);font-family:system-ui,-apple-system,Segoe UI,Roboto,sans-serif}@media (prefers-color-scheme: dark){:root:not([data-theme=light]) .crud-modulo{--crud-text: #e5e7eb;--crud-muted: #9ca3af;--crud-border: #4b5563;--crud-bg: #1f2937;--crud-danger: #f87171}}:root[data-theme=dark] .crud-modulo,:root[data-bs-theme=dark] .crud-modulo{--crud-text: #e5e7eb;--crud-muted: #9ca3af;--crud-border: #4b5563;--crud-bg: #1f2937;--crud-danger: #f87171}.crud-titulo{font-size:1.4rem;margin:0 0 .75rem}.crud-sin-permiso{color:var(--crud-muted);padding:1rem 0}.crud-form{display:flex;flex-direction:column;gap:.75rem}.crud-field{display:flex;flex-direction:column;gap:.25rem}.crud-field label{font-weight:600;font-size:.9rem}.crud-required{color:var(--crud-danger);margin-left:.15rem}.crud-input{width:100%;padding:.4rem .55rem;border:1px solid var(--crud-border);border-radius:.35rem;background:var(--crud-bg);color:var(--crud-text);font:inherit;box-sizing:border-box}.crud-checkbox{width:1.1rem;height:1.1rem}.crud-error{color:var(--crud-danger);font-size:.85rem}.crud-error-general{padding:.5rem .65rem;border:1px solid var(--crud-danger);border-radius:.35rem}
|
|
1
|
+
.crud-modulo{--crud-text: #1f2937;--crud-muted: #6b7280;--crud-border: #d1d5db;--crud-bg: #ffffff;--crud-danger: #b91c1c;color:var(--crud-text);font-family:system-ui,-apple-system,Segoe UI,Roboto,sans-serif}@media (prefers-color-scheme: dark){:root:not([data-theme=light]) .crud-modulo{--crud-text: #e5e7eb;--crud-muted: #9ca3af;--crud-border: #4b5563;--crud-bg: #1f2937;--crud-danger: #f87171}}:root[data-theme=dark] .crud-modulo,:root[data-bs-theme=dark] .crud-modulo{--crud-text: #e5e7eb;--crud-muted: #9ca3af;--crud-border: #4b5563;--crud-bg: #1f2937;--crud-danger: #f87171}.crud-titulo{font-size:1.4rem;margin:0 0 .75rem}.crud-sin-permiso{color:var(--crud-muted);padding:1rem 0}.crud-form{display:flex;flex-direction:column;gap:.75rem}.crud-field{display:flex;flex-direction:column;gap:.25rem}.crud-field label{font-weight:600;font-size:.9rem}.crud-required{color:var(--crud-danger);margin-left:.15rem}.crud-input{width:100%;padding:.4rem .55rem;border:1px solid var(--crud-border);border-radius:.35rem;background:var(--crud-bg);color:var(--crud-text);font:inherit;box-sizing:border-box}.crud-checkbox{width:1.1rem;height:1.1rem}.crud-error{color:var(--crud-danger);font-size:.85rem}.crud-error-general{padding:.5rem .65rem;border:1px solid var(--crud-danger);border-radius:.35rem}.crud-help{color:var(--crud-muted);font-size:.8rem}.crud-checks{display:flex;flex-direction:column;gap:.3rem;padding:.4rem .55rem;border:1px solid var(--crud-border);border-radius:.35rem}.crud-check{font-weight:400;font-size:.9rem;display:flex;align-items:center;gap:.4rem}.crud-markdown{display:flex;flex-direction:column;gap:.25rem}.crud-markdown-barra{display:flex;justify-content:space-between;align-items:center;gap:.5rem}.crud-btn-preview{font-size:.8rem;padding:.15rem .5rem;border:1px solid var(--crud-border);border-radius:.3rem;background:var(--crud-bg);color:var(--crud-text);cursor:pointer}.crud-markdown-preview{padding:.5rem .65rem;border:1px dashed var(--crud-border);border-radius:.35rem;font-size:.9rem;overflow-wrap:anywhere}.crud-markdown-preview h1,.crud-markdown-preview h2,.crud-markdown-preview h3{font-size:1.05rem;margin:.3rem 0}.crud-markdown-preview p{margin:.3rem 0}.crud-markdown-preview code{padding:0 .2rem;border-radius:.2rem;background:var(--crud-border)}
|