@agentscope-ai/design 1.0.19 → 1.0.20

package/llms/components/commonComponents/Image/index.zh-CN.llms.txt

@@ -0,0 +1,165 @@
+
+
+<DemoTitle title="Image" desc="可预览的图片">
+#### API
+
+<AntdApiRef url="https://ant.design/components/image-cn/#api"></AntdApiRef>
+
+
+## antd API
+
+通用属性参考：[通用属性](/docs/react/common-props)
+
+### Image
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| alt | 图像描述 | string | - | 4.6.0 | 
+| fallback | 加载失败容错地址 | string | - | 4.6.0 | 
+| height | 图像高度 | string \| number | - | 4.6.0 | 
+| placeholder | 加载占位，为  | ReactNode | - | 4.6.0 | 
+| preview | 预览参数，为  | boolean \|  | true | 4.6.0  | 
+| src | 图片地址 | string | - | 4.6.0 | 
+| width | 图像宽度 | string \| number | - | 4.6.0 | 
+| onError | 加载错误回调 | (event: Event) => void | - | 4.12.0 | 
+
+
+其他属性见 [<img>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#Attributes)
+
+### PreviewType
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| visible | 是否显示 | boolean | - | - | 
+| src | 自定义预览 src | string | - | 4.10.0 | 
+| getContainer | 指定预览挂载的节点，但依旧为全屏展示，false 为挂载在当前位置 | string \| HTMLElement \| (() => HTMLElement) \| false | - | 4.8.0 | 
+| movable | 是否可移动 | boolean | true | 5.8.0 | 
+| mask | 缩略图遮罩 | ReactNode | - | 4.9.0 | 
+| maskClassName | 缩略图遮罩类名 | string | - | 4.11.0 | 
+| rootClassName | 预览图的根 DOM 类名 | string | - | 5.4.0 | 
+| scaleStep | 1 + scaleStep | number | 0.5 | - | 
+| minScale | 最小缩放倍数 | number | 1 | 5.7.0 | 
+| maxScale | 最大放大倍数 | number | 50 | 5.7.0 | 
+| closeIcon | 自定义关闭 Icon | React.ReactNode | - | 5.7.0 | 
+| forceRender | 强制渲染预览图 | boolean | - | - | 
+| toolbarRender | 自定义工具栏 | (originalNode: React.ReactElement, info: Omit< | - | 5.7.0,  | 
+| imageRender | 自定义预览内容 | (originalNode: React.ReactElement, info: { transform:  | - | 5.7.0, image: 5.18.0 | 
+| destroyOnHidden | 关闭预览时销毁子元素 | boolean | false | 5.25.0 | 
+| onTransform | 预览图 transform 变化的回调 | { transform:  | - | 5.7.0 | 
+| onVisibleChange | 当  | (visible: boolean, prevVisible: boolean) => void | - | - | 
+
+
+## PreviewGroup
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| preview | 预览参数，为  | boolean \|  | true | 4.6.0  | 
+| items | 预览数组 | string[] \| { src: string, crossOrigin: string, ... }[] | - | 5.7.0 | 
+| fallback | 加载失败容错地址 | string | - | 5.7.0 | 
+
+
+### PreviewGroupType
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| visible | 是否显示 | boolean | - | - | 
+| getContainer | 指定预览挂载的节点，但依旧为全屏展示，false 为挂载在当前位置 | string \| HTMLElement \| (() => HTMLElement) \| false | - | 4.8.0 | 
+| movable | 是否可移动 | boolean | true | 5.8.0 | 
+| current | 当前预览图的 index | number | - | 4.12.0 | 
+| mask | 缩略图遮罩 | ReactNode | - | 4.9.0 | 
+| maskClassName | 缩略图遮罩类名 | string | - | 4.11.0 | 
+| scaleStep | 1 + scaleStep | number | 0.5 | - | 
+| minScale | 最小缩放倍数 | number | 1 | 5.7.0 | 
+| maxScale | 最大放大倍数 | number | 50 | 5.7.0 | 
+| closeIcon | 自定义关闭 Icon | React.ReactNode | - | 5.7.0 | 
+| forceRender | 强制渲染预览图 | boolean | - | - | 
+| countRender | 自定义预览计数内容 | (current: number, total: number) => React.ReactNode | - | 4.20.0 | 
+| toolbarRender | 自定义工具栏 | (originalNode: React.ReactElement, info:  | - | 5.7.0,  | 
+| imageRender | 自定义预览内容 | (originalNode: React.ReactElement, info: { transform:  | - | 5.7.0, image: 5.18.0 | 
+| onTransform | 预览图 transform 变化的回调 | { transform:  | - | 5.7.0 | 
+| onChange | 切换预览图的回调 | (current: number, prevCurrent: number) => void | - | 5.3.0 | 
+| onVisibleChange | 当  | (visible: boolean, prevVisible: boolean, current: number) => void | - | current 参数 5.3.0 | 
+
+
+## Interface
+
+### TransformType
+
+
+```typescript
+{
+  x: number;
+  y: number;
+  rotate: number;
+  scale: number;
+  flipX: boolean;
+  flipY: boolean;
+}
+```
+
+
+### TransformAction
+
+
+```typescript
+type TransformAction =
+  | 'flipY'
+  | 'flipX'
+  | 'rotateLeft'
+  | 'rotateRight'
+  | 'zoomIn'
+  | 'zoomOut'
+  | 'close'
+  | 'prev'
+  | 'next'
+  | 'wheel'
+  | 'doubleClick'
+  | 'move'
+  | 'dragRebound'
+  | 'reset';
+```
+
+
+### ToolbarRenderInfoType
+
+
+```typescript
+{
+  icons: {
+    flipYIcon: React.ReactNode;
+    flipXIcon: React.ReactNode;
+    rotateLeftIcon: React.ReactNode;
+    rotateRightIcon: React.ReactNode;
+    zoomOutIcon: React.ReactNode;
+    zoomInIcon: React.ReactNode;
+  };
+  actions: {
+    onActive?: (index: number) => void; // 5.21.0 之后支持
+    onFlipY: () => void;
+    onFlipX: () => void;
+    onRotateLeft: () => void;
+    onRotateRight: () => void;
+    onZoomOut: () => void;
+    onZoomIn: () => void;
+    onReset: () => void; // 5.17.3 之后支持
+    onClose: () => void;
+  };
+  transform: TransformType,
+  current: number;
+  total: number;
+  image: ImgInfo
+}
+```
+
+
+### ImgInfo
+
+
+```typescript
+{
+  url: string;
+  alt: string;
+  width: string | number;
+  height: string | number;
+}
+```

package/llms/components/commonComponents/Input/index.zh-CN.llms.txt

@@ -0,0 +1,133 @@
+
+
+<DemoTitle title="Input" desc="通过鼠标或键盘输入内容，为表单提供输入字段的基础容器。。">
+#### API
+
+| 属性名 | 描述 | 类型 | 默认值 | 
+|--------|--------|--------|--------|
+| shape | 形态 | 'default' \| 'round' | default 默认 | 
+
+
+<AntdApiRef url="https://ant.design/components/input-cn/#api"></AntdApiRef>
+
+
+## antd API
+
+通用属性参考：[通用属性](/docs/react/common-props)
+
+### Input
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| addonAfter | 带标签的 input，设置后置标签 | ReactNode | - |  | 
+| addonBefore | 带标签的 input，设置前置标签 | ReactNode | - |  | 
+| allowClear | 可以点击清除图标删除内容 | boolean \| { clearIcon: ReactNode } | - |  | 
+| classNames | 语义化结构 class | Record< | - | 5.4.0 | 
+| count | 字符计数配置 |  | - | 5.10.0 | 
+| defaultValue | 输入框默认内容 | string | - |  | 
+| disabled | 是否禁用状态，默认为 false | boolean | false |  | 
+| id | 输入框的 id | string | - |  | 
+| maxLength | 最大长度 | number | - |  | 
+| prefix | 带有前缀图标的 input | ReactNode | - |  | 
+| showCount | 是否展示字数 | boolean \| { formatter: (info: { value: string, count: number, maxLength?: number }) => ReactNode } | false | 4.18.0 info.value: 4.23.0 | 
+| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | 
+| styles | 语义化结构 style | Record< | - | 5.4.0 | 
+| size | 控件大小。注：标准表单内的输入框大小限制为  | large | - |  | 
+| suffix | 带有后缀图标的 input | ReactNode | - |  | 
+| type | 声明 input 类型，同原生 input 标签的 type 属性，见： | string | text |  | 
+| value | 输入框内容 | string | - |  | 
+| variant | 形态变体 | outlined | outlined | 5.13.0 \|  | 
+| onChange | 输入框内容变化时的回调 | function(e) | - |  | 
+| onPressEnter | 按下回车的回调 | function(e) | - |  | 
+| onClear | 按下清除按钮的回调 | () => void | - | 5.20.0 | 
+
+
+如果 `Input` 在 `Form.Item` 内，并且 `Form.Item` 设置了 `id` 属性，则 `value` `defaultValue` 和 `id` 属性会被自动设置。
+
+Input 的其他属性和 React 自带的 [input](https://reactjs.org/docs/dom-elements.html#all-supported-html-attributes) 一致。
+
+#### CountConfig
+
+
+```tsx
+interface CountConfig {
+  // 最大字符数，不同于原生 `maxLength`，超出后标红但不会截断
+  max?: number;
+  // 自定义字符计数，例如标准 emoji 长度大于 1，可以自定义计数策略将其改为 1
+  strategy?: (value: string) => number;
+  // 同 `showCount`
+  show?: boolean | ((args: { value: string; count: number; maxLength?: number }) => ReactNode);
+  // 当字符数超出 `count.max` 时的自定义裁剪逻辑，不配置时不进行裁剪
+  exceedFormatter?: (value: string, config: { max: number }) => string;
+}
+```
+
+
+### Input.TextArea
+
+同 Input 属性，外加：
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| autoSize | 自适应内容高度，可设置为 true \| false 或对象：{ minRows: 2, maxRows: 6 } | boolean \| object | false |  | 
+| classNames | 语义化结构 class | Record< | - | 5.4.0 | 
+| styles | 语义化结构 style | Record< | - | 5.4.0 | 
+
+
+`Input.TextArea` 的其他属性和浏览器自带的 [textarea](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea) 一致。
+
+### Input.Search
+
+| 参数 | 说明 | 类型 | 默认值 | 
+|--------|--------|--------|--------|
+| enterButton | 是否有确认按钮，可设为按钮文字。该属性会与  | ReactNode | false | 
+| loading | 搜索 loading | boolean | false | 
+| onSearch | 点击搜索图标、清除图标，或按下回车键时的回调 | function(value, event, { source: "input" \| "clear" }) | - | 
+
+
+其余属性和 Input 一致。
+
+### Input.Password
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| iconRender | 自定义切换按钮 | (visible) => ReactNode | (visible) => (visible ?  : ) | 4.3.0 | 
+| visibilityToggle | 是否显示切换按钮或者控制密码显隐 | boolean \|  | true |  | 
+
+
+### Input.OTP
+
+`5.16.0` 新增。
+
+开发者注意事项：当 `mask` 属性的类型为 string 时，我们强烈推荐接收单个字符或单个 emoji，如果传入多个字符或多个 emoji，则会在控制台抛出警告。
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| defaultValue | 默认值 | string | - |  | 
+| disabled | 是否禁用 | boolean | false |  | 
+| formatter | 格式化展示，留空字段会被  | (value: string) => string | - |  | 
+| separator | 分隔符，在指定索引的输入框后渲染分隔符 | ReactNode \|((i: number) => ReactNode) | - | 5.24.0 | 
+| mask | 自定义展示，和  | boolean \| string | false | 5.17.0 | 
+| length | 输入元素数量 | number | 6 |  | 
+| status | 设置校验状态 | 'error' \| 'warning' | - |  | 
+| size | 输入框大小 | small | middle |  | 
+| variant | 形态变体 | outlined | outlined | underlined | 
+| value | 输入框内容 | string | - |  | 
+| onChange | 当输入框内容全部填充时触发回调 | (value: string) => void | - |  | 
+| onInput | 输入值变化时触发的回调 | (value: string[]) => void | - | 5.22.0 | 
+
+
+#### VisibilityToggle
+
+| Property | Description | Type | Default | Version | 
+|--------|--------|--------|--------|--------|
+| visible | 用于手动控制密码显隐 | boolean | false | 4.24 | 
+| onVisibleChange | 显隐密码的回调 | (visible) => void | - | 4.24 | 
+
+
+#### Input Methods
+
+| 名称 | 说明 | 参数 | 版本 | 
+|--------|--------|--------|--------|
+| blur | 取消焦点 | - |  | 
+| focus | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | option - 4.10.0 | 

package/llms/components/commonComponents/InputNumber/index.zh-CN.llms.txt

@@ -0,0 +1,51 @@
+
+
+<DemoTitle title="InputNumber" desc="通过鼠标或键盘，输入范围内的数值。">
+#### API
+
+<AntdApiRef url="https://ant.design/components/input-number-cn/#api"></AntdApiRef>
+
+
+## antd API
+
+通用属性参考：[通用属性](/docs/react/common-props)
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| addonAfter | 带标签的 input，设置后置标签 | ReactNode | - | 4.17.0 | 
+| addonBefore | 带标签的 input，设置前置标签 | ReactNode | - | 4.17.0 | 
+| autoFocus | 自动获取焦点 | boolean | false | - | 
+| changeOnBlur | 是否在失去焦点时，触发  | boolean | true | 5.11.0 | 
+| changeOnWheel | 允许鼠标滚轮改变数值 | boolean | - | 5.14.0 | 
+| controls | 是否显示增减按钮，也可设置自定义箭头图标 | boolean \| { upIcon?: React.ReactNode; downIcon?: React.ReactNode; } | - | 4.19.0 | 
+| decimalSeparator | 小数点 | string | - | - | 
+| placeholder | 占位符 | string | - |  | 
+| defaultValue | 初始值 | number | - | - | 
+| disabled | 禁用 | boolean | false | - | 
+| formatter | 指定输入框展示值的格式 | function(value: number \| string, info: { userTyping: boolean, input: string }): string | - | info: 4.17.0 | 
+| keyboard | 是否启用键盘快捷行为 | boolean | true | 4.12.0 | 
+| max | 最大值 | number |  | - | 
+| min | 最小值 | number |  | - | 
+| parser | 指定从  | function(string): number | - | - | 
+| precision | 数值精度，配置  | number | - | - | 
+| readOnly | 只读 | boolean | false | - | 
+| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | 
+| prefix | 带有前缀图标的 input | ReactNode | - | 4.17.0 | 
+| suffix | 带有后缀图标的 input | ReactNode | - | 5.20.0 | 
+| size | 输入框大小 | large | - | - | 
+| step | 每次改变步数，可以为小数 | number \| string | 1 | - | 
+| stringMode | 字符值模式，开启后支持高精度小数。同时  | boolean | false | 4.13.0 | 
+| value | 当前值 | number | - | - | 
+| variant | 形态变体 | outlined | outlined | 5.13.0 \|  | 
+| onChange | 变化回调 | function(value: number \| string \| null) | - | - | 
+| onPressEnter | 按下回车的回调 | function(e) | - | - | 
+| onStep | 点击上下箭头的回调 | (value: number, info: { offset: number, type: 'up' \| 'down' }) => void | - | 4.7.0 | 
+
+
+## Ref
+
+| 名称 | 说明 | 参数 | 版本 | 
+|--------|--------|--------|--------|
+| blur() | 移除焦点 | - |  | 
+| focus() | 获取焦点 | (option?: { preventScroll?: boolean, cursor?: 'start' \| 'end' \| 'all' }) | cursor - 5.22.0 | 
+| nativeElement | 获取原生 DOM 元素 | - | 5.17.3 | 

package/llms/components/commonComponents/Message/index.zh-CN.llms.txt

@@ -0,0 +1,98 @@
+
+
+<DemoTitle title="Message" desc="一条简洁且临时显示的消息，为操作提供全局反馈">
+#### API
+
+| 属性名 | 描述 | 类型 | 默认值 | 
+|--------|--------|--------|--------|
+| conent | 显示的内容 | string | "" | 
+
+<AntdApiRef url="https://ant.design/components/message-cn/#api"></AntdApiRef>
+
+
+## antd API
+
+通用属性参考：[通用属性](/docs/react/common-props)
+
+组件提供了一些静态方法，使用方式和参数如下：
+
+
+- `message.success(content, [duration], onClose)`
+- `message.error(content, [duration], onClose)`
+- `message.info(content, [duration], onClose)`
+- `message.warning(content, [duration], onClose)`
+- `message.loading(content, [duration], onClose)`
+
+| 参数 | 说明 | 类型 | 默认值 | 
+|--------|--------|--------|--------|
+| content | 提示内容 | ReactNode \| config | - | 
+| duration | 自动关闭的延时，单位秒。设为 0 时不自动关闭 | number | 3 | 
+| onClose | 关闭时触发的回调函数 | function | - | 
+
+
+组件同时提供 promise 接口。
+
+
+- `message[level](content, [duration]).then(afterClose)`
+- `message[level](content, [duration], onClose).then(afterClose)`
+
+其中 `message[level]` 是组件已经提供的静态方法。`then` 接口返回值是 Promise。
+
+也可以对象的形式传递参数：
+
+
+- `message.open(config)`
+- `message.success(config)`
+- `message.error(config)`
+- `message.info(config)`
+- `message.warning(config)`
+- `message.loading(config)`
+
+`config` 对象属性如下：
+
+| 参数 | 说明 | 类型 | 默认值 | 
+|--------|--------|--------|--------|
+| className | 自定义 CSS class | string | - | 
+| content | 提示内容 | ReactNode | - | 
+| duration | 自动关闭的延时，单位秒。设为 0 时不自动关闭 | number | 3 | 
+| icon | 自定义图标 | ReactNode | - | 
+| key | 当前提示的唯一标志 | string \| number | - | 
+| style | 自定义内联样式 |  | - | 
+| onClick | 点击 message 时触发的回调函数 | function | - | 
+| onClose | 关闭时触发的回调函数 | function | - | 
+
+
+### 全局方法
+
+还提供了全局配置和全局销毁方法：
+
+
+- `message.config(options)`
+- `message.destroy()`
+
+也可通过 `message.destroy(key)` 来关闭一条消息。
+
+#### message.config
+
+当你使用 `ConfigProvider` 进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)当你想单独使用，可通过如下设置开启 RTL 模式。
+
+
+```js
+message.config({
+  top: 100,
+  duration: 2,
+  maxCount: 3,
+  rtl: true,
+  prefixCls: 'my-message',
+});
+```
+
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| duration | 默认自动关闭延时，单位秒 | number | 3 |  | 
+| getContainer | 配置渲染节点的输出位置，但依旧为全屏展示 | () => HTMLElement | () => document.body |  | 
+| maxCount | 最大显示数，超过限制时，最早的消息会被自动关闭 | number | - |  | 
+| prefixCls | 消息节点的 className 前缀 | string | ant-message | 4.5.0 | 
+| rtl | 是否开启 RTL 模式 | boolean | false |  | 
+| top | 消息距离顶部的位置 | string \| number | 8 |  | 

package/llms/components/commonComponents/Modal/index.zh-CN.llms.txt

@@ -0,0 +1,168 @@
+
+
+<DemoTitle title="Modal" desc="用于叠加当前页面上的对话框窗口，提供标题、内容区、操作区。">
+#### API
+
+| 属性名 | 描述 | 类型 | 默认值 | 
+|--------|--------|--------|--------|
+| info | 底部额外内容 | string \| React.ReactNode |  | 
+| showDivider | 是否显示分割线 | boolean | true | 
+
+<AntdApiRef url="https://ant.design/components/modal-cn/#api"></AntdApiRef>
+
+
+## antd API
+
+通用属性参考：[通用属性](/docs/react/common-props)
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| afterClose | Modal 完全关闭后的回调 | function | - |  | 
+| classNames | 配置弹窗内置模块的 className |  | - |  | 
+| styles | 配置弹窗内置模块的 style |  | - | 5.10.0 | 
+| cancelButtonProps | cancel 按钮 props |  | - |  | 
+| cancelText | 取消按钮文字 | ReactNode | 取消 |  | 
+| centered | 垂直居中展示 Modal | boolean | false |  | 
+| closable | 是否显示右上角的关闭按钮 | boolean \| { closeIcon?: React.ReactNode; disabled?: boolean; } | true |  | 
+| closeIcon | 自定义关闭图标。5.7.0：设置为  | ReactNode |  |  | 
+| confirmLoading | 确定按钮 loading | boolean | false |  | 
+| destroyOnHidden | 关闭时销毁 Modal 里的子元素 | boolean | false | 5.25.0 | 
+| focusTriggerAfterClose | 对话框关闭后是否需要聚焦触发元素 | boolean | true | 4.9.0 | 
+| footer | 底部内容，当不需要默认底部按钮时，可以设为  | ReactNode \| (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | (确定取消按钮) | renderFunction: 5.9.0 | 
+| forceRender | 强制渲染 Modal | boolean | false |  | 
+| getContainer | 指定 Modal 挂载的节点，但依旧为全屏展示， | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body |  | 
+| keyboard | 是否支持键盘 esc 关闭 | boolean | true |  | 
+| mask | 是否展示遮罩 | boolean | true |  | 
+| maskClosable | 点击蒙层是否允许关闭 | boolean | true |  | 
+| modalRender | 自定义渲染对话框 | (node: ReactNode) => ReactNode | - | 4.7.0 | 
+| okButtonProps | ok 按钮 props |  | - |  | 
+| okText | 确认按钮文字 | ReactNode | 确定 |  | 
+| okType | 确认按钮类型 | string | primary |  | 
+| style | 可用于设置浮层的样式，调整浮层位置等 | CSSProperties | - |  | 
+| loading | 显示骨架屏 | boolean |  | 5.18.0 | 
+| title | 标题 | ReactNode | - |  | 
+| open | 对话框是否可见 | boolean | - |  | 
+| width | 宽度 | string \| number \|  | 520 | Breakpoint: 5.23.0 | 
+| wrapClassName | 对话框外层容器的类名 | string | - |  | 
+| zIndex | 设置 Modal 的  | number | 1000 |  | 
+| onCancel | 点击遮罩层或右上角叉或取消按钮的回调 | function(e) | - |  | 
+| onOk | 点击确定回调 | function(e) | - |  | 
+| afterOpenChange | 打开和关闭 Modal 时动画结束后的回调 | (open: boolean) => void | - | 5.4.0 | 
+
+
+#### 注意
+
+
+- `<Modal />` 默认关闭后状态不会自动清空，如果希望每次打开都是新内容，请设置 `destroyOnHidden`。
+- `<Modal />` 和 Form 一起配合使用时，设置 `destroyOnHidden` 也不会在 Modal 关闭时销毁表单字段数据，需要设置 `<Form preserve={false} />`。
+- `Modal.method()` RTL 模式仅支持 hooks 用法。
+
+### Modal.method()
+
+包括：
+
+
+- `Modal.info`
+- `Modal.success`
+- `Modal.error`
+- `Modal.warning`
+- `Modal.confirm`
+
+以上均为一个函数，参数为 object，具体属性如下：
+
+| 参数 | 说明 | 类型 | 默认值 | 版本 | 
+|--------|--------|--------|--------|--------|
+| afterClose | Modal 完全关闭后的回调 | function | - | 4.9.0 | 
+| autoFocusButton | 指定自动获得焦点的按钮 | null \|  | ok |  | 
+| cancelButtonProps | cancel 按钮 props |  | - |  | 
+| cancelText | 设置 Modal.confirm 取消按钮文字 | string | 取消 |  | 
+| centered | 垂直居中展示 Modal | boolean | false |  | 
+| className | 容器类名 | string | - |  | 
+| closable | 是否显示右上角的关闭按钮 | boolean | false | 4.9.0 | 
+| closeIcon | 自定义关闭图标 | ReactNode | undefined | 4.9.0 | 
+| content | 内容 | ReactNode | - |  | 
+| footer | 底部内容，当不需要默认底部按钮时，可以设为  | ReactNode \| (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | - | renderFunction: 5.9.0 | 
+| getContainer | 指定 Modal 挂载的 HTML 节点，false 为挂载在当前 dom | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body |  | 
+| icon | 自定义图标 | ReactNode |  |  | 
+| keyboard | 是否支持键盘 esc 关闭 | boolean | true |  | 
+| mask | 是否展示遮罩 | boolean | true |  | 
+| maskClosable | 点击蒙层是否允许关闭 | boolean | false |  | 
+| okButtonProps | ok 按钮 props |  | - |  | 
+| okText | 确认按钮文字 | string | 确定 |  | 
+| okType | 确认按钮类型 | string | primary |  | 
+| style | 可用于设置浮层的样式，调整浮层位置等 | CSSProperties | - |  | 
+| title | 标题 | ReactNode | - |  | 
+| width | 宽度 | string \| number | 416 |  | 
+| wrapClassName | 对话框外层容器的类名 | string | - | 4.18.0 | 
+| zIndex | 设置 Modal 的  | number | 1000 |  | 
+| onCancel | 点击取消回调，参数为关闭函数，若返回 promise 时 resolve 为正常关闭, reject 为不关闭 | function(close) | - |  | 
+| onOk | 点击确定回调，参数为关闭函数，若返回 promise 时 resolve 为正常关闭, reject 为不关闭 | function(close) | - |  | 
+
+
+以上函数调用后，会返回一个引用，可以通过该引用更新和关闭弹窗。
+
+
+```jsx
+const modal = Modal.info();
+
+modal.update({
+  title: '修改的标题',
+  content: '修改的内容',
+});
+
+// 在 4.8.0 或更高版本中，可以通过传入函数的方式更新弹窗
+modal.update((prevConfig) => ({
+  ...prevConfig,
+  title: `${prevConfig.title}（新）`,
+}));
+
+modal.destroy();
+```
+
+
+
+- `Modal.destroyAll`
+
+使用 `Modal.destroyAll()` 可以销毁弹出的确认窗（即上述的 `Modal.info`、`Modal.success`、`Modal.error`、`Modal.warning`、`Modal.confirm`）。通常用于路由监听当中，处理路由前进、后退不能销毁确认对话框的问题，而不用各处去使用实例的返回值进行关闭（`modal.destroy()` 适用于主动关闭，而不是路由这样被动关闭）
+
+
+```jsx
+import { browserHistory } from 'react-router';
+
+// router change
+browserHistory.listen(() => {
+  Modal.destroyAll();
+});
+```
+
+
+### Modal.useModal()
+
+当你需要使用 Context 时，可以通过 `Modal.useModal` 创建一个 `contextHolder` 插入子节点中。通过 hooks 创建的临时 Modal 将会得到 `contextHolder` 所在位置的所有上下文。创建的 `modal` 对象拥有与 [`Modal.method`](#modalmethod) 相同的创建通知方法。
+
+
+```jsx
+const [modal, contextHolder] = Modal.useModal();
+
+React.useEffect(() => {
+  modal.confirm({
+    // ...
+  });
+}, []);
+
+return <div>{contextHolder}</div>;
+```
+
+
+`modal.confirm` 返回方法：
+
+
+- `destroy`：销毁当前窗口
+- `update`：更新当前窗口
+- `then`：Promise 链式调用，支持 `await` 操作。该方法为 Hooks 仅有
+
+
+```tsx
+//点击 `onOk` 时返回 `true`，点击 `onCancel` 时返回 `false`
+const confirmed = await modal.confirm({ ... });
+```