xrk-components 0.3.3 → 0.3.4

package/lib/packages/base/button/index.d.ts

@@ -1,5 +1,8 @@
 import { Component, DefineComponent } from 'vue';
 export declare type BaseButtonProps = {
+    /**
+     * 自定义方法 ， 用于事件同步执行,使用这个的时候，可以不用使用 @click onClick
+     */
     click?: (...preload: Array<any>) => Promise<any> | void | any;
     loading?: boolean;
     loadingIcon?: string | Component;

package/lib/packages/base/date-picker/index.d.ts

@@ -20,7 +20,13 @@ export declare type BaseDatePickerProps = {
     prefixIcon?: string | Component;
     clearIcon?: string | Component;
     validateEvent?: boolean;
+    /**
+     * 一个用来判断该日期是否被禁用的函数，接受一个 Date 对象作为参数。 应该返回一个 Boolean 值。
+     */
     disabledDate?: (date: Date, startDt: Date | null) => boolean;
+    /**
+     * 设置快捷选项，需要传入数组对象
+     */
     shortcuts?: Array<{
         text: string;
         value: Date | (() => void);

package/lib/packages/base/input/index.d.ts

@@ -32,7 +32,13 @@ export interface BaseInputProps {
     tabindex?: string | number;
     validateEvent?: boolean;
     inputStyle?: CSSProperties;
+    /**
+     * 输入时处理输入值
+     */
     inputRewrite?: (value: string | number) => string | Promise<string>;
+    /**
+     * 发生改变时处理输入值
+     */
     changeRewrite?: (value: string | number) => string | Promise<string>;
     onBlur?: (events: Event) => void;
     onFocus?: (events: Event) => void;

package/lib/packages/base/radio/index.d.ts

@@ -13,6 +13,9 @@ export declare type BaseRadioGroupProps = {
     textColor?: string;
     fill?: string;
     disabled?: boolean;
+    /**
+     * 选中前，执行done可以完成选中状态
+     */
     checkBefore?: (activeValue: any, done: Function) => void;
     onChange?: (activeValue: any) => void;
 };
@@ -23,6 +26,9 @@ export declare type BaseRadioProps = {
     label?: string | number | boolean;
     disabled?: boolean;
     border?: boolean;
+    /**
+     * 选中前，执行done可以完成选中状态
+     */
     checkBefore?: (activeValue: any, done: Function) => void;
     onChange?: (activeValue: any) => void;
 };

package/lib/packages/base/select/index.d.ts

@@ -7,32 +7,92 @@ export declare type SelectOptionType = {
 };
 export declare type SelectValueType = string | number | boolean | SelectOptionType | null | undefined;
 export interface BaseSelectProps {
+    /**
+     * 初始化组件时 执行 remoteMethod 方法
+     */
     init?: boolean;
+    /**
+     * 使用远程搜索
+     */
     filterUseRemote?: boolean;
+    /**
+     * 下拉选项
+     */
     options?: Array<SelectOptionType>;
+    /**
+     * 是否分组
+     */
     group?: boolean;
     labelKey?: string;
     valueKey?: string;
     optionsKey?: string;
+    /**
+     * 选中项绑定值
+     */
     modelValue?: SelectValueType | Array<string | number | boolean | SelectOptionType | null | undefined>;
+    /**
+     * 是否多选
+     */
     multiple?: boolean;
+    /**
+     * 是否禁用
+     */
     disabled?: boolean;
+    /**
+     * 输入框尺寸
+     */
     size?: 'large' | 'default' | 'small';
+    /**
+     * 是否可以清空选项
+     */
     clearable?: boolean;
+    /**
+     * 多选时是否将选中值按文字的形式展示
+     */
     collapseTags?: boolean;
+    /**
+     * 当鼠标悬停于折叠标签的文本时，是否显示所有选中的标签。 要使用此属性，collapse-tags属性必须设定为 true
+     */
     collapseTagsTooltip?: boolean;
+    /**
+     * multiple 属性设置为 true 时，代表多选场景下用户最多可以选择的项目数， 为 0 则不限制
+     */
     multipleLimit?: number;
+    /**
+     * 占位文字
+     */
     placeholder?: string;
+    /**
+     * Select 组件是否可筛选
+     */
     filterable?: boolean;
+    /**
+     * 是否允许用户创建新条目， 只有当 filterable 设置为 true 时才会生效。
+     */
     allowCreate?: boolean;
+    /**
+     * 下拉框的宽度是否与输入框相同
+     */
     fitInputWidth?: boolean;
     /**
      * 自定义筛选方法
      */
     filterMethod?: (searchVal: string) => Array<SelectValueType>;
+    /**
+     * 远程方法
+     */
     remoteMethod?: (searchVal?: string) => any;
+    /**
+     * 从服务器加载内容时显示的文本
+     */
     loadingText?: string;
+    /**
+     * 搜索条件无匹配时显示的文字，也可以使用 empty 插槽设置
+     */
     noMatchText?: string;
+    /**
+     * 无选项时显示的文字，也可以使用 empty 插槽设置自定义内容
+     */
     noDataText?: string;
     onChange?: (value: SelectValueType, SelectOption: Array<SelectOptionType>) => void;
     onRemoveTag?: (value: SelectValueType) => void;

package/lib/packages/base/table/types/type.d.ts

@@ -73,29 +73,59 @@ export declare type BaseTableColumnProps = {
     headerAlign?: 'left' | 'right' | 'center';
     className?: string;
     labelClassName?: string;
+    /**
+     * 最多显示多少行，超出时省略号，默认 1 ； 如果使用了render配置，则失效
+     */
     textLineClamp?: number;
+    /**
+     * 自定义列头
+     */
     renderHeader?: (info: {
         column: TableColumnCtx<any>;
         index: number;
+        /**
+         * 全选属性，当列的type = "_selection"时有效
+         */
         selectionInfo?: {
+            /**
+             * 全选/取消全选
+             */
             toggleCheckAll?: () => void;
+            /**
+             * 是否全部选中
+             */
             checkboxAllChecked: ComputedRef<boolean>;
+            /**
+             * 是否部分选中
+             */
             checkboxAllIndeterminate: ComputedRef<boolean>;
+            /**
+             * 是否选择中
+             */
             selectionAllLoading: Ref<boolean>;
         };
     }) => JSX.Element;
+    /**
+     * 格式化数据
+     */
     formatter?: (info: {
         row: Record<string, any>;
         cellValue: any;
         column: TableColumnCtx<any>;
         index: number;
     }) => any;
+    /**
+     * 自定义cell内容
+     */
     render?: (info: {
         row: Record<string, any>;
         cellValue: any;
         column: TableColumnCtx<any>;
         index: number;
     }) => JSX.Element;
+    /**
+     * 禁用每列的selection
+     */
     selectionDisabled?: ((row: any) => boolean) | boolean;
     selectionRows?: Map<number | string, any>;
     hasSelectionRow?: (rowId: any) => boolean;
@@ -103,9 +133,24 @@ export declare type BaseTableColumnProps = {
     removeSelectionRow?: (rowId: any) => void;
     getSelectionRows?: () => Array<any>;
     clearSelectionRows?: () => void;
+    /**
+     * 点击表头全选框 ，选中前
+     */
     selectionAllBefore?: (done: Function) => Promise<void> | void;
+    /**
+     * 点击多选框 ，选中前
+     */
     selectionAddBefore?: (row: any, done: Function) => Promise<void> | void;
+    /**
+     * 点击多选框 ，选中后
+     */
     selectionAddAfter?: (row: any) => Promise<void> | void;
+    /**
+     * 点击多选框 ，移除前
+     */
     selectionRemoveBefore?: (row: any, done: Function) => Promise<void> | void;
+    /**
+     * 点击多选框 ，移除后
+     */
     selectionRemoveAfter?: (row: any) => Promise<void> | void;
 };

package/lib/packages/base/tool-tip/index.d.ts

@@ -9,6 +9,10 @@ export declare type BaseToolTipProps = {
     placement?: 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end';
     content?: string | number;
     style?: StyleValue | undefined;
+    /**
+     * trigger = hover 时有效
+     * 内容超出才显示toolTip , 默认内容不超出也会触发展示
+     */
     overShow?: boolean;
 };
 export declare const BaseToolTip: DefineComponent<BaseToolTipProps, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<BaseToolTipProps>, {}>;

package/lib/packages/xrk/search/index.d.ts

@@ -6,4 +6,22 @@ export declare type XrkSearchProps = {
     resetBtn?: ResetBtnType;
     otherComponents?: Array<ComponentRender>;
 };
+export declare type XrkSearchRef = {
+    /**
+     * 设置指定搜索项
+     */
+    setSearchValue: (key: string | number, value: any) => void;
+    /**
+     * 获取搜索组件所有搜索项
+     */
+    getSearchValue: () => Record<string, any>;
+    /**
+     * 执行等同于点击搜索按钮
+     */
+    handleSearchClick: () => void | Promise<void>;
+    /**
+     * 执行等同于点击重置按钮
+     */
+    handleResetClick: () => void | Promise<void>;
+};
 export declare const XrkSearch: DefineComponent<XrkSearchProps, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<XrkSearchProps>, {}>;

package/lib/packages/xrk/search/types/type.d.ts

@@ -5,9 +5,18 @@ import { BaseSelectProps, SelectOptionType, SelectValueType } from '../../../bas
 import { FormItemRule } from 'element-plus';
 declare type AnyObject = Record<string, any>;
 export declare type BaseSelectListener = {
+    /**
+     * 下拉选值
+     */
     onChange?: (value: SelectValueType, selectOptions: Array<SelectOptionType>, searchValue: AnyObject) => void;
     onRemoveTag?: (value: SelectValueType, searchValue: AnyObject) => void;
+    /**
+     * 下拉框显示/隐藏时
+     */
     onVisibleChange?: (visibleStatus: boolean, searchValue: AnyObject) => void;
+    /**
+     * 清除时候
+     */
     onClear?: (searchValue: AnyObject) => void;
 };
 export declare type BaseInputListener = {
@@ -19,8 +28,17 @@ export declare type BaseInputListener = {
     onClear?: (searchValue: AnyObject) => void;
 };
 export declare type BaseDatePickerListener = {
+    /**
+     * 选择时间
+     */
     onChange?: (value: any, searchValue: AnyObject) => void;
+    /**
+     * 下拉框显示/隐藏时
+     */
     onVisibleChange?: (visibleStatus: boolean, searchValue: AnyObject) => void;
+    /**
+     * 范围选择，选择了第一个时间
+     */
     onCalendarChange?: (val: [Date, Date | null], searchValue: AnyObject) => void;
 };
 export interface ComponentsType {
@@ -29,27 +47,50 @@ export interface ComponentsType {
     datePicker: Component;
 }
 export declare type SerachColumnBaseType<T, S> = {
+    prop: string;
     type?: keyof ComponentsType;
     label?: string;
     style?: CSSProperties;
     defaultValue?: any;
-    prop: string;
     rules?: FormItemRule | Array<FormItemRule>;
+    /**
+     * 是否禁用
+     */
     disabled?: boolean | ((searchValue: AnyObject) => Promise<boolean> | boolean);
     config?: T;
     listener?: S;
 };
 export declare type SerachColumnType = SerachColumnBaseType<BaseInputProps | BaseSelectProps | BaseDatePickerProps, BaseInputListener | BaseSelectListener | BaseDatePickerListener>;
+/**
+ * 搜索按钮配置
+ * 点击时，执行顺序 beforeSearch -> emit.search -> afterSearch
+ */
 export declare type SearchBtnType = {
     text?: string;
     show?: boolean;
+    /**
+     * 搜索前
+     */
     beforeSearch?: (searchValue: AnyObject) => AnyObject | Promise<AnyObject>;
+    /**
+     * 搜索后
+     */
     afterSearch?: (searchValue: AnyObject) => void | AnyObject | Promise<AnyObject>;
 };
+/**
+ * 重置按钮配置
+ * 点击时，执行顺序  清空组件内的值 -> beforeReset -> emit.search -> afterReset
+ */
 export declare type ResetBtnType = {
     text?: string;
     show?: boolean;
+    /**
+     * 重置前
+     */
     beforeReset?: (searchValue: AnyObject) => AnyObject | Promise<AnyObject>;
+    /**
+     * 重置后
+     */
     afterReset?: (searchValue: AnyObject) => void | AnyObject | Promise<AnyObject>;
 };
 export interface ComponentRender {

package/lib/packages/xrk/table/index.d.ts

@@ -1,3 +1,37 @@
 import { DefineComponent } from 'vue';
 import { XrkTableProps } from './types/type';
+export declare type XrkTableRef = {
+    /**
+     * 获取当前表格选择的所有数据
+     */
+    getSelectionRows: () => any[];
+    /**
+     * 当前表格增加选中项
+     */
+    addSelectionRow: (rowId: string | number, row: any) => void;
+    /**
+     * 移除当前表格指定选中项
+     */
+    removeSelectionRow: (rowId: string | number) => void;
+    /**
+     * 移除当前表格所有选中项
+     */
+    clearSelectionRows: () => void;
+    /**
+     * 设置指定搜索项
+     */
+    setSearchValue: (key: string | number, value: any) => void;
+    /**
+     * 获取搜索组件所有搜索项
+     */
+    getSearchValue: () => Record<string, any>;
+    /**
+     * 刷新当前页，可传入自定义参数（只会作用与这次列表获取，相同变量会被search组件设置的值覆盖）
+     */
+    initCurrentList: (customQuery?: Record<string, any>) => void;
+    /**
+     * 回到第一页，并刷新列表，可传入自定义参数（只会作用与这次列表获取，相同变量会被search组件设置的值覆盖）
+     */
+    initList: (customQuery?: Record<string, any>) => void;
+};
 export declare const XrkTable: DefineComponent<XrkTableProps, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<XrkTableProps>, {}>;

package/lib/packages/xrk/table/types/type.d.ts

@@ -1,21 +1,65 @@
 import { BaseTableColumnProps } from '../../../base/table/types/type';
 import { ComponentRender, ResetBtnType, SearchBtnType, SerachColumnType } from '../../search/types/type';
 export declare type XrkTableProps = {
+    /**
+     * 是否立即执行getListAjax，默认是 （执行时机：onMounted）
+     */
     requestNow?: boolean;
-    getListAjax: (...args: any) => Promise<any> | any;
+    /**
+     * 获取表格数据
+     */
+    getListAjax: (query?: Record<string, any>) => Promise<any> | any;
+    /**
+     * 搜索项配置
+     */
     searchConfig: {
+        /**
+         * 搜索项
+         */
         searchColumns: Array<SerachColumnType>;
+        /**
+         * 搜索按钮配置
+         * 点击时，执行顺序 beforeSearch -> emit.search -> afterSearch
+         */
         searchBtn?: SearchBtnType;
+        /**
+         * 重置按钮配置
+         * 点击时，执行顺序  清空组件内的值 -> beforeReset -> emit.search -> afterReset
+         */
         resetBtn?: ResetBtnType;
+        /**
+         * 其他组件
+         */
         othertComponents?: Array<ComponentRender>;
     };
+    /**
+     * 表格配置
+     */
     tableConfig: {
+        /**
+         * 表格列 Array<BaseTableColumnProps>
+         */
         tableColumns: Array<BaseTableColumnProps>;
     };
+    /**
+     * 分页器配置
+     */
     paginationConfig?: {
+        /**
+         * 当前页key，默认pageNo
+         */
         pageNoKey?: string;
+        /**
+         * 每页数量key，默认pageSize
+         */
         pageSizeKey?: string;
+        /**
+         * 每页条数，默认60 ， 范围[15,60,100]
+         */
         paginationPageSize?: number;
+        /**
+         * 当前页码，默认1
+         */
         paginationCurrentPage?: number;
     };
 };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "xrk-components",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "",
   "main": "lib/index.esm.js",
   "typings": "lib/packages/index.d.ts",
   "scripts": {
+    "dev": "webpack-dev-server --hot --progress --config webpack.conf.js",
     "build:esm-bundle": "rollup --config rollup.config.js"
   },
   "keywords": [],
@@ -14,12 +15,15 @@
     "@babel/core": "^7.18.6",
     "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-commonjs": "^22.0.1",
+    "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.3.0",
     "@vue/babel-plugin-jsx": "^1.1.1",
     "@vue/cli-plugin-babel": "^5.0.7",
     "@vue/compiler-sfc": "^3.2.37",
     "acorn-jsx": "^5.3.2",
     "autoprefixer": "^10.4.7",
+    "css-loader": "^6.7.1",
+    "html-webpack-plugin": "^5.5.0",
     "rollup": "^2.75.7",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-clear": "^2.0.7",
@@ -28,8 +32,13 @@
     "rollup-plugin-vue": "^6.0.0",
     "sass": "^1.53.0",
     "sass-loader": "^13.0.2",
+    "style-loader": "^3.3.1",
+    "ts-loader": "^9.3.1",
     "typescript": "^4.7.4",
-    "vue-loader": "^17.0.0"
+    "vue-loader": "^17.0.0",
+    "webpack": "^5.73.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "^4.9.3"
   },
   "dependencies": {
     "element-plus": "^2.2.8",

package/tsconfig.json

@@ -10,6 +10,7 @@
 
     "jsx": "preserve",
     "moduleResolution": "node",
+    "resolveJsonModule": true,
     "declaration": true,
     "suppressImplicitAnyIndexErrors": true,
     "skipLibCheck": true
@@ -18,6 +19,9 @@
     "packages/**/*.ts",
     "packages/**/*.tsx",
     "packages/**/*.vue",
+    "example/**/*.ts",
+    "example/**/*.tsx",
+    "example/**/*.vue",
     "typings/**/*.ts"
   ],
   "exclude": ["node_modules", "@type/**/*.d.ts"]