antd-management-fast-framework 2.11.178 → 2.11.179

package/es/framework/Common/InternalLayout/index.d.ts

@@ -1,13 +1,52 @@
+/**
+ * 构建布局相关。
+ * @namespace Common
+ * @class InternalLayout
+ * @extends InternalBuild
+ */
 export class InternalLayout extends InternalBuild {
-    renderPresetSiderTopArea: () => React.JSX.Element | null;
-    renderPresetSiderBottomArea: () => React.JSX.Element | null;
+    /**
+     * 渲染预设侧边栏上部。
+     * @function
+     */
+    renderPresetSiderTopArea: () => Object | null;
+    /**
+     * 渲染预设侧边栏下部。
+     * @function
+     */
+    renderPresetSiderBottomArea: () => Object | null;
+    /**
+     * 渲染预设内容区域，默认为空逻辑，可根据需要重载。
+     * @function
+     * @example
+     * renderPresetContentArea = () => {}
+     */
     renderPresetContentArea: () => null;
+    /**
+     * 渲染预设页面 Body 内容区域。
+     * @function
+     */
     renderPresetPageBodyContent: () => React.JSX.Element | null;
+    /**
+     * 渲染预设页面左侧内容区域。
+     * @function
+     */
     renderPresetPageLeftArea: () => null;
+    /**
+     * 渲染预设页面 Body 区域。
+     * @function
+     */
     renderPresetPageBody: () => React.JSX.Element;
+    /**
+     * 渲染预设页面 Footer 区域。
+     * @function
+     */
     renderPresetPageFooter: () => null;
+    /**
+     * 渲染预设悬浮按钮。
+     * @function
+     */
     renderPresetFloatButton: () => React.JSX.Element;
-    renderFurther(): React.JSX.Element;
 }
 import { InternalBuild } from '../InternalBuild';
 import React from 'react';

package/es/framework/Common/InternalSwitchoverFlow/index.d.ts

@@ -1,21 +1,102 @@
+/**
+ * 构建可切换相关。
+ * @namespace Common
+ * @class InternalSwitchoverFlow
+ * @extends InternalFlow
+ */
 export class InternalSwitchoverFlow extends InternalFlow {
+    /**
+     * 构造函数
+     * @param {Object} properties
+     */
+    constructor(properties: Object);
+    /**
+     * path 路径前缀。
+     * @member {string}
+     */
     pathPrefix: string;
+    /**
+     * Tab 页集合。
+     * @member {Array}
+     */
     tabList: any[];
+    /**
+     * Menu 页集合。
+     * @member {Array}
+     */
     menuList: any[];
-    adjustMenuListAvailable: (menuListAvailable: any) => any;
-    getMenuListAvailable: () => any;
+    /**
+     * 调整可用 Menu 页集合，默认为空逻辑，可根据需要重载。
+     * @function
+     * @param {Array} menuList 将要调整的 Menu 页集合
+     * @returns {Array} 经过调整的可用 Menu 页集合
+     * @example
+     * adjustMenuListAvailable = (menuListAvailable) => menuListAvailable
+     */
+    adjustMenuListAvailable: (menuList: any[]) => any[];
+    /**
+     * 获取可用 Menu 页集合。
+     * @function
+     * @returns {Array} 可用 Menu 页集合
+     */
+    getMenuListAvailable: () => any[];
+    /**
+     * Menu页切换回调处理。
+     * @function
+     * @param {Object} option 配置项。
+     * @param {string} option.key 显示页的 key。
+     */
     handleMenuChange: ({ key }: {
-        key: any;
+        key: string;
     }) => void;
+    /**
+     * 构建 Tab Bar Extra Content 左侧区域配置，默认为空，可根据需要重载。
+     * @function
+     * @example
+     * establishTabBarExtraContentLeftConfig = () => null
+     */
     establishTabBarExtraContentLeftConfig: () => null;
+    /**
+     * 构建 Tab Bar Extra Content 右侧区域配置，默认为空，可根据需要重载。
+     * @function
+     * @example
+     * establishTabBarExtraContentRightConfig = () => null
+     */
     establishTabBarExtraContentRightConfig: () => null;
-    adjustTabListAvailable: (tabListAvailable: any) => any;
-    getTabListAvailable: () => any;
+    /**
+     * 调整可用 Tab 页集合，默认为空逻辑，可根据需要重载。
+     * @function
+     * @param {Array} menuList 将要调整的 Tab 页集合
+     * @returns {Array} 经过调整的可用 Tab 页集合
+     * @example
+     * adjustTabListAvailable = (tabList) => tabList
+     */
+    adjustTabListAvailable: (tabList: any) => any[];
+    /**
+     * 获取可用 Tab 页集合。
+     * @function
+     * @returns {Array} 可用 Tab 页集合
+     */
+    getTabListAvailable: () => any[];
+    /**
+     * Tab 页切换回调处理。
+     * @function
+     * @param {Object} option 配置项。
+     * @param {string} option.key 显示页的 key。
+     */
     handleTabChange: (key: any) => void;
+    /**
+     * 创建 Tab Bar Extra Content 部分。
+     * @function
+     */
     buildTabBarExtraContent: () => {
         left: React.JSX.Element;
         right: React.JSX.Element;
     };
+    /**
+     * 配置额外的 Tab 属性。
+     * @function
+     */
     buildOtherTabProps: () => {
         type: string;
         size: string;

package/es/framework/Common/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * 通用逻辑基类
+ * @namespace framework
+ * @class Common
+ * @extends InternalLayout
+ */
 export class Common extends InternalLayout {
 }
 import { InternalLayout } from './InternalLayout';

package/es/framework/Core/index.d.ts

@@ -1,70 +1,70 @@
 /**
- * core
+ * 框架内核定义类。
  * @namespace framework
  * @class Core
- * @augments BaseComponent
+ * @extends BaseComponent
  */
 export class Core extends BaseComponent {
     /**
-     * get derived state from props
+     * get derived state from props。
      * @static
-     * @param {Object} nextProperties
-     * @param {Object} previousState
-     * @returns {Object}
+     * @param {Object} nextProperties 即将更改的属性值
+     * @param {Object} previousState 之前的 state 值
+     * @returns {Object} 更新后的 state 值
      */
     static getDerivedStateFromProps(nextProperties: Object, previousState: Object): Object;
     /**
-     * @constructs
+     * 构造函数
      * @param {Object} properties
      */
     constructor(properties: Object);
     /**
-     * view loading flag
+     * 最近一次调用数据加载时候的传递参数。
      * @member {Object}
      */
     lastLoadParams: null;
     /**
-     * view loading flag
+     * 加载中的标记符号变量，默认 ""。
      * @member {string}
      */
     viewLoadingFlag: string;
     /**
-     * view searching flag
+     * 搜索中的标记符号变量，默认 ""。
      * @member {string}
      */
     viewSearchingFlag: string;
     /**
-     * view resetting flag
+     * 重置中的标记符号变量，默认 ""。
      * @member {string}
      */
     viewResettingFlag: string;
     /**
-     * view refreshing flag
+     * 刷新中的标记符号变量，默认 ""。
      * @member {string}
      */
     viewRefreshingFlag: string;
     /**
-     * view reloading flag
+     * 重新载入中的标记符号变量，默认 ""。
      * @member {string}
      */
     viewReloadingFlag: string;
     /**
-     * view processing flag
+     * 处理中的标记符号变量，默认 ""。
      * @member {string}
      */
     viewProcessingFlag: string;
     /**
-     * view tab flag
+     * 标签页标记符号变量，默认 ""。
      * @member {string}
      */
     viewTabFlag: string;
     /**
-     * view menu flag
+     * 菜单页标记符号变量，默认 ""。
      * @member {string}
      */
     viewMenuFlag: string;
     /**
-     * view animal prompt flag
+     * 动画提示标记符号变量，默认 ""。
      * @member {string}
      */
     viewAnimalPromptFlag: string;
@@ -75,6 +75,10 @@ export class Core extends BaseComponent {
         urlParams: null;
         externalData: null;
     };
+    /**
+     * 获取标记变量集合。
+     * @function
+     */
     getViewFlagInfo(): {
         viewLoadingFlag: string;
         viewSearchingFlag: string;
@@ -86,32 +90,110 @@ export class Core extends BaseComponent {
         viewMenuFlag: string;
         viewAnimalPromptFlag: string;
     };
+    /**
+     * 获取当前激活的 Tab 页标记。
+     * @function
+     */
     getTabActiveKey: () => any;
-    setTabActiveKey(key: any): void;
+    /**
+     * 设置当前激活的 Tab 页标记。
+     * @function
+     * @param {string} key Tab页标记值
+     */
+    setTabActiveKey(key: string): void;
+    /**
+     * 获取当前激活的 Menu 页标记。
+     * @function
+     */
     getMenuActiveKey: () => any;
-    setMenuActiveKey(key: any): void;
-    startLoading(...message: any[]): void;
-    stopLoading(...message: any[]): void;
-    startSearching(...message: any[]): void;
-    stopSearching(...message: any[]): void;
-    startResetting(...message: any[]): void;
-    stopResetting(...message: any[]): void;
-    startRefreshing(...message: any[]): void;
-    stopRefreshing(...message: any[]): void;
-    startReloading(...message: any[]): void;
-    stopReloading(...message: any[]): void;
-    startProcessing(...message: any[]): void;
-    stopProcessing(...message: any[]): void;
-    /**
-     * check loading progress,if loading or load fail,return false,else return true
+    /**
+     * 设置当前激活的 Menu 页标记。
+     * @function
+     * @param {string} key Menu页标记值
+     */
+    setMenuActiveKey(key: string): void;
+    /**
+     * 开始加载，影响"加载中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    startLoading(...messages: any[]): void;
+    /**
+     * 停止加载，影响"加载中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    stopLoading(...messages: any[]): void;
+    /**
+     * 开始搜索，影响"搜索中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    startSearching(...messages: any[]): void;
+    /**
+     * 停止搜索，影响"搜索中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    stopSearching(...messages: any[]): void;
+    /**
+     * 开始重置，影响"重置中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    startResetting(...messages: any[]): void;
+    /**
+     * 停止重置，影响"重置中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    stopResetting(...messages: any[]): void;
+    /**
+     * 开始刷新，影响"刷新中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    startRefreshing(...messages: any[]): void;
+    /**
+     * 停止刷新，影响"刷新中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    stopRefreshing(...messages: any[]): void;
+    /**
+     * 开始重载，影响"重载中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    startReloading(...messages: any[]): void;
+    /**
+     * 停止重载，影响"重载中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    stopReloading(...messages: any[]): void;
+    /**
+     * 开始处理，影响"处理中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    startProcessing(...messages: any[]): void;
+    /**
+     * 停止处理，影响"处理中"效果。
+     * @function
+     * @param {Array} messages 消息或消息集合
+     */
+    stopProcessing(...messages: any[]): void;
+    /**
+     * 检查加载进度，如果加载或加载失败，返回false，否则返回true。
      */
     checkLoadingProgress(): boolean;
     /**
-     * check operability,if loading or or processing or load fail,return false,else return true
+     * 检查可操作性，如果加载或处理或加载失败，返回false，否则返回true。
      */
     checkOperability(): boolean;
     /**
-     * check in progress,if loading or or processing,return false,else return true
+     * 检查是否在加载或处理中，如果正在加载或正在处理，返回false，否则返回true。
      */
     checkInProgress(): any;
 }

package/es/framework/CustomWrapper/Supplement/index.d.ts

@@ -2,7 +2,7 @@
  * 该类作为特有项目的补充，视具体项目进行增部方法
  * @namespace CustomWrapper
  * @class Supplement
- * @augments SupplementCore
+ * @extends SupplementCore
  */
 export class Supplement extends SupplementCore {
     static getDerivedStateFromProps(nextProperties: any, previousState: any): any;

package/es/framework/CustomWrapper/SupplementCore/index.d.ts

@@ -1,21 +1,52 @@
+/**
+ * 该类作为特有项目的补充，视具体项目进行增部方法
+ * @namespace CustomWrapper
+ * @class SupplementCore
+ * @extends Common
+ */
 export class SupplementCore extends Common {
-    pretreatmentImageUploadRemoteResponse: (response: any) => {
+    /**
+     * 预处理图片上传结果。
+     * @function
+     * @param {Object} response 上传结果。
+     */
+    pretreatmentImageUploadRemoteResponse: (response: Object) => {
         image: string;
         data: {};
     };
-    pretreatmentFileBase64UploadRemoteResponse: (response: any) => {
+    /**
+     * 预处理文件Base64上传结果。
+     * @function
+     * @param {Object} response 上传结果。
+     */
+    pretreatmentFileBase64UploadRemoteResponse: (response: Object) => {
         image: string;
         data: {};
     };
-    pretreatmentVideoUploadRemoteResponse: (response: any) => {
+    /**
+     * 预处理视频上传结果。
+     * @function
+     * @param {Object} response 上传结果。
+     */
+    pretreatmentVideoUploadRemoteResponse: (response: Object) => {
         video: string;
         data: {};
     };
-    pretreatmentAudioUploadRemoteResponse: (response: any) => {
+    /**
+     * 预处理音频上传结果。
+     * @function
+     * @param {Object} response 上传结果。
+     */
+    pretreatmentAudioUploadRemoteResponse: (response: Object) => {
         audio: string;
         data: {};
     };
-    pretreatmentFileUploadRemoteResponse: (response: any) => {
+    /**
+     * 预处理文件上传结果。
+     * @function
+     * @param {Object} response 上传结果。
+     */
+    pretreatmentFileUploadRemoteResponse: (response: Object) => {
         file: string;
         data: {};
     };

package/es/framework/CustomWrapper/SupplementWrapper/index.d.ts

@@ -1,3 +1,17 @@
+/**
+ * 该类作为特有项目的补充，视具体项目进行增部方法
+ * @namespace CustomWrapper
+ * @class SupplementWrapper
+ * @extends Supplement
+ */
 export class SupplementWrapper extends Supplement {
+    /**
+     * get derived state from props。
+     * @static
+     * @param {Object} nextProperties 即将更改的属性值
+     * @param {Object} previousState 之前的 state 值
+     * @returns {Object} 更新后的 state 值
+     */
+    static getDerivedStateFromProps(nextProperties: Object, previousState: Object): Object;
 }
 import { Supplement } from '../Supplement';

package/es/framework/DataDrawer/Base/index.d.ts

@@ -1,5 +1,16 @@
+/**
+ * Drawer 操作基类
+ * @namespace DataDrawer
+ * @class DataDrawer.Base
+ * @extends BaseWindow
+ */
 export class Base extends BaseWindow {
-    constructor(properties: any, visibleFlag: any);
+    /**
+     * 构造函数
+     * @param {Object} properties 属性值集合。
+     * @param {string} visibleFlag 可见性标记。
+     */
+    constructor(properties: Object, visibleFlag: string);
     state: {
         title: string;
         width: number;
@@ -24,25 +35,126 @@ export class Base extends BaseWindow {
         urlParams: null;
         externalData: null;
     };
-    adjustHeaderStyle: () => {};
+    /**
+     * 调整头部样式。
+     * @function
+     * @returns {Object} style
+     * @example
+     * adjustHeaderStyle = () => { return {}; }
+     */
+    adjustHeaderStyle: () => Object;
+    /**
+     * 创建标题前缀文字，默认为空，可根据需要重载。
+     * @function
+     * @returns {string} 标题前缀文本
+     * @example
+     * buildTitlePrevText = () => ""
+     */
     buildTitlePrevText: () => string;
+    /**
+     * 创建标题文字。
+     * @function
+     * @returns {string} 标题文本
+     */
     buildTitleText: () => string;
+    /**
+     * 创建副标题文字，默认为空，可根据需要重载。
+     * @function
+     * @returns {string} 副标题文本
+     * @example
+     * buildTitleSubText = () => ""
+     */
     buildTitleSubText: () => string;
-    renderPresetTitleIcon: () => null;
-    renderPresetContentContainorInner: () => null;
-    renderPresetContentContainor: () => React.JSX.Element;
-    renderPresetCloseButton: (option: any) => React.JSX.Element;
-    buildBottomBarInnerExtraConfigList: () => never[];
-    buildBottomBarInnerDefaultConfigList: () => {
-        buildType: string;
-    }[];
-    buildBottomBarInnerLeftItemConfigList: () => never[];
+    /**
+     * 渲染标题图标，默认为空，可根据需要重载。
+     * @function
+     * @returns {Object} 标题图标
+     * @example
+     * renderPresetTitleIcon = () => null
+     */
+    renderPresetTitleIcon: () => Object;
+    /**
+     * 渲染内容容器内部。
+     * @function
+     * @returns {Object} 渲染结果
+     * @example
+     * renderPresetContentContainorInner = () => null
+     */
+    renderPresetContentContainorInner: () => Object;
+    /**
+     * 渲染内容容器。
+     * @function
+     * @returns {Object} 渲染结果
+     */
+    renderPresetContentContainor: () => Object;
+    /**
+     * 渲染关闭按钮。
+     * @function
+     * @param {Object} option 配置项
+     * @returns {Object} 渲染结果
+     */
+    renderPresetCloseButton: (option: Object) => Object;
+    /**
+     * 构造底部栏内部Extra区域配置集合。
+     * @function
+     * @returns {Array} 配置集合
+     * @example
+     * buildBottomBarInnerExtraConfigList = () => []
+     */
+    buildBottomBarInnerExtraConfigList: () => any[];
+    /**
+     * 构造底部栏内部默认配置集合。
+     * @function
+     * @returns {Array} 配置集合
+     */
+    buildBottomBarInnerDefaultConfigList: () => any[];
+    /**
+     * 构造底部栏内部左侧项配置集合。
+     * @function
+     * @returns {Array} 配置集合
+     * @example
+     * buildBottomBarInnerLeftItemConfigList = () => []
+     */
+    buildBottomBarInnerLeftItemConfigList: () => any[];
+    /**
+     * 构造底部栏内部右侧项配置集合。
+     * @function
+     * @returns {Array} 配置集合
+     */
     buildBottomBarInnerRightItemConfigList: () => any[];
-    renderPresetBottomBarRightBox: () => React.JSX.Element[] | null;
-    renderPresetBottomBarLeftBox: () => React.JSX.Element[] | null;
-    renderPresetBottomBarInnerBox: (configList: any) => React.JSX.Element[] | null;
-    renderPresetBottomBar: () => React.JSX.Element;
-    renderOverlayContent: () => null;
+    /**
+     * 渲染底部栏右侧部份。
+     * @function
+     * @returns {Object} 渲染结果
+     */
+    renderPresetBottomBarRightBox: () => Object;
+    /**
+     * 渲染底部栏左侧部份。
+     * @function
+     * @returns {Object} 渲染结果
+     */
+    renderPresetBottomBarLeftBox: () => Object;
+    /**
+     * 渲染底部栏内部部份。
+     * @function
+     * @param {Array} configList 配置项集合
+     * @returns {Object} 渲染结果
+     */
+    renderPresetBottomBarInnerBox: (configList: any[]) => Object;
+    /**
+     * 渲染底部栏。
+     * @function
+     * @returns {Object} 渲染结果
+     */
+    renderPresetBottomBar: () => Object;
+    /**
+     * 渲染遮罩层内容区域，默认为空，可根据需要重载。
+     * @function
+     * @returns {Object} 渲染结果
+     * @example
+     * renderOverlayContent = () => null
+     */
+    renderOverlayContent: () => Object;
 }
 export namespace Base {
     namespace defaultProps {
@@ -50,4 +162,3 @@ export namespace Base {
     }
 }
 import { BaseWindow } from '../../DataOperation/BaseWindow';
-import React from 'react';

package/es/framework/DataDrawer/BaseAddDrawer/index.d.ts

@@ -2,7 +2,7 @@
  * base add drawer
  * @namespace framework.DataDrawer
  * @class BaseAddDrawer
- * @augments BaseNeedlessLoadDrawer
+ * @extends BaseNeedlessLoadDrawer
  */
 export class BaseAddDrawer extends BaseNeedlessLoadDrawer {
     adjustWhenDidMount: () => void;

package/es/framework/DataDrawer/BaseFormDrawer/index.d.ts

@@ -1,7 +1,26 @@
 export class BaseFormDrawer extends Base {
+    /**
+     * 构造 Card 配置集合。
+     * @function
+     * @example
+     * establishCardCollectionConfig = () => null
+     */
     establishCardCollectionConfig: () => null;
+    /**
+     * 配置表单布局。
+     * @function
+     * @returns {string} 'vertical'
+     */
     buildFormLayout: () => string;
-    renderPresetFormContent: () => React.JSX.Element | null;
+    /**
+     * 渲染表单内容。
+     * @function
+     */
+    renderPresetFormContent: () => Object;
+    /**
+     * 渲染表单。
+     * @function
+     */
     renderPresetForm: () => React.JSX.Element;
     renderPresetContentContainorInner: () => React.JSX.Element;
 }