# @bigbinary/neeto-crm-frontend 中文文档

规范地址：https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/

版本：3\.0\.10
npm 元数据更新时间：2026-10-05T12:45:39.434Z
中文译文更新时间：2026-11-08T02:23:12.646Z
软件包许可：UNLICENSED

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bigbinary/neeto-crm-frontend
原文对照：https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/?lang=original
项目主页：https://github.com/bigbinary/neeto-crm-nano

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：693 kB，63 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13
- 运行依赖：3 个
- peer 依赖：qs 6\.15\.2，url 0\.11\.4，yup 0\.32\.11，antd 5\.22\.1，util ^0\.12\.5，axios 1\.18\.1，ramda 0\.29\.0，react 18\.3\.1，buffer ^6\.0\.3，formik 2\.4\.6，i18next 22\.5\.1，zustand 4\.4\.2，dompurify 3\.4\.12，js-logger 1\.6\.1，react-dom 18\.3\.1，classnames 2\.5\.1，stream-http 3\.2\.0，tailwindcss 3\.4\.14，react-helmet ^6\.1\.0，react-select 5\.6\.0，os-browserify 0\.3\.0，react-i18next 12\.3\.1，vm-browserify 1\.1\.2，@babel/runtime 7\.29\.7，react-toastify 8\.0\.2，tty-browserify 0\.0\.1，path-browserify ^1\.0\.1，https-browserify 1\.0\.0，mixpanel-browser ^2\.45\.0，react-router-dom 5\.3\.3，crypto-browserify 3\.12\.1，source-map-loader 4\.0\.1，stream-browserify ^3\.0\.0，@bigbinary/neetoui 8\.8\.3，@honeybadger-io/js 6\.10\.1，@bigbinary/neeto-cist 1\.0\.17，@honeybadger-io/react 6\.1\.25，@tanstack/react-query 5\.59\.20，@bigbinary/neeto-atoms 1\.0\.144，@bigbinary/neeto-icons 1\.20\.89，@bigbinary/neeto-molecules 5\.5\.2，@tanstack/react-query-devtools 5\.59\.20，@bigbinary/neeto-commons-frontend 4\.13\.160，@bigbinary/neeto-filters-frontend 4\.3\.45，@bigbinary/neeto-integrations-frontend 4\.0\.49
- 首次发布：2025-09-02T07:41:04.638Z
- 最新版本发布：2026-10-05T12:45:39.210Z
- 近 30 天下载量：4248（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 15 个）

## 中文简介

一个回波作为新纳米结构,配置,数据等的真理来源.

## 安装

```sh
npm install @bigbinary/neeto-crm-frontend
```

也可以使用：`pnpm add @bigbinary/neeto-crm-frontend`、`yarn add @bigbinary/neeto-crm-frontend`、`bun add @bigbinary/neeto-crm-frontend`

## README

# 需要 -crm -nano (英语)

这个 `neeto-crm-nano` 促进NeetoCRM与neto产品相融合. 它输出 `@bigbinary/neeto-crm-frontend` 国家防范机制一揽子计划 `neeto-crm-engine` 铁路发展引擎.

## 目录

-   [需要 -crm -nano (英语)](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-neeto-crm-nano)
    -   [目录](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-contents)
    -   [用主机应用程序开发](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-development-with-host-application)
        -   [发动机](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-engine)
            -   [安装](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-installation)
        -   [前端软件包](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-frontend-package)
            -   [安装](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-installation-1)
            -   [发展指示](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-instructions-for-development)
            -   [构成部分](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-components)
                -   [一体化](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-integrations)
    -   [出版指令](https://npmcn.com/package/%40bigbinary/neeto-crm-frontend/#readme-instructions-for-publishing)

## 用主机应用程序开发

### 发动机

该引擎用于管理所有neto产品的CRM功能.

#### 安装

1.  创建一个 `config/neeto_crm_engine.yml` 并添加所需的输入字段。 此文件被初始化器加载以配置 CRM 格式 。 您可以根据要求编辑字段.
    
    示例
    
    ```yml
    input_fields:
      - value: "email"
        required: true
        allowed_kinds: ["email", "additional_guests"]
      - value: "phone_number"
        required: false
        allowed_kinds: ["phone"]
      - value: "company_name"
        required: false
        allowed_kinds: ["name", "text"]
    ```
    
2.  将此行添加到您的应用程序 `Gemfile`数字 :
    
    ```ruby
    source "NEETO_GEM_SERVER_URL" do
      # ..existing gems
    
      gem 'neeto-crm-engine'
    
      # Use this for live development:
      # gem 'neeto-crm-engine', path: "../neeto-crm-nano"
    end
    ```
    
3.  然后执行:
    
    ```bash
    bundle install
    ```
    
4.  将此行添加到您的应用程序 `config/routes.rb` 文件 :
    
    ```ruby
    mount NeetoCrmEngine::Engine, at: "/neeto_crm"
    ```
    
5.  运行以下命令将引擎的迁移复制到主机应用程序:
    
    ```bash
    bundle exec rails neeto_crm_engine:install:migrations
    ```
    
6.  添加迁移到数据库 :
    
    ```bash
    bundle exec rails db:migrate
    ```
    
7.  运行初始化生成器创建初始化文件 :
    
    ```bash
    bundle exec rails g neeto_crm_engine:initializer
    ```
    
8.  在生成中 `config/initializers/neeto_crm_engine.rb` 文件,请指定 `owner_class` 财务报告和审定财务报表 `owner_foreign_key` neeto客户关系管理整合应附在其上.
    
    ```ruby
    NeetoCrmEngine.owner_class = "User" # Replace with your owner class
    NeetoCrmEngine.owner_foreign_key = "user_id" # Replace with your foreign key
    ```
    

### 前端软件包

#### 安装

1.  安装最新的 `neeto-crm-frontend` 使用下列命令的软件包:
    
    ```bash
    yarn add @bigbinary/neeto-crm-frontend
    ```
    

#### 发展指示

检查 [前端软件包开发指南](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) 用于开发前端软件包的分步指令.

#### 构成部分

##### 一体化

这个组件是客户关系管理系统UI的主要切入点. 它处理内部的路由,并根据所提供的配置提出适当的观点.

**道具**

-   `integrationConfig` (对象):组件的配置对象,结构如下: 1
    -   `resource` (对象):包含与客户关系管理所附资源相关的数据.
        -   `id` (字符串):资源标识.
        -   `data` (阵列):指资源的数据.
        -   `processedData` (阵列): 这是指应当被映射到客户关系管理领域的记录/问题.
        -   `invalidateResource` (函数):用于调试或使资源数据失效的函数.
    -   `navigation` (对象):包含导航元素的配置.
        -   `breadcrumbs` (阵列):面包屑物体阵列(`{ text: string; path?: string; }`) (中文(简体) ).
        -   `basePath` (字符串):CRM路线的基础路径(如, `"/crm"`) (中文(简体) ).
    -   `help` (对象):包含帮助文档的URL.
        -   `docUrl` (字符串):文档页面的URL.
        -   `walkthroughVideoUrl` (字符串):用于行走视频的URL.

**使用量**

```jsx
import React from "react";

import { Integrations } from "@bigbinary/neeto-crm-frontend";
import { BrowserRouter, Route, Switch } from "react-router-dom";
import { ToastContainer } from "react-toastify";

const Main = () => {
  const integrationConfig = {
    resource: {
      id: "123",
      data: [],
      processedData: [],
      invalidateResource: () => console.log("Invalidating resource..."),
    },
    navigation: {
      breadcrumbs: [
        { text: "Settings", path: "/settings" },
        { text: "CRM" },
      ],
      basePath: "/crm",
    },
    help: {
      docUrl: "https://help.example.com/crm",
      walkthroughVideoUrl: "https://videos.example.com/crm-walkthrough",
    },
  };

  return (
    <BrowserRouter>
      <Switch>
        <Route
          path="/crm"
          render={() => <Integrations integrationConfig={integrationConfig} />}
        />
      </Switch>
      <ToastContainer />
    </BrowserRouter>
  );
};

export default Main;
```

## 出版指令

咨询 [构建和释放软件包](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) 关于如何出版的详细指南.

## 常见问题

### @bigbinary/neeto-crm-frontend 是什么？

一个回波作为新纳米结构,配置,数据等的真理来源\.

### 如何安装 @bigbinary/neeto-crm-frontend？

在项目目录运行 npm install @bigbinary/neeto-crm-frontend，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：qs（6\.15\.2）、url（0\.11\.4）、yup（0\.32\.11）、antd（5\.22\.1）、util（^0\.12\.5）、axios（1\.18\.1）、ramda（0\.29\.0）、react（18\.3\.1）、buffer（^6\.0\.3）、formik（2\.4\.6）、i18next（22\.5\.1）、zustand（4\.4\.2）、dompurify（3\.4\.12）、js-logger（1\.6\.1）、react-dom（18\.3\.1）、classnames（2\.5\.1）、stream-http（3\.2\.0）、tailwindcss（3\.4\.14）、react-helmet（^6\.1\.0）、react-select（5\.6\.0）、os-browserify（0\.3\.0）、react-i18next（12\.3\.1）、vm-browserify（1\.1\.2）、@babel/runtime（7\.29\.7）、react-toastify（8\.0\.2）、tty-browserify（0\.0\.1）、path-browserify（^1\.0\.1）、https-browserify（1\.0\.0）、mixpanel-browser（^2\.45\.0）、react-router-dom（5\.3\.3）、crypto-browserify（3\.12\.1）、source-map-loader（4\.0\.1）、stream-browserify（^3\.0\.0）、@bigbinary/neetoui（8\.8\.3）、@honeybadger-io/js（6\.10\.1）、@bigbinary/neeto-cist（1\.0\.17）、@honeybadger-io/react（6\.1\.25）、@tanstack/react-query（5\.59\.20）、@bigbinary/neeto-atoms（1\.0\.144）、@bigbinary/neeto-icons（1\.20\.89）、@bigbinary/neeto-molecules（5\.5\.2）、@tanstack/react-query-devtools（5\.59\.20）、@bigbinary/neeto-commons-frontend（4\.13\.160）、@bigbinary/neeto-filters-frontend（4\.3\.45）、@bigbinary/neeto-integrations-frontend（4\.0\.49）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bigbinary/neeto-crm-frontend 支持 TypeScript 吗？

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

### @bigbinary/neeto-crm-frontend 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bigbinary/neeto-crm-frontend 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.13。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bigbinary/neeto-crm-frontend 可以商用吗？

@bigbinary/neeto-crm-frontend 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @bigbinary/neeto-crm-frontend 的下载量有多少？

根据 npm 官方下载统计，@bigbinary/neeto-crm-frontend 在 2026/10/08 – 2026/11/06 这 30 天内被下载 4,248 次，日均约 142 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bigbinary/neeto-crm-frontend 还在维护吗？

最新版本 3\.0\.10 发布于 2026/10/05（1 个月前）；至今共发布 24 个版本，其中过去 12 个月发布了 15 个；首次发布于 2025/09/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

