ShareSheet 分享面板
介绍
底部弹起的分享面板,用于展示各分享渠道对应的操作按钮,不含具体的分享逻辑。
代码演示
基础用法
分享面板通过 options
属性来定义分享选项,数组的每一项是一个对象,对象格式见文档下方表格。
<z-cell is-link title="显示分享面板" @click="showBasic = true" />
<z-share-sheet
v-model:show="showBasic"
title="立即分享给好友"
:options="options"
@select="onSelect"
/>
import { useToast } from '../../uni_modules/zebra-ui'
const toast = useToast()
const showBasic = ref(false)
const options = computed(() => [
{ name: '微信', icon: 'wechat' },
{ name: '微博', icon: 'weibo' },
{ name: '复制链接', icon: 'link' },
{ name: '分享海报', icon: 'poster' },
{ name: '二维码', icon: 'qrcode' }
])
const onSelect = (option: any) => {
toast.showToast(option.name)
showBasic.value = false
}
展示多行选项
当分享选项的数量较多时,可以将 options
定义为数组嵌套的格式,每个子数组会作为一行选项展示。
<z-share-sheet
v-model:show="showMultiLine"
title="立即分享给好友"
:options="multiLineOptions"
@select="onSelect"
/>
const multiLineOptions = computed(() => [
[
{ name: '微信', icon: 'wechat' },
{ name: '朋友圈', icon: 'wechat-moments' },
{ name: '微博', icon: 'weibo' },
{ name: 'QQ', icon: 'qq' }
],
[
{ name: '复制链接', icon: 'link' },
{ name: '分享海报', icon: 'poster' },
{ name: '二维码', icon: 'qrcode' },
{ name: '小程序码', icon: 'weapp-qrcode' }
]
])
自定义图标
除了使用内置的几种图标外,可以直接在 icon
中传入图片 URL 来使用自定义的图标。
<z-share-sheet
v-model:show="showCustomIcon"
:options="customIconOptions"
@select="onSelect"
/>
const customIconOptions = computed(() => [
{
name: '名称',
icon: 'https://cdn.zebraui.com/zebra-ui/images/assets/demo-select.png'
},
{
name: '名称',
icon: 'zhihu'
},
{
name: '名称',
icon: 'linkedin'
},
{ name: '名称', icon: 'facebook' }
])
展示描述信息
通过 description
属性可以设置标题下方的描述文字, 在 options
内设置 description
属性可以添加分享选项描述。
<z-share-sheet
v-model:show="showWithDesc"
title="立即分享给好友"
:options="optionsWithDesc"
description="描述信息"
@select="onSelect"
/>
const optionsWithDesc = computed(() => [
{ name: '微信', icon: 'wechat' },
{ name: '微博', icon: 'weibo' },
{
name: '复制链接',
icon: 'link',
description: '描述信息'
},
{ name: '分享海报', icon: 'poster' },
{ name: '二维码', icon: 'qrcode' }
])
API
Props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
v-model:show | 是否显示分享面板 | boolean | false |
options | 分享选项 | Option | [] |
title | 顶部标题 | string | - |
cancel-text | 取消按钮文字,传入空字符串可以隐藏按钮 | string | '取消' |
description | 标题下方的辅助描述文字 | string | - |
duration | 动画时长,单位毫秒,设置为 0 可以禁用动画 | number | string | 300 |
z-index | 将面板的 z-index 层级设置为一个固定值 | number | string | 2000+ |
round | 是否显示圆角 | boolean | true |
overlay | 是否显示遮罩层 | boolean | true |
overlay-class | 自定义遮罩层类名 | string | Array | object | - |
overlay-style | 自定义遮罩层样式 | object | - |
lock-scroll | 是否锁定背景滚动 | boolean | true |
close-on-popstate | 是否在页面回退时自动关闭 | boolean | true |
close-on-click-overlay | 是否在点击遮罩层后关闭 | boolean | true |
safe-area-inset-bottom | 是否开启底部安全区适配 | boolean | true |
before-close | 关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise | (action: string) => boolean | Promise<boolean> | - |
Option 数据结构
options
属性为一个对象数组,数组中的每个对象配置一列,对象可以包含以下值:
键名 | 说明 | 类型 |
---|---|---|
name | 分享渠道名称 | string |
description | 分享选项描述 | string |
icon | 图标,可选值为 wechat weibo qq link qrcode poster weapp-qrcode wechat-moments ,支持传入图片 URL | string |
className | 分享选项类名 | string |
Events
事件名 | 说明 | 回调参数 |
---|---|---|
select | 点击分享选项时触发 | option: Option, index: number |
cancel | 点击取消按钮时触发 | - |
open | 打开面板时触发 | - |
close | 关闭面板时触发 | - |
opened | 打开面板且动画结束后触发 | - |
closed | 关闭面板且动画结束后触发 | - |
click-overlay | 点击遮罩层时触发 | event: MouseEvent |
Slots
名称 | 说明 |
---|---|
title | 自定义顶部标题 |
description | 自定义描述文字 |
cancel | 自定义取消按钮内容 |
主题定制
样式变量
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
--z-share-sheet-header-padding | var(--z-padding-sm) var(--z-padding-md) var(--z-padding-base) | - |
--z-share-sheet-title-color | var(--z-text-color) | - |
--z-share-sheet-title-font-size | var(--z-font-size-md) | - |
--z-share-sheet-title-line-height | var(--z-line-height-md) | - |
--z-share-sheet-description-color | var(--z-text-color-2) | - |
--z-share-sheet-description-font-size | var(--z-font-size-sm) | - |
--z-share-sheet-description-line-height | 32rpx | - |
--z-share-sheet-icon-size | 96rpx | - |
--z-share-sheet-option-name-color | var(--z-gray-7) | - |
--z-share-sheet-option-name-font-size | var(--z-font-size-sm) | - |
--z-share-sheet-option-description-color | var(--z-text-color-3) | - |
--z-share-sheet-option-description-font-size | var(--z-font-size-sm) | - |
--z-share-sheet-cancel-button-font-size | var(--z-font-size-lg) | - |
--z-share-sheet-cancel-button-height | 96rpx | - |
--z-share-sheet-cancel-button-background | var(--z-background-2) | - |