API文档

musicplayer-API

渲染线程

1.0

通知API

侧边推出通知

proceedHint

可直接使用封装好的js模块,该模块位于public/static/proceedHint.js

1
import {proceedHint} from '../public/static/proceedHint'

commonHint

commonHint(“提示内容”,”提示标题”,持续时间)

1
proceedHint.commonHint("你好世界","提示",2000)

warning

warning(“提示内容”,”提示标题”,持续时间)

1
proceedHint.warning("你好世界","警告",2000)

warn

warn(“提示内容”,”提示标题”,持续时间)

1
proceedHint.warn("你好世界","提醒",2000)

general

general(“提示内容”,”标题内容”,”提示栏颜色”,”提示框背景颜色”,”提示时间”,”通知等级”)

1
proceedHint.general("你好世界","提示",'#FFCF3F','#242323',2000,2)

通知等级一共有1,2,3级,其中1级为最低,3级为最高
commonHint、warning、warning、是对general的封装,在调用他们时会有不同的颜色和通知等级

函数名 提示栏颜色 提示框背景颜色 通知等级
commonHint #3653f6 #242323 1
warn #FFCF3F #242323 2
warning #F73859 #242323 3

用户可以在设置中关闭相对应通知等级的提示,但是最高等级(3级)无法关闭,如果您有非常重要的通知请使warning或设置通知等级为3

该API还提供了另一种调用方式,这种方式无需导入组件,只不过可能麻烦一点

事件触发

1
2
3
4
5
6
7
8
9
10
11
let warningEvent = new CustomEvent('hint',{
            detail:{
                title:title, //标题
                content:content,//内容
                titleColor:titleColor,//提示栏颜色"
                time:time,//持续时间
                background:background,//提示框背景颜色
                level:level,//通知等级
            }
        });
        window.dispatchEvent(warningEvent);
backtop