简介

为了兼容Bootstrap 5，Stately主题重写了$.alert、$.confirm、$.ajax_modal等一些函数，现将改进后的函数文档发布于此，便于插件开发者参考。

一、通用信息模态框

1. 功能描述

$.alert函数用于显示一般信息的模态框，支持自动隐藏和自定义设置。

2. 函数签名

$.alert(subject, timeout, options)

3. 参数说明

• subject：字符串类型，模态框的内容。
• timeout：整数类型，模态框自动隐藏的时间（单位：秒）；0表示不自动隐藏。
• options：对象类型，模态框的自定义设置。
  • size：字符串类型，弹窗大小，可选值为sm、md、lg、xl。
  • scrollable：布尔类型，是否允许在内容过多时纵向滚动。
  • verticallyCentered：布尔类型，是否垂直居中。
  • noCloseOnOutsideClick：布尔类型，点击模态框外面是否不会关闭模态框。

4. 返回值

返回一个模态框对象。

二、确认操作模态框

1. 功能描述

$.confirm函数用于确认用户操作的模态框，支持自定义设置和回调函数。

2. 函数签名

$.confirm(subject, ok_callback, options)

3. 参数说明

• subject：字符串类型，模态框的内容。
• ok_callback：函数类型，点击确定按钮后的回调函数。
• options：对象类型，模态框的自定义设置。
  • backdrop：布尔类型，是否带背景。
  • focus：布尔类型，是否聚焦到模态框上。
  • size：字符串类型，弹窗大小，可选值为sm窄、md中、lg宽、xl超宽。
    • 一般来说，md就够用了。
  • title：字符串类型，模态框标题。
  • body：字符串类型，模态框内容。
  • btn_title：字符串类型，按钮文字。
  • scrollable：布尔类型，是否允许在内容过多时纵向滚动。
  • verticallyCentered：布尔类型，是否垂直居中。
  • noCloseOnOutsideClick：布尔类型，点击模态框外面是否不会关闭模态框。
    • 如果该模态框必须点击“取消”或“关闭”才能正确关闭，请设为true。

4. 返回值

返回一个模态框对象。

三、AJAX获取模态框内容

1. 功能描述

$.ajax_modal函数用于通过AJAX获取模态框内容，支持自定义设置和回调函数。

2. 函数签名

$.ajax_modal(url, title, size, callback, arg, options)

3. 参数说明

• url：字符串类型，要获取的页面地址（Get请求）。
• title：字符串类型，模态框标题。
• size：字符串类型，模态框大小，目前未使用。
• callback：函数类型，回调函数。
• arg：对象类型，其他参数，与请求一并发送。
• options：对象类型，模态框的自定义设置。
  • backdrop：布尔类型，是否带背景，默认为true，无需设置。
  • focus：布尔类型，是否聚焦到模态框上，默认为true，无需设置。
  • size：字符串类型，弹窗大小，可选值为sm、md、lg、xl。
  • scrollable：布尔类型，是否允许在内容过多时纵向滚动。
  • verticallyCentered：布尔类型，是否垂直居中。
  • noCloseOnOutsideClick：布尔类型，点击模态框外面是否不会关闭模态框。

4. 返回值

返回一个模态框对象。

四、吐司框

1. 功能描述

在页面上显示简单的提示信息。

2. 函数签名

$.toast(args);

3. 参数说明

参数写在一个对象中。

• title：字符串类型，提示信息的标题
• subtitle：字符串类型，提示信息的副标题，在标题旁边显示
• content：字符串类型，提示信息的内容
• type：提示信息的类型，字符串类型，可选值有："info"、"success"、"warning"、"error"
• pause_on_hover：布尔类型，鼠标放在吐司框上面时不消失
• delay：整数类型，提示信息显示的时间，单位为毫秒

4. 返回值

无。