@mi-avalon/libs 0.0.5 → 0.0.7

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Avalon MI
+Copyright (c) 2025 顾冬杰
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,3 +1,160 @@
-# @mi-avalon/libs
+# TSDX React User Guide
 
-This is the library package for the mi-avalon project.
+Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+
+> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
+
+> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
+
+## Commands
+
+TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
+
+The recommended workflow is to run TSDX in one terminal:
+
+```bash
+npm start # or yarn start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+Then run the example inside another:
+
+```bash
+cd example
+npm i # or yarn to install dependencies
+npm start # or yarn start
+```
+
+The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
+
+To do a one-off build, use `npm run build` or `yarn build`.
+
+To run tests, use `npm test` or `yarn test`.
+
+## Configuration
+
+Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
+
+### Jest
+
+Jest tests are set up to run with `npm test` or `yarn test`.
+
+### Bundle analysis
+
+Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
+
+#### Setup Files
+
+This is the folder structure we set up for you:
+
+```txt
+/example
+  index.html
+  index.tsx       # test your component here in a demo app
+  package.json
+  tsconfig.json
+/src
+  index.tsx       # EDIT THIS
+/test
+  blah.test.tsx   # EDIT THIS
+.gitignore
+package.json
+README.md         # EDIT THIS
+tsconfig.json
+```
+
+#### React Testing Library
+
+We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
+
+### Rollup
+
+TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+
+### TypeScript
+
+`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+
+## Continuous Integration
+
+### GitHub Actions
+
+Two actions are added by default:
+
+- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
+- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
+
+## Optimizations
+
+Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
+
+```js
+// ./types/index.d.ts
+declare var __DEV__: boolean;
+
+// inside your code...
+if (__DEV__) {
+  console.log('foo');
+}
+```
+
+You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+
+## Module Formats
+
+CJS, ESModules, and UMD module formats are supported.
+
+The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+
+## Deploying the Example Playground
+
+The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
+
+```bash
+cd example # if not already in the example folder
+npm run build # builds to dist
+netlify deploy # deploy the dist folder
+```
+
+Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
+
+```bash
+netlify init
+# build command: yarn build && cd example && yarn && yarn build
+# directory to deploy: example/dist
+# pick yes for netlify.toml
+```
+
+## Named Exports
+
+Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+
+## Including Styles
+
+There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
+
+For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
+
+## Publishing to NPM
+
+We recommend using [np](https://github.com/sindresorhus/np).
+
+## Usage with Lerna
+
+When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
+
+The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
+
+Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
+
+```diff
+   "alias": {
+-    "react": "../node_modules/react",
+-    "react-dom": "../node_modules/react-dom"
++    "react": "../../../node_modules/react",
++    "react-dom": "../../../node_modules/react-dom"
+   },
+```
+
+An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)

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

@@ -1 +1,9 @@
-export * from './MyButton';
+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/constants/date.d.ts

@@ -0,0 +1,11 @@
+export declare const DATE_FORMAT: {
+    YMD_Hms: string;
+    YMD: string;
+    YMD2: string;
+    YMD_POINT: string;
+    Hms: string;
+    Hm: string;
+    YMD_000: string;
+    YMD_end: string;
+    YMD_Hm: string;
+};

package/dist/constants/index.d.ts

@@ -0,0 +1,3 @@
+export * from './date';
+export * from './pageInfo';
+export * from './pattern';

package/dist/constants/pageInfo.d.ts

@@ -0,0 +1 @@
+export declare const PAGE_SIZE = 10;

package/dist/constants/pattern.d.ts

@@ -0,0 +1,24 @@
+export declare class PatternType {
+    static readonly integerRegex: RegExp;
+    static readonly positiveIntegerRegex: RegExp;
+    static readonly negativeIntegerRegex: RegExp;
+    static readonly floatRegex: RegExp;
+    static readonly letter: RegExp;
+    static readonly chinese: RegExp;
+    static readonly number: RegExp;
+    static readonly username: RegExp;
+    static readonly strongUsername: RegExp;
+    static readonly password: RegExp;
+    static readonly strongPassword: RegExp;
+    static readonly phone: RegExp;
+    static readonly phoneWithAreaCode: RegExp;
+    static readonly email: RegExp;
+    static readonly idCard: RegExp;
+    static readonly bankCard: RegExp;
+    static readonly zipCode: RegExp;
+    static readonly ip: RegExp;
+    static readonly url: RegExp;
+    static readonly carNumber: RegExp;
+    static readonly time: RegExp;
+    static readonly date: RegExp;
+}

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';