neo-register 1.0.5 → 1.0.6

package/docs/FormItemType.md

@@ -1,6 +1,30 @@
-## 可作为自定义配置项的表单项组件
+# 属性配置项类型汇总
 
-### 1. 基础输入类 / 配置项
+本文档汇总了可作为组件属性配置项的所有表单组件类型，包括 amis 提供的配置项、NeoCRM 平台数据源配置项以及 NeoCRM 自定义表单配置项。
+
+## 目录
+
+- [一、amis 表单组件配置项](#一amis-表单组件配置项)
+  - [1. 基础输入类](#1-基础输入类)
+  - [2. 选择类](#2-选择类)
+  - [3. 特殊输入类](#3-特殊输入类)
+  - [4. 文件上传类（暂不可用）](#4-文件上传类暂不可用)
+  - [5. 富文本编辑类](#5-富文本编辑类)
+  - [6. 布局容器类](#6-布局容器类)
+  - [7. 复合组件类](#7-复合组件类)
+  - [8. 特殊功能类](#8-特殊功能类)
+- [二、NeoCRM 平台数据源配置项](#二neocrm-平台数据源配置项)
+  - [xObjectEntityList - 实体列表数据源](#xobjectentitylist---实体列表数据源)
+  - [xObjectDataApi - 实体业务数据列表数据源](#xobjectdataapi---实体业务数据列表数据源)
+  - [xObjectDetailApi - 实体详情数据源](#xobjectdetailapi---实体详情数据源)
+- [三、NeoCRM 自定义表单配置项](#三neocrm-自定义表单配置项)
+- [使用说明](#使用说明)
+
+---
+
+## 一、amis 表单组件配置项
+
+### 1. 基础输入类
 
 #### 文本输入
 - **text** - 文本输入框
@@ -26,8 +50,9 @@
 - **year** - 年份选择器
 - **date-range** - 日期范围选择器
 - **datetime-range** - 日期时间范围选择器
+- **month-range** - 月份范围选择器
 
-### 2. 选择类 / 配置项
+### 2. 选择类
 
 #### 单选/多选
 - **select** - 下拉选择框
@@ -45,12 +70,12 @@
 
 #### 穿梭框
 - **transfer** - 穿梭框组件
+- **tabs-transfer** - 标签页穿梭框
 
 #### 其他选择
 - **picker** - 选择器
-- **tabs-transfer** - 标签页穿梭框
 
-### 3. 特殊输入类 / 配置项
+### 3. 特殊输入类
 
 #### 开关
 - **switch** - 开关组件
@@ -73,7 +98,7 @@
 #### 位置
 - **location** - 位置选择器 
 
-### 4. 文件上传类 / 配置项 （暂不可用）
+### 4. 文件上传类（暂不可用）
 
 #### 文件上传
 - **file** - 文件上传组件 
@@ -81,7 +106,7 @@
 #### 图片上传
 - **image** - 图片上传组件
 
-### 5. 富文本编辑类 / 配置项
+### 5. 富文本编辑类
 
 #### 编辑器
 - **js-editor** - JavaScript 编辑器
@@ -104,7 +129,7 @@
 #### 标签页
 - **tabs** - 标签页组件
 
-### 7. 复合组件类 / 配置项
+### 7. 复合组件类
 
 #### 组合
 - **combo** - 组合组件
@@ -117,6 +142,9 @@
 #### 表格
 - **table** - 表格组件 
 
+#### 矩阵
+- **matrix** - 矩阵组件
+
 ### 8. 特殊功能类
 
 #### 隐藏字段
@@ -143,23 +171,162 @@
 #### 条件构建器
 - **condition-builder** - 条件构建器 
 
-#### 矩阵
-- **matrix** - 矩阵组件
-
 #### UUID
 - **uuid** - UUID 生成器
 
-#### 月份范围
-- **month-range** - 月份范围选择器 
+---
+
+## 二、NeoCRM 平台数据源配置项
+
+### xObjectEntityList - 实体列表数据源
+
+这是一个简化的对象实体列表选择配置项，采用直接下拉列表配置方式，专门用于选择对象实体。
+
+**功能特性：**
+1. **实体列表展示**：以下拉列表形式展示当前可选择的实体对象
+2. **搜索功能**：支持实体名称搜索
+3. **数据存储**：选择的实体ID存储到 value 中
+4. **实体类型控制**：通过 custom 属性控制使用标准实体还是自定义实体
 
-### 9. NeoCRM 平台数据源相关属性配置
+**使用方法：**
 
-#### 实体相关数据源
-- **xObjectEntityList** - 实体列表数据源 [使用文档](./NeoEntityApiType/xObjectEntityList.md)
-- **xObjectDataApi** - 实体业务数据列表数据源 [使用文档](./NeoEntityApiType/xObjectDataApi.md)
-- **xObjectDetailApi** - 实体详情数据源 [使用文档](./NeoEntityApiType/xObjectDetailApi.md)
+在属性配置面板（propsSchema）中使用：
+
+```json
+{
+  "type": "xObjectEntityList",
+  "name": "xObjectApiKey",
+  "label": "对象实体列表",
+  "custom": false
+}
+```
+
+**组件属性：**
+
+- `name`: 字段名称
+- `label`: 标签文本
+- `disabled`: 是否禁用
+- `custom`: 是否使用自定义实体，设置为 false 则表示展示标准实体列表，不传则展示标准实体和自定义实体
+- `value`: 当前已选择的实体对象ID（xObjectApiKey）
+- `onChange`: 值变化回调
+
+---
+
+### xObjectDataApi - 实体业务数据列表数据源
+
+这是一个用于获取实体业务数据列表的属性配置项。
+
+**功能特性：**
+1. **输入框展示**：以输入框形式展示当前配置的实体和选择的字段信息
+2. **设置按钮**：右侧设置图标，点击打开配置弹窗
+3. **实体类型选择**：弹窗中支持选择标准实体或自定义实体
+4. **实体选择**：弹窗中支持下拉选择实体
+5. **字段选择**：使用 antd Transfer 组件选择字段，默认选中所有实体字段
+6. **分页配置**：配置页码（默认展示第几页）和每页条数（每页展示多少条数据）
+7. **数据存储**：选择的实体ID存储到 `xObjectApiKey`，选中的字段列表存储到 `fields`，字段信息列表存储到 `fieldDescList`，页码存储到 `page`，每页条数存储到 `pageSize`
+
+**使用方法：**
+
+在属性配置面板（propsSchema）中使用：
+
+```json
+{
+  "type": "xObjectDataApi",
+  "name": "dataSource",
+  "label": "数据源配置"
+}
+```
+
+**组件属性：**
+
+- `name`: 字段名称
+- `label`: 标签文本
+- `disabled`: 是否禁用
+- `value`: 当前值，格式为 `{ xObjectApiKey: string, fields: string[], fieldDescList: object[], page: number, pageSize: number }`
+  - `xObjectApiKey`: 选择的实体 API Key
+  - `fields`: 选中的字段列表
+  - `fieldDescList`: 字段信息列表
+  - `page`: 页码，默认为 1（默认展示第几页）
+  - `pageSize`: 每页条数，默认为 20（每页展示多少条数据）
+- `onChange`: 值变化回调
+
+---
+
+### xObjectDetailApi - 实体详情数据源
+
+这是一个用于配置获取实体业务详情数据的属性配置项。
+
+**功能特性：**
+1. **输入框展示**：以输入框形式展示当前配置的实体、业务数据ID和字段信息
+2. **设置按钮**：右侧设置图标，点击打开配置弹窗
+3. **实体选择**：弹窗中支持下拉选择实体（标准实体/自定义实体）
+4. **业务数据ID选择**：根据选择的实体，使用 xObject.query 获取业务数据列表，支持选择具体的业务数据ID
+5. **字段选择**：使用 antd Transfer 组件选择字段，默认全部选中
+6. **数据存储**：选择的实体ID存储到 `xObjectApiKey`，业务数据ID存储到 `objectId`，字段列表存储到 `fieldDescList`
+
+**使用方法：**
+
+在属性配置面板（propsSchema）中使用：
+
+```json
+{
+  "type": "xObjectDetailApi",
+  "name": "dataSource",
+  "label": "业务详情数据源配置"
+}
+```
+
+**组件属性：**
+
+- `name`: 字段名称
+- `label`: 标签文本
+- `disabled`: 是否禁用
+- `value`: 当前值，格式为 `{ xObjectApiKey: string, objectId: string }`
+- `onChange`: 值变化回调
+
+**特性：**
+- **实体类型切换**：支持标准实体和自定义实体的切换
+- **智能联动**：选择实体后自动加载对应的业务数据列表和字段列表
+- **搜索过滤**：所有选择器都支持搜索过滤功能
+
+---
+
+## 三、NeoCRM 自定义表单配置项
+
+### 表单输入组件
+以下组件均可作为属性配置项使用：
+
+- **neoInput** - Input 输入框
+- **neoInputNumber** - InputNumber 数字输入框
+- **neoInputTree** - InputTree 树形输入框
+- **neoSearch** - Search 搜索框
+- **neo_select** - Select 选择器
+- **neoCustomSelect** - CustomSelect 自定义选择器
+- **neoTreeSelect** - TreeSelect 树形选择器
+- **neoCascader** - Cascader 级联选择器
+- **neoAutoComplete** - AutoComplete 自动完成
+- **neoMentions** - Mentions 提及
+- **neoDatePicker** - DatePicker 日期选择器
+- **neoTimePicker** - TimePicker 时间选择器
+- **neoSwitch** - Switch 开关
+- **neoRadio** - Radio 单选框
+- **neoCheckbox** - Checkbox 复选框
+- **neoCheckboxGroup** - CheckboxGroup 复选框组
+- **neoRate** - Rate 评分
+- **neoSlider** - Slider 滑动输入条
+- **neoUpload** - Upload 上传
+- **neoRichText** - RichText 富文本编辑器
+- **neoEditor** - Editor 编辑器
+
+---
 
 ## 使用说明
 
-- 以上表单项为 amis 表单项（基于amis 1.1.5私有化版本）
+### amis 表单项
+- 以上 amis 表单项基于 amis 1.1.5 私有化版本
 - 相关表单项使用说明请见 [amis 使用文档](https://aisuda.bce.baidu.com/amis/zh-CN/components/form/index)
+
+### NeoCRM 表单组件
+- NeoCRM 自定义表单组件是在平台中注册的增强型表单组件
+- 这些组件在 amis 基础上提供了更贴合 NeoCRM 业务场景的功能
+

package/docs/NeoCmps.md

@@ -0,0 +1,100 @@
+# NeoCRM 组件类型汇总
+本文档汇总了 NeoCRM 平台中注册的组件类型，按功能分类整理。
+
+## 表单输入组件: 可作为属性配置项
+- **neoInput** - Input 输入框
+- **neoInputNumber** - InputNumber 数字输入框
+- **neoInputTree** - InputTree 树形输入框
+- **neoSearch** - Search 搜索框
+- **neo_select** - Select 选择器
+- **neoCustomSelect** - CustomSelect 自定义选择器
+- **neoTreeSelect** - TreeSelect 树形选择器
+- **neoCascader** - Cascader 级联选择器
+- **neoAutoComplete** - AutoComplete 自动完成
+- **neoMentions** - Mentions 提及
+- **neoDatePicker** - DatePicker 日期选择器
+- **neoTimePicker** - TimePicker 时间选择器
+- **neoSwitch** - Switch 开关
+- **neoRadio** - Radio 单选框
+- **neoCheckbox** - Checkbox 复选框
+- **neoCheckboxGroup** - CheckboxGroup 复选框组
+- **neoRate** - Rate 评分
+- **neoSlider** - Slider 滑动输入条
+- **neoUpload** - Upload 上传
+- **neoRichText** - RichText 富文本编辑器
+- **neoEditor** - Editor 编辑器
+
+## 数据展示组件
+- **neoTable** - Table 表格
+- **neoTree** - Tree 树形控件
+- **neoTreeGrid** - TreeGrid 树形表格
+- **neoList** - List 列表
+- **neoDescriptions** - Descriptions 描述列表
+- **neoStatistic** - Statistic 统计数值
+- **neoCountdown** - Countdown 倒计时
+- **neoProgress** - Progress 进度条
+- **neoSkeleton** - Skeleton 骨架屏
+- **neoEmpty** - Empty 空状态
+- **neoResult** - Result 结果页
+- **neoAlert** - Alert 警告提示
+- **neoBadge** - Badge 徽标数
+- **neoTag** - Tag 标签
+- **neoAvatar** - Avatar 头像
+- **neoAvatarGroup** - AvatarGroup 头像组
+- **neoImage** - Image 图片
+- **neoIconView** - IconView 图标视图
+- **neoTimeline** - Timeline 时间轴
+- **neoSteps** - Steps 步骤条
+- **neoCarousel** - Carousel 走马灯
+- **neoCalendar** - Calendar 日历
+- **neoCollapse** - Collapse 折叠面板
+- **neoCard** - Card 卡片
+- **neoSpace** - Space 间距
+- **neoDivider** - Divider 分割线
+- **neoBreadcrumb** - Breadcrumb 面包屑
+- **neoBackTop** - BackTop 回到顶部
+- **neoAnchor** - Anchor 锚点
+
+## 导航组件
+- **neoMenu** - Menu 导航菜单
+- **menuIcon** - MenuIcon 菜单图标
+- **menuButton** - MenuButton 菜单按钮
+- **neoTabs** - Tabs 标签页
+- **neoPagination** - Pagination 分页
+- **neoPageHeader** - PageHeader 页头
+
+## 反馈组件
+- **neoModal** - Modal 对话框
+- **neoMessage** - Message 全局提示
+- **neoNotification** - Notification 通知提醒框
+- **neoPopover** - Popover 气泡卡片
+- **neoPopconfirm** - Popconfirm 气泡确认框
+- **neoTooltip** - Tooltip 文字提示
+- **neoSpin** - Spin 加载中
+- **neoDropdown** - Dropdown 下拉菜单
+
+## 布局组件
+- **neoLayout** - Layout 布局
+- **neoContainer** - Container 容器
+- **neoGrid** - Grid 栅格
+- **neoFeatrueTip** - FeatrueTip 功能提示
+
+## 业务组件
+- **NeoPage** - NeoPage 页面组件
+- **NeoGrid** - NeoGrid 网格组件
+- **NeoGridNew** - NeoGridNew 新版网格组件
+- **neoGridEditing** - GridEditing 网格编辑
+- **neoPopCheck** - PopCheck 弹出选择
+- **CustomNameField** - CustomNameField 自定义名称字段
+- **neoBulkEditDialog** - BulkEditDialog 批量编辑对话框
+- **neoSelector** - Selector 选择器
+- **neoMap** - Map 地图
+- **neoIframe** - Iframe 内嵌框架
+- **neoTransfer** - Transfer 穿梭框
+- **neoLayoutError** - LayoutError 布局错误
+
+## 其他组件
+- **neoButton** - Button 按钮
+- **neoCustomMessage** - CustomMessage 自定义消息
+- **neoActionSheet** - ActionSheet 动作面板
+- **neoAffix** - Affix 固钉

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo-register",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "neo自定义组件注册器（支持 react 和 vue2.0 技术栈），主要用于注册 neo 自定义组件、neo-editor 自定义组件模型。",
   "keywords": [
     "neo自定义组件注册器",

package/dist/demo2/entity-detail/index.d.ts

@@ -1,40 +0,0 @@
-import * as React from 'react';
-import './style.scss';
-interface EntityDetailProps {
-    title?: string;
-    xObjectDetailApi?: {
-        xObjectApiKey: string;
-        objectId: string;
-        fieldDescList?: any[];
-    };
-    columnCount?: number;
-    showTitle?: boolean;
-    data?: any;
-    entityData?: any;
-}
-interface FieldDescription {
-    apiKey: string;
-    label: string;
-    type: string;
-    [key: string]: any;
-}
-interface EntityDetailState {
-    detailData: any;
-    fieldDescriptions: FieldDescription[];
-    loading: boolean;
-    error: string | null;
-}
-export default class EntityDetail extends React.PureComponent<EntityDetailProps, EntityDetailState> {
-    constructor(props: EntityDetailProps);
-    componentDidMount(): void;
-    componentDidUpdate(prevProps: EntityDetailProps): void;
-    loadData(): Promise<void>;
-    loadFieldDescriptions(): Promise<void>;
-    loadEntityDetail(): Promise<void>;
-    getFieldLabel(apiKey: string): string;
-    getFieldType(apiKey: string): string;
-    renderFieldValue(value: any, fieldType: string): any;
-    renderDetailContent(): React.JSX.Element;
-    render(): React.JSX.Element;
-}
-export {};

package/dist/demo2/entity-detail/model.d.ts

@@ -1,77 +0,0 @@
-/**
- * @file 实体数据详情组件对接编辑器的描述文件
- * @description 定义组件在 Neo 平台编辑器中的配置信息
- */
-export declare class EntityDetailModel {
-    /**
-     * 组件类型标识
-     * 用于标识组件的唯一性，在构建时根据当前组件目录名称自动生成
-     * 注意：此字段在构建时会被自动替换，不需要手动设置
-     */
-    cmpType: string;
-    /** 组件名称，用于设置在编辑器左侧组件面板中展示的名称 */
-    label: string;
-    /** 组件描述，用于设置在编辑器左侧组件面板中展示的描述 */
-    description: string;
-    /** 分类标签，用于设置在编辑器左侧组件面板哪个分类中展示（可设置多个分类标签） */
-    tags: string[];
-    /** 组件图标，用于设置在编辑器左侧组件面板中展示的图标 */
-    iconSrc: string;
-    /** 初次插入页面的默认属性数据 */
-    defaultComProps: {
-        title: string;
-        xObjectDetailApi: {
-            xObjectApiKey: string;
-            objectId: string;
-        };
-        columnCount: number;
-        showTitle: boolean;
-    };
-    /** 设计器端预览时展示的默认数据 */
-    previewComProps: {
-        title: string;
-        columnCount: number;
-        showTitle: boolean;
-    };
-    /**
-     * 组件属性配置模式
-     * 定义组件在编辑器中可配置的属性
-     */
-    propsSchema: ({
-        type: string;
-        name: string;
-        label: string;
-        value: string;
-        placeholder: string;
-        description: string;
-        options?: undefined;
-    } | {
-        type: string;
-        name: string;
-        label: string;
-        value: boolean;
-        description: string;
-        placeholder?: undefined;
-        options?: undefined;
-    } | {
-        type: string;
-        name: string;
-        label: string;
-        value?: undefined;
-        placeholder?: undefined;
-        description?: undefined;
-        options?: undefined;
-    } | {
-        type: string;
-        name: string;
-        label: string;
-        value: number;
-        options: {
-            label: string;
-            value: number;
-        }[];
-        description: string;
-        placeholder?: undefined;
-    })[];
-}
-export default EntityDetailModel;

package/dist/demo2/entity-detail/register.d.ts

@@ -1 +0,0 @@
-export {};

package/docs/NeoEntityApiType/xObjectDataApi.md

@@ -1,35 +0,0 @@
-# xObjectDataApi 实体数据源属性配置组件
-这是一个用于获取实体业务数据列表的属性配置项，支持：
-
-1. **输入框展示**：以输入框形式展示当前配置的实体和选择的字段信息
-2. **设置按钮**：右侧设置图标，点击打开配置弹窗
-3. **实体类型选择**：弹窗中支持选择标准实体或自定义实体
-4. **实体选择**：弹窗中支持下拉选择实体
-5. **字段选择**：使用 antd Transfer 组件选择字段，默认选中所有实体字段
-6. **分页配置**：配置页码（默认展示第几页）和每页条数（每页展示多少条数据）
-7. **数据存储**：选择的实体ID存储到 `xObjectApiKey`，选中的字段列表存储到 `fields`，字段信息列表存储到 `fieldDescList`，页码存储到 `page`，每页条数存储到 `pageSize`
-
-## 使用方法
-
-在 属性配置面板（propsSchema）中使用：
-
-```json
-{
-  "type": "xObjectDataApi",
-  "name": "dataSource",
-  "label": "数据源配置"
-}
-```
-
-## 组件属性
-
-- `name`: 字段名称
-- `label`: 标签文本
-- `disabled`: 是否禁用
-- `value`: 当前值，格式为 `{ xObjectApiKey: string, fields: string[], fieldDescList: object[], page: number, pageSize: number }`
-  - `xObjectApiKey`: 选择的实体 API Key
-  - `fields`: 选中的字段列表
-  - `fieldDescList`: 字段信息列表
-  - `page`: 页码，默认为 1（默认展示第几页）
-  - `pageSize`: 每页条数，默认为 20（每页展示多少条数据）
-- `onChange`: 值变化回调

package/docs/NeoEntityApiType/xObjectDetailApi.md

@@ -1,35 +0,0 @@
-# xObjectDetailApi 实体业务详情数据配置组件
-这是一个用于配置获取实体业务详情数据的属性配置项，支持：
-
-1. **输入框展示**：以输入框形式展示当前配置的实体、业务数据ID和字段信息
-2. **设置按钮**：右侧设置图标，点击打开配置弹窗
-3. **实体选择**：弹窗中支持下拉选择实体（标准实体/自定义实体）
-4. **业务数据ID选择**：根据选择的实体，使用 xObject.query 获取业务数据列表，支持选择具体的业务数据ID
-5. **字段选择**：使用 antd Transfer 组件选择字段，默认全部选中
-6. **数据存储**：选择的实体ID存储到 `xObjectApiKey`，业务数据ID存储到 `objectId`，字段列表存储到 `fieldDescList`
-
-## 使用方法
-
-在 属性配置面板（propsSchema）中使用：
-
-```json
-{
-  "type": "xObjectDetailApi",
-  "name": "dataSource",
-  "label": "业务详情数据源配置"
-}
-```
-
-## 组件属性
-
-- `name`: 字段名称
-- `label`: 标签文本
-- `disabled`: 是否禁用
-- `value`: 当前值，格式为 `{ xObjectApiKey: string, objectId: string }`
-- `onChange`: 值变化回调
-
-## 功能特性
-
-- **实体类型切换**：支持标准实体和自定义实体的切换
-- **智能联动**：选择实体后自动加载对应的业务数据列表和字段列表
-- **搜索过滤**：所有选择器都支持搜索过滤功能

package/docs/NeoEntityApiType/xObjectEntityList.md

@@ -1,35 +0,0 @@
-# xObjectEntityList 对象实体列表选择配置组件
-这是一个简化的对象实体列表选择配置项，采用直接下拉列表配置方式，专门用于选择对象实体，支持：
-
-1. **实体列表展示**：以下拉列表形式展示当前可选择的实体对象
-2. **搜索功能**：支持实体名称搜索
-3. **数据存储**：选择的实体ID存储到 value 中
-4. **实体类型控制**：通过 custom 属性控制使用标准实体还是自定义实体
-
-## 使用方法
-
-在 属性配置面板（propsSchema） 中使用：
-
-```json
-{
-  "type": "xObjectEntityList",
-  "name": "xObjectApiKey",
-  "label": "对象实体列表",
-  "custom": false
-}
-```
-
-## 组件属性
-
-- `name`: 字段名称
-- `label`: 标签文本
-- `disabled`: 是否禁用
-- `custom`: 是否使用自定义实体，设置为 false 则表示展示标准实体列表，不传则展示标准实体和自定义实体
-- `value`: 当前已选择的实体对象ID（xObjectApiKey）
-- `onChange`: 值变化回调
-
-## 功能特性
-
-- **实体类型控制**：通过 custom 属性控制实体类型，无需用户手动切换
-- **搜索过滤**：支持按实体名称进行搜索过滤
-- **加载状态**：显示数据加载状态