文档管理中心
我的
API参考快应用组件shortcut-button(1083+)

shortcut-button(1083+)

概述

添加桌面图标按钮组件。

注意

使用该组件时,务必说明用户点击组件后将添加桌面图标,组件的使用不能影响用户体验。

使用限制

展开

限制条件

说明

适用终端

手机、平板、车机

适用区域

全球

子组件

不支持。

属性

除了支持 通用属性以外,还支持如下属性。

展开

名称

类型

默认值

是否必填

描述

value

string

-

否

添加桌面图标按钮组件的文本。

1106版本该属性已废弃,设置无效。

add-type(1106+)

number

0

否

添加桌面文案预置类型,仅在中国大陆支持。

add-type设置值对应文案如下:

  • 0:添加到桌面
  • 1:添加至桌面
  • 2:立即添加到桌面
  • 3:添加到手机桌面
  • 4:添加到桌面领书币
  • 5:添加到桌面,打开更方便
  • 6:添加到桌面,下次使用更方便
  • 7:添加到桌面,阅读更方便
  • 8:添加到桌面,方便下次看书
  • 9:添加到手机桌面,方便下次阅读

样式

除了支持 通用样式 以外,还支持如下样式。

说明
  • 1103版本开始,不再支持background和background-image样式。
  • 1105版本开始,不再支持padding、padding-left、padding-right、padding-top和padding-bottom样式。
  • 1119不再支持border、border-[left|top|right|bottom]、border-style、border-width、border-[left|top|right|bottom]-width、border-color、border-[left|top|right|bottom]-color、border-[top|bottom]-[left|right]-radius。
展开

名称

类型

默认值

是否必填

描述

color(1103+)

color

#FFFFFF

否

按钮初始文案颜色。当background-color和color值过于相似时,这两个字段设置的值无效。

说明

当设置成rgba或者hsla类型颜色值时,透明度设置小于0.5时会默认按0.5处理。

background-color(1103+)

color

#0A59F7

否

按钮初始背景颜色。当background-color和color值过于相似时,这两个字段设置的值无效。

说明

当设置成rgba或者hsla类型颜色值时,透明度设置小于0.5时会默认按0.5处理。

opacity(1103+)

float

1.0

否

组件透明度。取值范围:0.5~1.0

  • 0.5:半透明
  • 1.0:完全不透明
注意

当设置的值小于0.5时,默认按0.5处理。

font-size

number

37.5px

否

文本尺寸。

取值范围:20~112.5px

width

length | percentage

128px

否

组件宽度。

height

length

70px

否

组件高度,不支持设置百分比。

取值范围:不大于180px(设置超过180px则按照180px处理)

注意
  1. 该组件必须完整对用户可见,不可被任何元素覆盖或遮挡(含透明元素),否则会影响您的计费。
  2. 该组件必须完全在屏幕范围内。

事件

除了支持 通用事件 以外,还支持如下事件。

展开

名称

参数

描述

click

{eventStatusCode: eventStatusCodeValue, eventMessage: eventMessageValue}

组件被点击时触发。

  • eventStatusCode:
    • 图标已存在时:200(失败)
    • 无添加桌面图标权限时:200(失败)
    • 添加桌面图标成功时:0(成功)
  • eventMessage:
    • 图标已存在时:shortcut already exists.
    • 无添加桌面图标权限时:createShortCut failed.
    • 添加桌面图标成功时:createShortCut success.
说明

当设备是Android 8.0或以下版本时,无论是否添加桌面图标成功,状态码都返回0,状态信息都返回createShortCut success.

示例代码

收起
自动换行
深色代码主题
复制
  1. <template>
  2. <!-- Only one root node is allowed in template. -->
  3. <div class="container">
  4. <shortcut-button class="shortcut" add-type="1" onclick="click()"></shortcut-button>
  5. </div>
  6. </template>
  7. <style>
  8. .container {
  9. flex-direction: column;
  10. justify-content: center;
  11. align-items: center;
  12. }
  13. .title {
  14. font-size: 100px;
  15. }
  16. .shortcut {
  17. margin-top: 40px;
  18. background-color: rgba(219, 22, 22, 1);
  19. color: rgb(22, 203, 219);
  20. font-size: 40px;
  21. width: 300px;
  22. height: 70px;
  23. border-radius: 220px;
  24. align-self: center;
  25. text-align: center;
  26. opacity: 0.4;
  27. }
  28. </style>
  29. <script>
  30. import prompt from '@system.prompt'
  31. import shortcut from '@system.shortcut'
  32. module.exports = {
  33. data: {
  34. componentData: {},
  35. },
  36. onInit() {
  37. this.$page.setTitleBar({
  38. text: 'menu',
  39. textColor: '#ffffff',
  40. backgroundColor: '#007DFF',
  41. backgroundOpacity: 0.5,
  42. menu: true
  43. });
  44. },
  45. click(event) {
  46. prompt.showToast({
  47. message: event.eventStatusCode
  48. })
  49. }
  50. }
  51. </script>

版本更新说明

展开

版本

发布日期

描述

1106

2023-06-19

新增add-type属性。

1105

2023-04-25

  • 新增不支持的通用样式。
  • 修改color和background的默认颜色。
  • 新增font-size取值范围为20~112.5px。

1103

2022-12-26

  • 优化了value属性、height和color样式的描述。
  • 新增background-color和opacity样式。
  • 优化了示例代码。

1083

2022-03-21

第一次正式发布。