Skip to content

LimeXhsshare 小红书功能集成

lime-xhsshare UTS插件集成小红书核心功能(分享图片、分享视频等)的接口使用方法,适用于Android/iOS,未测试。

安装

插件市场入口 导入,在页面引入,修改各平台的文件后,自定义基座
请在试用后,确定需要后才购买。

Android

uni_modules/lime-xhsshare/utssdk/app-android/AndroidManifest.xml文档中将所有填写真实包名换成你的应用包名

iOS

uni_modules/lime-xhsshare/utssdk/app-ios/Info.plist文档将填写小红书AppKey换成你的小红书AppKey

代码演示

初始化小红书配置

js
import {useXhsShare, type LimeXhsShareConfig} from '@/uni_modules/lime-xhsshare';

const xhsUtils = useXhsShare({
  appKey: "小红书开放平台AppKey", // 小红书开放平台AppKey
  universalLink: "https://yourdomain.com/universal-link/", // iOS Universal Link
  success: (res) => console.log("初始化成功", res),
  fail: (err) => console.error("初始化失败", err)
} as LimeXhsShareConfig);

LimeXhsShareConfig

参数名类型必填说明平台差异默认值
appKeystring小红书开放平台注册的AppKeyAndroid/iOS 均需
universalLinkstringiOS必填iOS Universal Link(用于小红书分享等功能)仅iOS生效
success(res: LimeXhsSuccessCallbackResult) => void初始化成功的回调(返回状态码及消息)
fail(res: LimeXhsFail) => void初始化失败的回调(包含错误码及错误信息)
complete(res: any) => void接口调用完成的回调(无论成功/失败均触发)

小红书客户端检查

js
// 是否存在小红书客户端
xhsUtils.isInstalled()

打开小红书活动页

js
xhsUtils.openUrl("https://www.xiaohongshu.com/activity-page")

分享图片

js
import { type LimeXhsShareOptions} from '@/uni_modules/lime-xhsshare';
xhsUtils.share({
  type: 'image',
  imageUrl: 'https://example.com/share-image.jpg',
  thumb: 'https://example.com/thumbnail.jpg', // 建议提供缩略图
  title: '分享标题',
  summary: '分享描述'
} as LimeXhsShareOptions);

分享视频

js
import { type LimeXhsShareOptions} from '@/uni_modules/lime-xhsshare';
// 分享示例
xhsUtils.share({
  type: 'video',
  title: '精彩视频',
  summary: '这是一段精彩的视频',
  videoUrl: 'https://example.com/movie-trailer.mp4',
  thumb: 'https://example.com/video-thumb.jpg' // 建议提供缩略图
} as LimeXhsShareOptions);

LimeXhsShareOptions 参数说明表

参数名类型必填条件说明适用分享类型示例值
typestring必填分享类型:image(图片) 或 video(视频)所有类型"image"
titlestring分享标题image/video"限时特惠"
summarystring分享描述image/video"点击领取新人礼包"
thumbstring建议提供缩略图URL(建议<32KB)image/video"https://example.com/thumb.jpg"
imageUrlstringimage类型必填图片资源地址(支持本地路径)image"/static/share.jpg"
videoUrlstringvideo类型必填视频URLvideo"https://example.com/video.mp4"
success(res: LimeXhsSuccessCallbackResult) => void分享成功的回调
fail(res: LimeXhsFail) => void分享失败的回调(包含错误码及错误信息)
complete(res: any) => void接口调用完成的回调(无论成功/失败均触发)

分享相关错误码表

错误码说明常见原因处理建议
9010001小红书未安装用户设备未安装小红书App提示用户安装小红书App
9010002小红书版本号太低用户设备小红书版本过低提示用户升级小红书App
9010003资源缺失图片或视频资源未提供检查imageUrl或videoUrl参数
9010004图片或者视频文件不存在提供的文件路径无效检查文件路径是否正确
9010005文件处理失败文件格式不支持或损坏检查文件格式是否正确
9010008鉴权失败AppKey无效或未正确配置检查AppKey和universalLink配置
9010009打开分享页面失败小红书App响应异常检查小红书App是否正常运行
9010010传递数据有误参数格式错误检查分享参数格式
9010022用户取消发布用户主动取消分享操作属于正常用户行为,可以引导用户重新分享

源代码

组件源码