blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

feat(Notify): add jsdoc for utility functions (#12342)

Browse Source
This commit is contained in:
neverland 2023-10-06 10:00:13 +08:00 committed by GitHub
parent d8521b78af
commit d56623ef77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/vant/src/notify/README.md
View File

@ -115,10 +115,10 @@ Vant exports following Notify utility functions:
| Methods | Description | Attribute | Return value | | Methods | Description | Attribute | Return value |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| showNotify | Show notify | `NotifyOptions \| string` | notify instance | | showNotify | Display Notify at the top of the page | `NotifyOptions \| string` | Notify instance |
| closeNotify | Close notify | - | `void` | | closeNotify | Close the currently displayed Notify | - | `void` |
| setNotifyDefaultOptions | Set default options of all notifies | `NotifyOptions` | `void` | | setNotifyDefaultOptions | Modify the default configuration, affecting all `showNotify` calls | `NotifyOptions` | `void` |
| resetNotifyDefaultOptions | Reset default options of all notifies | - | `void` | | resetNotifyDefaultOptions | Reset the default configuration, affecting all `showNotify` calls | - | `void` |
### NotifyOptions ### NotifyOptions

4
packages/vant/src/notify/README.zh-CN.md
View File

@ -128,8 +128,8 @@ Vant 中导出了以下 Notify 相关的辅助函数：
| 方法名 | 说明 | 参数 | 返回值 | | 方法名 | 说明 | 参数 | 返回值 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| showNotify | 展示提示 | `NotifyOptions \| string` | notify 实例 | | showNotify | 在页面顶部展示 Notify | `NotifyOptions \| string` | notify 实例 |
| closeNotify | 关闭提示 | - | `void` | | closeNotify | 关闭当前展示的 Notify | - | `void` |
| setNotifyDefaultOptions | 修改默认配置，影响所有的 `showNotify` 调用 | `NotifyOptions` | `void` | | setNotifyDefaultOptions | 修改默认配置，影响所有的 `showNotify` 调用 | `NotifyOptions` | `void` |
| resetNotifyDefaultOptions | 重置默认配置，影响所有的 `showNotify` 调用 | - | `void` | | resetNotifyDefaultOptions | 重置默认配置，影响所有的 `showNotify` 调用 | - | `void` |

12
packages/vant/src/notify/function-call.tsx
View File

@ -34,12 +34,18 @@ const getDefaultOptions = (): NotifyOptions => ({
let currentOptions = getDefaultOptions(); let currentOptions = getDefaultOptions();
/**
* Close the currently displayed Notify
*/
export const closeNotify = () => { export const closeNotify = () => {
if (instance) { if (instance) {
instance.toggle(false); instance.toggle(false);
} }
}; };
/**
* Display Notify at the top of the page
*/
export function showNotify(options: NotifyMessage | NotifyOptions) { export function showNotify(options: NotifyMessage | NotifyOptions) {
if (!inBrowser) { if (!inBrowser) {
return; return;
@ -61,9 +67,15 @@ export function showNotify(options: NotifyMessage | NotifyOptions) {
return instance; return instance;
} }
/**
* Modify the default configuration, affecting all `showNotify` calls
*/
export const setNotifyDefaultOptions = (options: NotifyOptions) => export const setNotifyDefaultOptions = (options: NotifyOptions) =>
extend(currentOptions, options); extend(currentOptions, options);
/**
* Reset the default configuration, affecting all `showNotify` calls
*/
export const resetNotifyDefaultOptions = () => { export const resetNotifyDefaultOptions = () => {
currentOptions = getDefaultOptions(); currentOptions = getDefaultOptions();
}; };