@getnuvo/importer-angular

中文文档
3.6.3发布于 2025/12/08TypeScriptES Module近 30 天下载 3168

Angular nuvo importer adapter

原始使用文档
文档目录15 节
  1. Features
  2. Getting Started
  3. Installation
  4. Basic Implementation
  5. Advanced Configuration
  6. Settings & Configuration
  7. Target Data Model (TDM)
  8. Cleaning & Data Handler Functions
  9. Dynamic Import
  10. Styling and Theming
  11. Multi-language Support
  12. Handling Results
  13. Release Notes
  14. Learn More
  15. Support

nuvo logo

@getnuvo/importer-angular

npm latest package API status

[!NOTE] The @getnuvo/importer-angular package is the successor to our previous nuvo-angular package. While you can continue using versions 2.x of nuvo-angular, we recommend migrating to @getnuvo/importer-angular version 3.x to take advantage of the latest features and improvements.

nuvo Data Importer Angular SDK

nuvo leverages AI to simplify importing complex and unstructured files into your application.

Integrate the nuvo Data Importer to offer your customers an intuitive and efficient data import experience.

Features

  • AI-Powered Column and Option Mapping: Automatically matches imported data columns to your system's target data model, streamlining the import process.
  • Customizable Cleaning Functions: Implement custom logic to validate and transform data during the import workflow.
  • Support for Multiple File Formats: Handles various file types, including CSV, TSV, XLS, XLSX, JSON, XML, and PDF.
  • Dynamic Import Capabilities: Initiate the import process from any step, accommodating diverse data sources and workflows.
  • Styling and Theming: Easily adjust the importer's appearance to align with your application's design.
  • Multi-language Support: Customize and localize interface text to cater to a global user base.
  • Wide Angular Version Support: Compatible with Angular 12 through Angular 21, including support for zoneless change detection.

Getting Started

Ensure you have signed up on our User Platform and have access to your nuvo license key.

Installation

Add nuvo to your project:

npm:

npm install @getnuvo/importer-angular

yarn:

yarn add @getnuvo/importer-angular

Basic Implementation

Below is a basic example of integrating the NuvoImporter component into your Angular application:

Add the NuvoImporter module to module file

import { NuvoImporterModule } from '@getnuvo/importer-angular';

@NgModule({
  declarations: [AppComponent],
  imports: [NuvoImporterModule, BrowserModule, AppRoutingModule],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

Add the nuvo component in the HTML file.

<nuvo-importer
  [licenseKey]="licenseKey"
  [settings]="settings"
  [onResults]="onResults.bind(this)"
/>

Define the property in the component file.

export class AppComponent implements OnInit {
  settings!: SettingsAPI;
  licenseKey!: string;

  ngOnInit(): void {
    this.licenseKey = 'Your License Key';
    this.settings = {
      identifier: 'product_data',
      columns: [
        {
          label: 'Product ID',
          key: 'product_id',
        },
        {
          label: 'Article Name',
          key: 'article_name',
        },
      ],
    };
  }

  onResults(results, errors, complete, logs) {
    console.log('Imported Data:', results);
    console.log('Errors:', errors);
    console.log('Import Logs:', logs);
    complete(); // Finalize the import process
  }
}

In this example:

  • licenseKey: Your unique nuvo license key.
  • settings: Configuration object for the importer.
  • identifier: A unique string to identify the import instance.
  • columns: Defines the target data model (TDM) with label and key for each column.
  • onResults: Callback function that handles the imported data results.

For a comprehensive guide on setting up and customizing the importer, refer to the First Steps documentation.

Advanced Configuration

Settings & Configuration

The settings property allows you to tailor the importer's behavior and appearance. Key configurable options include:

  • inputTypes: Specify supported file types (e.g., ['csv', 'xls', 'json']).
  • modal: Determine whether the importer operates within a modal (true) or inline (false).

For a detailed list of configuration options, visit the Settings & Configuration page.

Target Data Model (TDM)

Define the structure of the data you expect using the columns array within the settings. Each column can include:

  • label: User-friendly name displayed in the UI.
  • key: Technical identifier for the column.
  • description: Additional information about the column.
  • alternativeMatches: Array of synonyms or abbreviations to assist the mapping algorithm.
  • validations: Rules such as required fields, uniqueness, regex patterns, and cross-column dependencies.

Learn more about defining your TDM in the Columns / Target Data Model documentation.

Cleaning & Data Handler Functions

Implement custom cleaning & data handler functions (callback functions) to transform and validate data during the import process. These functions can correct date formats, enrich entries, compare imported data against external databases, and more.

Explore the capabilities of these functions in the Cleaning Functions & Data Handler docs.

Dynamic Import

The dynamic import feature allows you to start the import process from any step and with various data formats. This flexibility enables integration with different workflows and data sources.

For implementation details, refer to the Dynamic Import documentation.

Styling and Theming

Customize the appearance of the nuvo importer to match your application's design. Modify themes, adjust display modes, and enable or disable specific features to create a seamless user experience.

Learn more about styling options in the Styling section.

Multi-language Support

The i18nOverrides and language feature allow you to customize and localize the application's default language keys, ensuring the importer aligns with your users' language preferences.

For more information on localization, visit the Multi-language Support & Language page.

Handling Results

The onResults callback function provides access to the cleaned data, allowing you to define how to process and store it.

Detailed information on handling results can be found in the Result (Output) documentation.

Release Notes

Stay updated with the latest features, improvements, and bug fixes by reviewing our Release Notes.

Learn More

Explore how to get the most out of nuvo with real examples and detailed guides:

  • Try it live on CodeSandbox – test and tweak the importer in action.
  • Visit our Knowledge Base for deep dives into settings, data models, cleaning functions, and more.

Support

If you have any questions or need assistance, please refer to our FAQ or contact our support team at [email protected].

版本与发布记录

@getnuvo/importer-angular 共发布 17 个版本,首次发布于 2025/04/22;过去 12 个月发布了 3 个版本。

版本发布日期距今
3.6.3latest2025/12/0811 个月前
3.6.22025/12/0811 个月前
3.6.02025/11/1811 个月前
3.5.62025/11/141 年前
3.5.52025/11/031 年前
3.5.42025/10/291 年前

关于 @getnuvo/importer-angular 的常见问题

@getnuvo/importer-angular 是什么?

Angular nuvo importer adapter

如何安装 @getnuvo/importer-angular?

在项目目录运行 npm install @getnuvo/importer-angular,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@angular/common(^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0)、@angular/core(^12.0.0 || ^13.0.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^20.0.0 || ^21.0.0)、@emotion/css(^11.10.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@getnuvo/importer-angular 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@getnuvo/importer-angular 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@getnuvo/importer-angular 可以商用吗?

@getnuvo/importer-angular 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@getnuvo/importer-angular 的下载量有多少?

根据 npm 官方下载统计,@getnuvo/importer-angular 在 2026/10/17 – 2026/11/15 这 30 天内被下载 3,168 次,日均约 106 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getnuvo/importer-angular 还在维护吗?

最新版本 3.6.3 发布于 2025/12/08(11 个月前);至今共发布 17 个版本,其中过去 12 个月发布了 3 个;首次发布于 2025/04/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。