底部弹起的分享面板,用于展示各分享渠道对应的操作按钮,不含具体的分享逻辑。
通过以下方式来全局注册组件,更多注册方式请参考组件注册。
import { createApp } from "vue";
import { ShareSheet } from "vant";
const app = createApp();
app.use(ShareSheet);
分享面板通过 options
属性来定义分享选项,数组的每一项是一个对象,对象格式见文档下方表格。
<van-cell title="显示分享面板" @click="showShare = true" />
<van-share-sheet
v-model:show="showShare"
title="立即分享给好友"
:options="options"
@select="onSelect"
/>
import { ref } from "vue";
import { showToast } from "vant";
export default {
setup() {
const showShare = ref(false);
const options = [
{ name: "微信", icon: "wechat" },
{ name: "微博", icon: "weibo" },
{ name: "复制链接", icon: "link" },
{ name: "分享海报", icon: "poster" },
{ name: "二维码", icon: "qrcode" },
];
const onSelect = (option) => {
showToast(option.name);
showShare.value = false;
};
return {
options,
onSelect,
showShare,
};
},
};
当分享选项的数量较多时,可以将 options
定义为数组嵌套的格式,每个子数组会作为一行选项展示。
<van-share-sheet
v-model:show="showShare"
title="立即分享给好友"
:options="options"
/>
import { ref } from "vue";
export default {
setup() {
const showShare = ref(false);
const options = [
[
{ 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" },
],
];
return {
options,
showShare,
};
},
};
除了使用内置的几种图标外,可以直接在 icon
中传入图片 URL 来使用自定义的图标。
<van-share-sheet v-model:show="showShare" :options="options" />
import { ref } from "vue";
export default {
setup() {
const showShare = ref(false);
const options = [
{
name: "名称",
icon: "https://fastly.jsdelivr.net/npm/@vant/assets/custom-icon-fire.png",
},
{
name: "名称",
icon: "https://fastly.jsdelivr.net/npm/@vant/assets/custom-icon-light.png",
},
{
name: "名称",
icon: "https://fastly.jsdelivr.net/npm/@vant/assets/custom-icon-water.png",
},
];
return {
options,
showShare,
};
},
};
通过 description
属性可以设置标题下方的描述文字, 在 options
内设置 description
属性可以添加分享选项描述。
<van-share-sheet
v-model:show="showShare"
:options="options"
title="立即分享给好友"
description="描述信息"
/>
import { ref } from "vue";
export default {
setup() {
const showShare = ref(false);
const options = [
{ name: "微信", icon: "wechat" },
{ name: "微博", icon: "weibo" },
{ name: "复制链接", icon: "link", description: "描述信息" },
{ name: "分享海报", icon: "poster" },
{ name: "二维码", icon: "qrcode" },
];
return {
options,
showShare,
};
},
};
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
v-model:show | 是否显示分享面板 | boolean | false
|
options | 分享选项 | Option[] | []
|
title | 顶部标题 | string | - |
cancel-text | 取消按钮文字,传入空字符串可以隐藏按钮 | string | "取消"
|
description | 标题下方的辅助描述文字 | string | - |
duration | 动画时长,单位秒,设置为 0 可以禁用动画 | number | string | 0.3
|
z-index | 将面板的 z-index 层级设置为一个固定值 | number | string | 2000+
|
round v3.2.6
|
是否显示圆角 | boolean | true
|
overlay | 是否显示遮罩层 | boolean | true
|
overlay-class | 自定义遮罩层类名 | string | Array | object | - |
overlay-style | 自定义遮罩层样式 | object | - |
lock-scroll | 是否锁定背景滚动 | boolean | true
|
lazy-render | 是否在显示弹层时才渲染内容 | boolean | true
|
close-on-popstate | 是否在页面回退时自动关闭 | boolean | true
|
close-on-click-overlay | 是否在点击遮罩层后关闭 | boolean | true
|
safe-area-inset-bottom | 是否开启底部安全区适配 | boolean | true
|
teleport | 指定挂载的节点,等同于 Teleport 组件的 to 属性 | string | Element | - |
before-close v3.1.4
|
关闭前的回调函数,返回 false 可阻止关闭,支持返回 Promise |
(action: string) => boolean | Promise<boolean> | - |
options
属性为一个对象数组,数组中的每个对象配置一列,对象可以包含以下值:
键名 | 说明 | 类型 |
---|---|---|
name | 分享渠道名称 | string |
description | 分享选项描述 | string |
icon | 图标,可选值为 wechat weibo qq link qrcode poster weapp-qrcode wechat-moments ,支持传入图片 URL |
string |
className | 分享选项类名 | string |
事件名 | 说明 | 回调参数 |
---|---|---|
select | 点击分享选项时触发 | option: Option, index: number |
cancel | 点击取消按钮时触发 | - |
open | 打开面板时触发 | - |
close | 关闭面板时触发 | - |
opened | 打开面板且动画结束后触发 | - |
closed | 关闭面板且动画结束后触发 | - |
click-overlay | 点击遮罩层时触发 | event: MouseEvent |
名称 | 说明 |
---|---|
title | 自定义顶部标题 |
description | 自定义描述文字 |
cancel v3.0.10
|
自定义取消按钮内容 |
组件导出以下类型定义:
import type {
ShareSheetProps,
ShareSheetOption,
ShareSheetOptions,
} from "vant";
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件。
名称 | 默认值 | 描述 |
---|---|---|
--van-share-sheet-header-padding | var(--van-padding-sm) var(--van-padding-md) var(--van-padding-base) | - |
--van-share-sheet-title-color | var(--van-text-color) | - |
--van-share-sheet-title-font-size | var(--van-font-size-md) | - |
--van-share-sheet-title-line-height | var(--van-line-height-md) | - |
--van-share-sheet-description-color | var(--van-text-color-2) | - |
--van-share-sheet-description-font-size | var(--van-font-size-sm) | - |
--van-share-sheet-description-line-height | 16px | - |
--van-share-sheet-icon-size | 48px | - |
--van-share-sheet-option-name-color | var(--van-gray-7) | - |
--van-share-sheet-option-name-font-size | var(--van-font-size-sm) | - |
--van-share-sheet-option-description-color | var(--van-text-color-3) | - |
--van-share-sheet-option-description-font-size | var(--van-font-size-sm) | - |
--van-share-sheet-cancel-button-font-size | var(--van-font-size-lg) | - |
--van-share-sheet-cancel-button-height | 48px | - |
--van-share-sheet-cancel-button-background | var(--van-background-2) | - |
在不同的 App 或浏览器中,存在各式各样的分享接口或分享方式,因此 ShareSheet 组件不提供具体的分享逻辑,需要开发者根据业务场景自行实现。
由于微信未提供分享相关的 API,需要引导用户点击右上角进行分享。
可以通过 JSBridge 调用原生应用的 SDK 进行分享。
可以通过 Popup 组件以弹层的形式展示图片,然后引导用户保存图片进行分享。
介绍图片放大预览,支持组件调用和函数调用两种方式。引入通过以下方式来全局注册组件,更多注册方式请参考组件注册。import { c...
提示当前文档为 Vant 3 的更新日志,如需查询 Vant 2 的更新内容,请访问Vant 2 更新日志。介绍Vant 遵循Semver语义化版本规范。...
定制主题废弃提示本文档已废弃,Vant 提供了更方便的ConfigProvider 全局配置组件进行主题配置。基于 Less 变量进行定制的方式将...