文档中心 > 店铺动态卡片-开发指引

配置应用-API

更新时间:2023/03/06 访问次数:12902

注:如果你确定不需要使用配置应用的渲染,但又不得不提交配置应用,切记写如下代码,保障店铺配置能正常运行下去.


my.on('saveData',()=>{
  my.saveData({
    data: {}
  });
});


一、行为

1. 取消提交


描述


取消店铺表单提交行为,例如校验失败时,可以调用该 api 来取消提交行为。


方法


my.cancelSubmit

 

入参


请传入空对象(务必)。

 

案例


my.cancelSubmit({});


二、选择器

1. 链接选择器


方法


my.handleLink

 

入参


参数名

参数说明

参数类型

是否必传

source

装修途径:

(默认以1为数据源)

1)shop-decorator

2)detail-decorator

Enum

false

selected

已经选择过的链接

string

false



参数名

参数类型

参数说明

link

string

勾选的链接

 


my.handleLink({
  success: (value) => {
    console.log(value)
  },
});



链接选择器相关链接:https://wangpu.taobao.com/shopdecorate/tools/linkSelector.htm?source=shop-decorator


2. 商品选择器



my.handleItem

 


参数名

参数说明

参数类型

是否必传

minNum

至少选择的商品个数

number

fasle

maxCount

最多允许选择的个数,0为不限上限的多选,默认是0

number

false

limitNum

满足已选的数量才响应返回,默认0,不限制

number

false

onlyVideo

是否只选择有视频的商品,

默认0,

0: 不限制,

1:只选有视频的商品

string

false

source

装修途径:

(默认以1为数据源)

1)shop-decorator

2)detail-decorator

string

false



参数名

参数类型

参数说明

data

Array<Object>

勾选的商品信息集合

auctionId

number

商品ID

itemId

number

商品ID

itemLink

string

商品链接

orderCost

number

商品销量

picUrl

string

商品图片地址

reservePrice

number

商品原价

salePrice

number

商品现价

title

string

商品标题

 


my.handleItem({
  success: (value) => {
   console.log('shopItem',value)
  }
});



链接选择器相关链接:https://wangpu.taobao.com/shopdecorate/tools/productSelector.htm?selected=234234234243,234234234&maxCount=4&source=shop-decorator


3. 券选择器



my.handleCoupon

 

入参


参数名

参数说明

参数类型

是否必传

selected

已选的优惠券列表


false

maxCount

最多允许选择的个数

number

false

source

装修途径:

(默认以1为数据源)

1)shop-decorator

2)detail-decorator

string

false



参数名

参数说明

参数类型

是否必传

selected

已选的优惠券列表


false

maxCount

最多允许选择的个数

number

false

source

装修途径:

(默认以1为数据源)

1)shop-decorator

2)detail-decorator

string

false


案例


my.handleCoupon({
  success: (value) => {
    console.log(value);
 }
});



链接选择器相关链接:https://wangpu.m.taobao.com/shopdecorate/tools/couponSelector.htm


4. 图片选择器



my.handlePicture

 


参数名

参数说明

参数类型

是否必传

minHeight

限制最小高度

string

false

maxHeight

限制最大高度

string

false

needCrop

是否需要裁图, 目前该配置生效,强行裁图

Boolean

false

mime

支持上传的文件类型

string

false

maxSize

允许上传的文件大小,单位:M

number

false

width

需要生成的图片宽度

string

false

height

需要生成的图片高度

string

false

maxWidth

生成图片的最大宽度,当fixHeight为false的时候一定要设置

string

false

fixHeight

是否固定的高度,

string

false

fixWidth

是否固定的宽度,

string

false

 


参数名

参数类型

参数说明

pictureName

string

图片名称

pictureUrl

string

图片地址

pix

string

图片大小

 

案例


my.handlePicture({
  success: (value) => {
    console.log(value);
 }
});



无。


5. 选择二跳小程序


选择二跳小程序。



my.handleSelectMiniApp

 


参数名

参数类型

参数说明

selectedMiniapp

string

已选小程序链接

 


参数名

参数类型

参数说明

miniappSelect

string

选择的小程序链接

 


my.handleSelectMiniApp({
  selectedMiniapp: '',
  success: (value) => {
    console.log('选择小程序成功后', value)
  },
});


二跳选择器素材配置


文档地址:https://www.yuque.com/yunchao-wril1/arxmci/xqp7w6


三、数据相关

1. 获取配置 schema



my.getSchemaData

 


my.getSchemaData({
  success: (value) => {
    console.log(value);
  },
});


2. 获取表单组件配置数据



my.getModuleData

 


my.getModuleData({
  success: (value) => {
    console.log(value);
  },
});


3. 获取表单全局数据



my.getGlobalData

 


my.getGlobalData({
  success: (value) => {
    console.log(value);
  },
});


4. 提交表单数据


用于向外部提交表单数据。


方法


my.saveData

 

案例


my.saveData({
  data: { ... }
});


四、事件监听

1. 监听表单保存事件


用于监听表单保存事件,例如商家点击保存按钮后的操作。

 


saveData

 


my.on('saveData',()=>{
 // 外部保存数据事件
});



FAQ

关于此文档暂时还没有FAQ
返回
顶部