xrk-components 0.3.2 → 0.3.5

package/lib/packages/base/tag/tag-group.d.ts

@@ -0,0 +1,138 @@
+declare const _default: import("vue").DefineComponent<{
+    modelValue: {
+        type: ArrayConstructor;
+        required: false;
+    };
+    labelKey: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    type: {
+        type: StringConstructor;
+        required: false;
+    };
+    disableTransitions: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    hit: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    color: {
+        type: StringConstructor;
+        required: false;
+    };
+    size: {
+        type: StringConstructor;
+        required: false;
+    };
+    effect: {
+        type: StringConstructor;
+        required: false;
+    };
+    round: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    beforeClose: {
+        type: null;
+        required: false;
+    };
+    beforeAdd: {
+        type: FunctionConstructor;
+        required: false;
+    };
+    showAdd: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    addBtnText: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    maxlength: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "change" | "click")[], "update:modelValue" | "change" | "click", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: ArrayConstructor;
+        required: false;
+    };
+    labelKey: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    type: {
+        type: StringConstructor;
+        required: false;
+    };
+    disableTransitions: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    hit: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    color: {
+        type: StringConstructor;
+        required: false;
+    };
+    size: {
+        type: StringConstructor;
+        required: false;
+    };
+    effect: {
+        type: StringConstructor;
+        required: false;
+    };
+    round: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    beforeClose: {
+        type: null;
+        required: false;
+    };
+    beforeAdd: {
+        type: FunctionConstructor;
+        required: false;
+    };
+    showAdd: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    addBtnText: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    maxlength: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onChange?: ((...args: any[]) => any) | undefined;
+    onClick?: ((...args: any[]) => any) | undefined;
+}, {
+    labelKey: string;
+    disableTransitions: boolean;
+    hit: boolean;
+    round: boolean;
+    showAdd: boolean;
+    addBtnText: string;
+    maxlength: number;
+}>;
+export default _default;

package/lib/packages/base/tag/tag.d.ts

@@ -0,0 +1,81 @@
+declare const _default: import("vue").DefineComponent<{
+    type: {
+        type: StringConstructor;
+        required: false;
+    };
+    closable: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    disableTransitions: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    hit: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    color: {
+        type: StringConstructor;
+        required: false;
+    };
+    size: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    effect: {
+        type: StringConstructor;
+        required: false;
+    };
+    round: {
+        type: BooleanConstructor;
+        required: false;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "close")[], "click" | "close", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    type: {
+        type: StringConstructor;
+        required: false;
+    };
+    closable: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    disableTransitions: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    hit: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    color: {
+        type: StringConstructor;
+        required: false;
+    };
+    size: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    effect: {
+        type: StringConstructor;
+        required: false;
+    };
+    round: {
+        type: BooleanConstructor;
+        required: false;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+    onClose?: ((...args: any[]) => any) | undefined;
+}, {
+    closable: boolean;
+    disableTransitions: boolean;
+    hit: boolean;
+    size: string;
+    round: boolean;
+}>;
+export default _default;

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

@@ -0,0 +1,18 @@
+import { StyleValue, DefineComponent } from 'vue';
+export declare type BaseToolTipProps = {
+    popperClass?: string;
+    trigger?: 'hover' | 'click' | 'focus' | 'contextmenu';
+    transition?: 'el-fade-in-linear' | 'none';
+    disabled?: boolean;
+    enterable?: boolean;
+    hideAfter?: number;
+    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/base/tool-tip/tool-tip.d.ts

@@ -0,0 +1,106 @@
+declare const _default: import("vue").DefineComponent<{
+    popperClass: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    trigger: {
+        type: StringConstructor;
+        required: false;
+    };
+    transition: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    enterable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    hideAfter: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    placement: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    content: {
+        type: (StringConstructor | NumberConstructor)[];
+        required: false;
+    };
+    style: {
+        type: null;
+        required: false;
+    };
+    overShow: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    popperClass: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    trigger: {
+        type: StringConstructor;
+        required: false;
+    };
+    transition: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        required: false;
+    };
+    enterable: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+    hideAfter: {
+        type: NumberConstructor;
+        required: false;
+        default: number;
+    };
+    placement: {
+        type: StringConstructor;
+        required: false;
+        default: string;
+    };
+    content: {
+        type: (StringConstructor | NumberConstructor)[];
+        required: false;
+    };
+    style: {
+        type: null;
+        required: false;
+    };
+    overShow: {
+        type: BooleanConstructor;
+        required: false;
+        default: boolean;
+    };
+}>>, {
+    popperClass: string;
+    transition: string;
+    disabled: boolean;
+    enterable: boolean;
+    hideAfter: number;
+    placement: string;
+    overShow: boolean;
+}>;
+export default _default;

package/lib/packages/components.d.ts

@@ -0,0 +1,14 @@
+export { BaseButton } from './base/button';
+export { BaseRadio, BaseRadioGroup, BaseRadioButton } from './base/radio';
+export { BaseCheckbox, BaseCheckboxGroup, BaseCheckboxButton } from './base/checkbox';
+export { BaseDatePicker } from './base/date-picker';
+export { BaseInput } from './base/input';
+export { BaseSelect } from './base/select';
+export { BaseSwitch } from './base/switch';
+export { BaseTag, BaseTagGroup } from './base/tag';
+export { BasePagination } from './base/pagination';
+export { BaseForm, BaseFormItem } from './base/form/';
+export { XrkSearch } from './xrk/search';
+export { BaseTable } from './base/table';
+export { XrkTable } from './xrk/table';
+export { BaseDialog } from './base/dialog';

package/lib/packages/functions.d.ts

@@ -0,0 +1,3 @@
+export { useTableColumn } from './base/table';
+export { createDialog } from './base/dialog';
+export { useInputColumn, useSearchColumns, useSelectColumn, useSearchBtn, useResetBtn, useDatePickerColumn, useOtherComponents } from './xrk/search/hooks/use-search';

package/lib/packages/index.d.ts

@@ -0,0 +1,10 @@
+import { App } from 'vue';
+import '../styles/element/index.scss';
+export * from './components';
+export * from './functions';
+export * from './types';
+declare const _default: {
+    version: string;
+    install: (app: App<any>) => void;
+};
+export default _default;

package/lib/packages/types.d.ts

@@ -0,0 +1,16 @@
+export type { BaseButtonProps } from './base/button';
+export type { BaseRadioButtonProps, BaseRadioGroupProps, BaseRadioProps } from './base/radio';
+export type { BaseCheckboxProps, BaseCheckboxGroupProps, BaseCheckboxButtonProps } from './base/checkbox';
+export type { BaseDatePickerProps } from './base/date-picker';
+export type { BaseInputProps } from './base/input';
+export type { BaseSelectProps, SelectOptionType, SelectValueType } from './base/select';
+export type { BaseSwitch } from './base/switch';
+export type { BaseTagProps, BaseTagGroupProps, TagOption } from './base/tag';
+export type { BasePaginationProps, PaginationInfoType } from './base/pagination';
+export type { BaseFormProps, BaseFormItemProps } from './base/form/';
+export type { BaseTableProps, BaseTableColumnProps } from './base/table/types/type';
+export type { BaseDialogProps, DialogBtnConfigProps } from './base/dialog';
+export type { XrkSearchProps, XrkSearchRef } from './xrk/search';
+export type { ComponentRender, ResetBtnType, SearchBtnType, SerachColumnType } from './xrk/search/types/type';
+export type { XrkTableProps } from './xrk/table/types/type';
+export type { XrkTableRef } from './xrk/table';

package/lib/packages/xrk/search/hooks/use-search.d.ts

@@ -0,0 +1,45 @@
+import { BaseDatePickerProps } from '../../../base/date-picker';
+import { BaseInputProps } from '../../../base/input';
+import { BaseSelectProps } from '../../../base/select';
+import { SerachColumnType, SearchBtnType, ResetBtnType, SerachColumnBaseType, BaseInputListener, BaseSelectListener, BaseDatePickerListener, ComponentRender } from '../types/type';
+export declare const useInputColumn: (column: SerachColumnBaseType<BaseInputProps, BaseInputListener>) => SerachColumnBaseType<BaseInputProps, BaseInputListener>;
+export declare const useSelectColumn: (column: SerachColumnBaseType<BaseSelectProps, BaseSelectListener>) => SerachColumnBaseType<BaseSelectProps, BaseSelectListener>;
+export declare const useDatePickerColumn: (column: SerachColumnBaseType<BaseDatePickerProps, BaseDatePickerListener>) => SerachColumnBaseType<BaseDatePickerProps, BaseDatePickerListener>;
+export declare const useSearchColumns: (columns: Array<SerachColumnType>) => Array<SerachColumnType>;
+export declare const useSearchBtn: (searchBtnConfig: SearchBtnType) => {
+    text: string;
+    show: boolean;
+    beforeSearch?: ((searchValue: {
+        [x: string]: any;
+    }) => {
+        [x: string]: any;
+    } | Promise<{
+        [x: string]: any;
+    }>) | undefined;
+    afterSearch?: ((searchValue: {
+        [x: string]: any;
+    }) => void | {
+        [x: string]: any;
+    } | Promise<{
+        [x: string]: any;
+    }>) | undefined;
+};
+export declare const useResetBtn: (resetBtnConfig: ResetBtnType) => {
+    text: string;
+    show: boolean;
+    beforeReset?: ((searchValue: {
+        [x: string]: any;
+    }) => {
+        [x: string]: any;
+    } | Promise<{
+        [x: string]: any;
+    }>) | undefined;
+    afterReset?: ((searchValue: {
+        [x: string]: any;
+    }) => void | {
+        [x: string]: any;
+    } | Promise<{
+        [x: string]: any;
+    }>) | undefined;
+};
+export declare const useOtherComponents: (otherComponents: Array<ComponentRender>) => Array<ComponentRender>;

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

@@ -0,0 +1,27 @@
+import { DefineComponent } from 'vue';
+import { ComponentRender, ResetBtnType, SearchBtnType, SerachColumnType } from './types/type';
+export declare type XrkSearchProps = {
+    columns: Array<SerachColumnType>;
+    searchBtn?: SearchBtnType;
+    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/search.d.ts

@@ -0,0 +1,59 @@
+declare const _default: import("vue").DefineComponent<{
+    columns: {
+        type: null;
+        required: true;
+    };
+    searchBtn: {
+        type: null;
+        required: false;
+        default: () => {
+            text: string;
+            show: boolean;
+        };
+    };
+    resetBtn: {
+        type: null;
+        required: false;
+        default: () => {
+            text: string;
+            show: boolean;
+        };
+    };
+    otherComponents: {
+        type: null;
+        required: false;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "search"[], "search", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    columns: {
+        type: null;
+        required: true;
+    };
+    searchBtn: {
+        type: null;
+        required: false;
+        default: () => {
+            text: string;
+            show: boolean;
+        };
+    };
+    resetBtn: {
+        type: null;
+        required: false;
+        default: () => {
+            text: string;
+            show: boolean;
+        };
+    };
+    otherComponents: {
+        type: null;
+        required: false;
+    };
+}>> & {
+    onSearch?: ((...args: any[]) => any) | undefined;
+}, {
+    searchBtn: any;
+    resetBtn: any;
+}>;
+export default _default;

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

@@ -0,0 +1,102 @@
+import { Component, CSSProperties } from 'vue';
+import { BaseInputProps } from '../../../base/input';
+import { BaseDatePickerProps } from '../../../base/date-picker';
+import { BaseSelectProps, SelectOptionType, SelectValueType } from '../../../base/select';
+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 = {
+    onBlur?: (events: Event, searchValue: AnyObject) => void;
+    onFocus?: (events: Event, searchValue: AnyObject) => void;
+    onKeyup?: (events: Event, searchValue: AnyObject) => void;
+    onChange?: (value: string | number | KeyboardEvent, searchValue: AnyObject) => void;
+    onInput?: (value: string | number | KeyboardEvent, searchValue: AnyObject) => void;
+    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 {
+    input: Component;
+    select: Component;
+    datePicker: Component;
+}
+export declare type SerachColumnBaseType<T, S> = {
+    prop: string;
+    type?: keyof ComponentsType;
+    label?: string;
+    style?: CSSProperties;
+    defaultValue?: any;
+    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 {
+    render: (renderInfo: {
+        columns: Array<SerachColumnType>;
+        searchValue: Record<string, any>;
+    }) => Component;
+}
+export {};

package/lib/packages/xrk/table/hooks/use-table.d.ts

@@ -0,0 +1,6 @@
+export declare const useTable: (config: any) => {
+    pageIsLoading: import("vue").Ref<boolean>;
+    pageAllData: import("vue").Ref<any[]>;
+    paginationTotal: import("vue").Ref<number>;
+    getList: (query: any) => Promise<void>;
+};

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

@@ -0,0 +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>, {}>;