@mi-avalon/libs 0.0.6 → 0.0.8

package/dist/components/ItemsRow/index.d.ts

@@ -0,0 +1,43 @@
+import { ButtonProps } from 'antd';
+import * as React from 'react';
+/**
+ * 默认配置按钮，也可以通过render() 渲染其他组件
+ */
+export interface IRowItem {
+    /**
+     * 按钮名称
+     */
+    label?: string;
+    /**
+     * 按钮类型
+     */
+    type?: ButtonProps['type'];
+    /**
+     * 如果没有指定Render，则是按钮的onClick
+     */
+    onClick?: (e: any) => void;
+    /**
+     * 其他按钮属性
+     */
+    btnProps?: ButtonProps;
+    /**
+     * item 的className
+     */
+    className?: string;
+    /**
+     * 自定义渲染
+     */
+    render?: () => React.ReactNode;
+}
+export interface IItemRowProps {
+    route?: Array<{
+        name: string;
+        url?: string;
+    }>;
+    items?: IRowItem[];
+    style?: React.CSSProperties;
+    className?: string;
+    offsetTop?: number;
+}
+declare const ItemsRow: (props: IItemRowProps) => React.JSX.Element | null;
+export default ItemsRow;

package/dist/components/MBreadcrumb/index.d.ts

@@ -0,0 +1,18 @@
+import * as React from 'react';
+import { IRowItem } from '../ItemsRow';
+import './index.scss';
+export interface RouteItem {
+    name: string;
+    url?: string;
+}
+export interface IMBreadcrumbProps {
+    routes?: RouteItem[];
+    customItems?: IRowItem[];
+    style?: React.CSSProperties;
+    className?: string;
+    offsetTop?: number;
+    mainAppBaseUrl?: string;
+    microAppName?: string;
+}
+declare const MBreadcrumb: React.FC<IMBreadcrumbProps>;
+export default MBreadcrumb;

package/dist/components/MDescriptions/index.d.ts

@@ -0,0 +1,65 @@
+import React from 'react';
+export interface IMDescriptionItem {
+    label: React.ReactNode;
+    value: React.ReactNode;
+    span?: number;
+}
+export interface IMDescriptionProps {
+    /**
+     * 描述列表的数据[{label: '', value: '',}, ...]
+     */
+    data: IMDescriptionItem[];
+    /**
+     * 标题
+     */
+    title?: React.ReactNode;
+    /**
+     * 需要显示的列数
+     * @default 3
+     */
+    column?: 1 | 2 | 3 | 4;
+    /**
+     * 行高
+     */
+    lineHeight?: number;
+    /**
+     * 标签对齐方式
+     * @default 'left'
+     */
+    align?: 'left' | 'center' | 'right';
+    /**
+     * 标签和值的布局配置
+     */
+    itemLayout?: {
+        label?: number | undefined;
+        value?: number | undefined;
+    };
+    /**
+     * 是否显示冒号
+     * @default true
+     */
+    colon?: boolean;
+    /**
+     * 是否显示边框
+     * @default false
+     */
+    bordered?: boolean;
+    /**
+     * 自定义样式
+     */
+    style?: React.CSSProperties;
+    /**
+     * 自定义类名
+     */
+    className?: string;
+    /**
+     * 标签样式
+     */
+    labelStyle?: React.CSSProperties;
+    /**
+     * 内容样式
+     */
+    contentStyle?: React.CSSProperties;
+}
+declare const DetailDescriptions: React.FC<IMDescriptionProps>;
+export default DetailDescriptions;

package/dist/components/MForm/MFormItemConst.d.ts

@@ -0,0 +1,27 @@
+import React from 'react';
+import { IMFormCascaderItem, IMFormChkBoxGroupItem, IMFormDatePickerItem, IMFormInputItem, IMFormInputNumItem, IMFormItem, IMFormMentionsItem, IMFormRadioGroupItem, IMFormRangePickerItem, IMFormSelectItem, IMFormSliderItem, IMFormTextItem, IMFormTreeSelectItem, IMFormUploadItem } from './type';
+export declare class MFormItemConst {
+    static readonly labelCol: {
+        span: number;
+    };
+    static readonly wrapperCol: {
+        span: number;
+    };
+    static readonly defaultRowGutter = 24;
+    static getDefaultArrayPlaceholder(item: IMFormItem): [string, string];
+    static getDefaultPlaceholder(item: IMFormItem): string | undefined;
+    static input: (item: IMFormInputItem) => React.JSX.Element;
+    static password: (item: IMFormInputItem) => React.JSX.Element;
+    static text: (item: IMFormTextItem) => React.JSX.Element;
+    static inputNumber: (item: IMFormInputNumItem) => React.JSX.Element;
+    static datePicker: (item: IMFormDatePickerItem) => React.JSX.Element;
+    static rangePicker: (item: IMFormRangePickerItem) => React.JSX.Element;
+    static select: (item: IMFormSelectItem) => React.JSX.Element;
+    static radio: (item: IMFormRadioGroupItem) => React.JSX.Element;
+    static checkbox: (item: IMFormChkBoxGroupItem) => React.JSX.Element;
+    static upload: (item: IMFormUploadItem) => React.JSX.Element;
+    static mentions: (item: IMFormMentionsItem) => React.JSX.Element;
+    static cascader: (item: IMFormCascaderItem) => React.JSX.Element;
+    static treeSelect: (item: IMFormTreeSelectItem) => React.JSX.Element;
+    static slider: (item: IMFormSliderItem) => React.JSX.Element;
+}

package/dist/components/MForm/index.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+import './index.scss';
+import { IMFormProps } from './type';
+declare function MForm(props: IMFormProps): React.JSX.Element;
+declare namespace MForm {
+    var displayName: string;
+}
+export default MForm;
+export * from './MFormItemConst';
+export * from './type';

package/dist/components/MForm/type.d.ts

@@ -0,0 +1,184 @@
+import { CascaderAutoProps, FormInstance, FormItemProps, FormProps, InputNumberProps, InputProps, MentionsProps, RadioGroupProps, RowProps, SelectProps, SliderSingleProps, TreeSelectProps, UploadProps } from 'antd';
+import { CheckboxGroupProps } from 'antd/es/checkbox';
+import { RangePickerProps } from 'antd/es/date-picker';
+import { Rule } from 'antd/es/form';
+import { TextAreaProps } from 'antd/es/input';
+import { SliderRangeProps } from 'antd/es/slider';
+import { DatePickerProps } from 'antd/lib';
+import { ReactElement } from 'react';
+export declare enum MFormItemTypeEnum {
+    Input = "input",
+    InputNumber = "inputNumber",
+    Text = "text",
+    Password = "password",
+    Radio = "radio",
+    Select = "select",
+    Checkbox = "checkbox",
+    DatePicker = "datePicker",
+    RangePicker = "rangePicker",
+    Upload = "upload",
+    Mentions = "mentions",
+    Cascader = "cascader",
+    TreeSelect = "treeSelect",
+    Slider = "slider"
+}
+export declare type MFormItemLayout = {
+    span?: number;
+    offset?: number;
+};
+export interface IMFormProps {
+    /**
+     * 一行显示几个label 默认1个, 其他：2, 3, 4
+     */
+    column?: 1 | 2 | 3 | 4;
+    /**
+     * 需要的数据: [ { label: ...,id: ..., required: ..., type: ..., ... }, ... ]
+     */
+    formItems: IMFormItem[];
+    /**
+     * Antd const [form] = useForm()
+     */
+    form?: FormInstance;
+    /**
+     * 表单其他属性
+     */
+    formProps?: FormProps;
+    /**
+     * 全局 MFormItem layout， 默认为 {labelCol:{span: 7}, wrapperCol: {span: 7}}
+     * @type {{labelCol: MFormItemLayout, wrapperCol: MFormItemLayout}}
+     * @memberof MFormItem
+     */
+    itemLayout?: {
+        labelCol?: MFormItemLayout;
+        wrapperCol?: MFormItemLayout;
+    };
+    /**
+     * Antd Row 的其他属性
+     */
+    formRowProps?: RowProps;
+}
+export interface IMFormBaseItem {
+    /**
+     * 属性名
+     */
+    id: string;
+    /**
+     * label名称
+     */
+    label: string;
+    /**
+     * 组件是否禁用
+     */
+    disabled?: boolean;
+    /**
+     * form类型 FORM_TYPE
+     */
+    type?: MFormItemTypeEnum;
+    /**
+     * 初始值
+     */
+    initialValue?: any;
+    /**
+     * rules required的验证消息， 不填写则不验证
+     */
+    required?: string;
+    /**
+     * rule-max, 正则，验证消息
+     */
+    rules?: Rule[];
+    /**
+     * 自定义form
+     */
+    render?: (form?: FormInstance) => ReactElement;
+    /**
+     * Antd MForm.Item 的其他属性
+     */
+    formItemProps?: FormItemProps;
+    /**
+     *  MFormItem layout， 默认为 {labelCol:{span: 7}, wrapperCol: {span: 7}}
+     * @type {{labelCol: MFormItemLayout, wrapperCol: MFormItemLayout}}
+     * @memberof MFormItem
+     */
+    itemLayout?: {
+        labelCol?: MFormItemLayout;
+        wrapperCol?: MFormItemLayout;
+    };
+    /**
+     * 当前表单占据行的宽度 1-24 默认 24 / column
+     */
+    span?: number;
+    /**
+     * 是否显示当前组件 默认显示
+     */
+    show?: boolean;
+    /**
+     * item组件的其他属性
+     */
+    props?: any;
+}
+export interface IMFormInputItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Input | MFormItemTypeEnum.Password;
+    props?: InputProps;
+    placeholder?: string;
+    maxLength?: number;
+}
+export interface IMFormInputNumItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.InputNumber;
+    props?: InputNumberProps;
+    placeholder?: string;
+    maxLength?: number;
+}
+export interface IMFormTextItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Text;
+    props?: TextAreaProps;
+    placeholder?: string;
+    maxLength?: number;
+}
+export interface IMFormRadioGroupItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Radio;
+    props?: RadioGroupProps;
+}
+export interface IMFormChkBoxGroupItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Checkbox;
+    props?: CheckboxGroupProps;
+}
+export interface IMFormSelectItem<T = any> extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Select;
+    placeholder?: string;
+    props?: SelectProps<T>;
+}
+export interface IMFormDatePickerItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.DatePicker;
+    placeholder?: string;
+    props?: DatePickerProps;
+}
+export interface IMFormRangePickerItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.RangePicker;
+    placeholder?: [string, string];
+    props?: RangePickerProps;
+}
+export interface IMFormUploadItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Upload;
+    children?: ReactElement;
+    props?: UploadProps;
+}
+export interface IMFormMentionsItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Mentions;
+    placeholder?: string;
+    props?: MentionsProps;
+}
+export interface IMFormCascaderItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Cascader;
+    placeholder?: string;
+    props?: CascaderAutoProps;
+}
+export interface IMFormTreeSelectItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.TreeSelect;
+    placeholder?: string;
+    props?: TreeSelectProps;
+}
+export interface IMFormSliderItem extends IMFormBaseItem {
+    type: MFormItemTypeEnum.Slider;
+    props?: SliderSingleProps | SliderRangeProps;
+}
+export declare type IMFormItem = IMFormInputItem | IMFormInputNumItem | IMFormSelectItem | IMFormChkBoxGroupItem | IMFormRadioGroupItem | IMFormTextItem | IMFormDatePickerItem | IMFormRangePickerItem | IMFormUploadItem | IMFormMentionsItem | IMFormCascaderItem | IMFormTreeSelectItem | IMFormSliderItem;

package/dist/components/MSearch/index.d.ts

@@ -0,0 +1,27 @@
+import { ButtonProps } from 'antd';
+import { FormInstance } from 'antd/lib';
+import React from 'react';
+import { IMFormItem } from '../MForm';
+import './index.scss';
+export interface IMSearchProps {
+    form?: FormInstance;
+    /**
+     * 需要的数据: [ { lable: ...,id: ..., required: ..., type: ..., }, ... ]
+     */
+    searchItems: IMFormItem[];
+    className?: string;
+    /**
+     * 搜索按钮 params返回form表单的数据
+     */
+    onSearch?: (params: any, isReset: boolean) => any;
+    /**
+     * 搜索项默认展开，不填写默认false
+     */
+    defaultShowAll?: boolean;
+    /**
+     * 自定义按钮
+     */
+    customButtons?: ButtonProps[];
+}
+declare const MSearch: React.FC<IMSearchProps>;
+export default MSearch;

package/dist/components/MTable/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 表格
+ */
+import { TableProps } from 'antd';
+import React from 'react';
+export interface IMTableProps extends TableProps {
+}
+declare function MTable(props: IMTableProps): React.JSX.Element;
+declare namespace MTable {
+    var displayName: string;
+}
+export default MTable;

package/dist/components/MiModal/index.d.ts

@@ -0,0 +1,16 @@
+import { ThemeConfig } from 'antd';
+import React, { Component } from 'react';
+import { IModalBaseProps } from '../../utils';
+export declare type IMiModalProps = IModalBaseProps & {
+    mode?: string;
+};
+declare class MiModal extends Component<IMiModalProps> {
+    static setMode: (mode: string) => void;
+    static setThemeConfig: (fn: (m: string) => ThemeConfig) => void;
+    static open: (props: IMiModalProps) => import("../../utils").IModalControls<IMiModalProps>;
+    getTheme(): ThemeConfig;
+    handleCancel: (e: React.MouseEvent<HTMLButtonElement>) => void;
+    handleOk: (e: React.MouseEvent<HTMLButtonElement>) => void;
+    render(): React.JSX.Element;
+}
+export default MiModal;

package/dist/components/ThemeContext/CompThemeProvider.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+interface IProps {
+    children: React.ReactNode;
+}
+declare function CompThemeProvider(props: IProps): React.JSX.Element;
+declare namespace CompThemeProvider {
+    var displayName: string;
+}
+export default CompThemeProvider;

package/dist/components/ThemeContext/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { ThemeConfig } from 'antd';
+interface ThemeContextType {
+    theme?: ThemeConfig;
+}
+export declare const MiThemeProvider: import("react").Provider<ThemeContextType>;
+export declare function useMiThemeConfig(): ThemeContextType;
+export * from './CompThemeProvider';

package/dist/components/index.d.ts

@@ -0,0 +1,9 @@
+export { default as ItemRow } from './ItemsRow';
+export { default as MBreadcrumb } from './MBreadcrumb';
+export { default as MDescriptions } from './MDescriptions';
+export * from './MForm';
+export { default as MForm } from './MForm';
+export { default as MiModal } from './MiModal';
+export { default as MSearch } from './MSearch';
+export { default as MTable } from './MTable';
+export * from './ThemeContext';

package/dist/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from './useFuncRequest';
+export * from './useInterval';
+export * from './usePagination';
+export * from './useQuery';
+export * from './useReactive';
+export * from './useTimeout';
+export * from './useVirtualList';

package/dist/hooks/useFuncRequest.d.ts

@@ -0,0 +1,16 @@
+declare type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
+export declare type UseFuncRequestOptions<T extends (...args: any[]) => Promise<any>> = {
+    autoRunArgs?: Parameters<T>;
+    onBefore?: (...args: Parameters<T>) => boolean | Promise<boolean>;
+    onSuccess?: (data: UnwrapPromise<ReturnType<T>>) => void | Promise<void>;
+    onError?: (error: Error) => void | Promise<void>;
+    onFinally?: () => void | Promise<void>;
+};
+export declare function useFuncRequest<T extends (...args: any[]) => Promise<any>>(asyncFunc: T, options?: UseFuncRequestOptions<T>): {
+    run: (...args: Parameters<T>) => Promise<any>;
+    cancel: () => void;
+    loading: boolean;
+    error: Error | null;
+    data: UnwrapPromise<ReturnType<T>> | null;
+};
+export {};

package/dist/hooks/useInterval.d.ts

@@ -0,0 +1,8 @@
+declare type Callback = () => void;
+interface UseTimeoutReturn {
+    start: Callback;
+    isRunning: boolean;
+    clear: Callback;
+}
+declare function useInterval(callback: Callback, delay: number | null, immediate?: boolean): UseTimeoutReturn;
+export { useInterval };

package/dist/hooks/usePagination.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="react" />
+interface IPaginationProps {
+    current: number;
+    pageSize: number;
+    total: number;
+    onChange: (page: number, pageSize: number) => Promise<void>;
+    onShowSizeChange: (size: number, current: number) => Promise<void>;
+    showTotal?: (t: number) => React.ReactNode;
+    showQuickJumper?: boolean;
+    showSizeChanger?: boolean;
+}
+interface PaginationResult<T> {
+    tableProps: {
+        loading?: boolean;
+        dataSource: T[];
+    };
+    loading?: boolean;
+    dataSource: T[];
+    paginationProps: IPaginationProps;
+    isFirstComplete: boolean;
+    refresh: (resetPage?: boolean) => Promise<void>;
+    debounceRefresh: (resetPage?: boolean) => void;
+    setDataSource: (data: T[]) => void;
+}
+interface IServerParams {
+    offset: number;
+    limit: number;
+    current: number;
+}
+declare type IInfoBack<T> = {
+    dataSource: T[];
+    total: number;
+};
+declare type IInfoServer<T> = (params: IServerParams) => IInfoBack<T> | Promise<IInfoBack<T>>;
+interface IInfoOption<T> {
+    isReady?: boolean;
+    dataSource?: T[];
+    current?: number;
+    pageSize?: number;
+}
+export declare const usePagination: <T>(server: IInfoServer<T>, deps?: any[] | undefined, option?: IInfoOption<T> | undefined) => PaginationResult<T>;
+export {};

package/dist/hooks/useQuery.d.ts

@@ -0,0 +1,3 @@
+export declare function useQuery(): {
+    [k: string]: string;
+};

package/dist/hooks/useReactive.d.ts

@@ -0,0 +1,2 @@
+declare const useReactive: <T extends object>(initialState: T) => readonly [T, (newState: Partial<T> | ((prev: T) => Partial<T>)) => void, () => T, () => void];
+export { useReactive };

package/dist/hooks/useTimeout.d.ts

@@ -0,0 +1,8 @@
+declare type Callback = () => void;
+interface UseTimeoutReturn {
+    start: Callback;
+    isRunning: boolean;
+    clear: Callback;
+}
+declare function useTimeout(callback: Callback, delay: number | null, immediate?: boolean): UseTimeoutReturn;
+export { useTimeout };

package/dist/hooks/useVirtualList.d.ts

@@ -0,0 +1,74 @@
+import { DependencyList } from 'react';
+export interface IPaginationResult<T> {
+    /**
+     * 数据
+     *
+     * @memberof IPaginationResult
+     */
+    dataSource: T[];
+    /**
+     * 加载状态
+     *
+     * @memberof IPaginationResult
+     */
+    loading?: boolean;
+    /**
+     * 是否完成了一次请求
+     *
+     * @memberof IPaginationResult
+     */
+    isFirstComplete: boolean;
+    /**
+     * 分页信息
+     *
+     * @memberof IPaginationResult
+     */
+    paginationProps: {
+        current: number;
+        pageSize: number;
+        total: number;
+    };
+    /**
+     * reset 是否重置查询
+     *
+     * @memberof IPaginationResult
+     */
+    refresh: (reset?: boolean) => Promise<void>;
+    debounceRefresh: (reset?: boolean) => void;
+    setDataSource: (data: T[]) => void;
+    setTotal: (total: number) => void;
+}
+interface IServerParams {
+    offset: number;
+    limit: number;
+    current: number;
+}
+declare type IInfoBack<T> = {
+    dataSource: T[];
+    total: number;
+};
+declare type IInfoServer<T> = (params: IServerParams) => IInfoBack<T> | Promise<IInfoBack<T>>;
+interface IInfoOption<T> {
+    /**
+     * 第一次是否执行server
+     *
+     */
+    isReady?: boolean;
+    /**
+     * 默认的数据
+     *
+     */
+    dataSource?: T[];
+    /**
+     * 默认当前第几页
+     *
+     */
+    current?: number;
+    /**
+     * 默认一页几条数据
+     *
+     */
+    pageSize?: number;
+}
+export declare const useVirtualList: <T>(server: IInfoServer<T>, deps?: DependencyList | undefined, option?: IInfoOption<T> | undefined) => IPaginationResult<T>;
+export {};

package/dist/index.d.ts

@@ -1,2 +1,4 @@
+export * from './components';
 export * from './constants';
+export * from './hooks';
 export * from './utils';