Skip to content

Exported API

ExportKindDescription
SheetMapperComponentMain component
useSheetMapperComposableHeadless logic
VueSheetMapperPluginPluginFor app.use() global registration
autoMatchFunctionDefault auto-match algorithm
toRowsFunctionConvert MappedResult[] to row objects
parseFileFunctionParse an Excel/CSV File into ParsedColumn[]
getMessagesFunctionResolve locale strings with optional overrides
IconUploadComponentDefault upload icon
IconFileComponentDefault file icon
IconCheckComponentDefault check/confirm icon
IconBanComponentDefault ignore icon
IconAlertComponentDefault unassigned icon
IconSpinnerComponentDefault spinner icon
SchemaFieldTypeField definition
UseSheetMapperOptionsTypeOptions for useSheetMapper
UseSheetMapperReturnTypeReturn object from useSheetMapper
MappedResultTypeOutput entry per mapped column
MappingOutputType@mapped payload when output="mapping"
ParsedColumnTypeRaw column from the parsed file
ColumnStateTypeUI state per column card
SheetMapperErrorTypeError object
SheetMapperErrorCodeTypeError code union
MessagesTypeFull i18n messages object
MessagesOverrideTypeDeep-partial i18n overrides
LocaleType'en' | 'es' | 'fr' | 'pt' | 'nl'
IconsTypeIcon override map
MatcherFnTypeCustom matcher function signature
RowValidatorTypeData validation hook signature
RowIssueTypeOne problem reported by a RowValidator
TransformFnTypeRow transform function signature

Released under the MIT License.