Skip to content

Props y eventos ​

Props ​

PropTipoPor defectoDescripción
fieldsSchemaField[]—Obligatoria. Los campos del esquema a los que se pueden asignar columnas.
locale'en' | 'es' | 'fr' | 'pt' | 'nl''en'Idioma de la interfaz.
messagesMessagesOverride—Sobrescribe cadenas sueltas del idioma activo.
iconsIcons—Reemplaza cualquier icono por un componente tuyo.
matcherMatcherFn—Función de auto-match propia. Reemplaza la integrada.
validateRowsRowValidator—Comprueba las filas mapeadas y reporta problemas. Corre después de las comprobaciones de mapeo y bloquea @mapped si devuelve algo.
maxIssuesShownnumber50Cuántos problemas se listan a la vez.
output'rows' | 'mapping''rows'Qué emite @mapped. 'mapping' envía { file, mapping, hasHeaders } para que la lectura la haga tu backend. Ignora transform.
transformTransformFn—Convierte cada fila antes de emitir @mapped. Devuelve null para excluirla.
previewRowsnumber5Cuántas filas de datos se muestran en cada tarjeta.
defaultHasHeadersbooleantrueSi la primera fila se trata como encabezado al cargar y tras reiniciar.
autoIgnorebooleanfalsePone en «ignorar» las columnas sin coincidencia tras el auto-match.
autoConfirmbooleanfalseEmite @mapped de inmediato si todo es válido tras el auto-match, sin mostrar el botón de confirmar.
maxFileSizenumber—Tamaño máximo en bytes. Los archivos mayores se rechazan antes de parsear.
maxRowsnumber—Máximo de filas de datos. Los archivos con más se rechazan tras parsear.
encodingstring—Etiqueta de TextDecoder (por ejemplo 'shift-jis') que fuerza la codificación de archivos de texto. Se detecta sola si se omite; se ignora en .xlsx y .xls.

Eventos ​

EventoPayloadDescripción
@mappedMappedResult[] | MappingOutput | unknown[]Se emite tras una validación correcta. MappedResult[] por defecto, la salida de tu transform si lo pasaste, o un MappingOutput con output="mapping".
@invalidRowIssue[]Se emite en lugar de @mapped cuando validateRows reporta problemas.
@errorSheetMapperErrorSe emite cuando falla el archivo o la validación del mapeo.
@file-pickedFileSe emite en cuanto el usuario elige un archivo, antes de parsearlo.
@columns-loaded{ name: string; assignedKey: string | null }[]Se emite tras parsear, con los nombres detectados y su auto-match inicial.
@reset—Se emite al volver al estado inicial.

Publicado bajo la licencia MIT.