JSAPI

启动参数

H5容器运行时的外观和行为受一组参数控制,可在启动一个新实例或者pushWindow时指定,示例:

alipays://platformapi/startapp?appId=20000067&url=http%3A%2F%2Fm.taobao.com&showOptionMenu=NO&startMultApp=YES

另外,对于新实例的第一个url, 也可以带一个魔法参数__webview_options__, 其内容将被容器取出,传给容器本身,8.1+支持

?__webview_options__=showOptionMenu%3DNO%26startMultApp%3DYES

// urlencode('showOptionMenu=NO&startMultApp=YES') => showOptionMenu%3DNO%26startMultApp%3DYES

客户端透传给前端的启动参数,前端可以直接通过AlipayJSBridge.startupParams获取到,或者通过jsapi:getStartupParams获取

警告:由于iOS容器的某个缓存机制兼容性问题,极端场景下通过startupParams环境变量可能会获取到上一次打开相同页面的值,因此切勿通过启动参数机制来传递重要的自定义业务参数。

这个表格很宽,右边内容向右拖动查看

名称缩写类型说明默认值pushWindow可用备注
urlstring起始url (重要警告:9.6以上客户端请勿使用u缩写!!)""Y
defaultTitledtstring默认标题, 在页面第一次加载之前显示在标题栏上""Y
showLoadingslstringYES/NO, 是否在页面加载前显示全局菊花"NO"Y
readTitlertstringYES/NO, 是否读取网页标题显示在titleBar上"YES"Y
bizScenariobzstring业务场景来源,这个值会记录到每一个埋点中,可以用来区分不同来源。""-
backBehaviorbbstringback/pop/auto. 指定后退按钮行为
back: history.length > 0 ? history.back() : closeWebview()
pop: popWindow()
auto: 在iOS上相当于pop;在android上,toolbar可见时相当于back, toolbar不可见时相当于pop。note: 8.4及以后不再支持
"back"
8.4及以后, 非H5App的通用浏览器模式(appId为20000067)为back,H5App(用应用中心注册过的appId来启动)为pop
-since 8.1
pullRefreshprstringYES / NO.是否支持下拉刷新
只有集团域/本地文件允许设置为YES
"NO"Ysince 8.2
toolbarMenutmstringJSON字符串,更多的菜单项列表(放在分享、字号、复制链接后面)
例:{"menus":[{"name":"恭喜","icon":"H5Service.bundle/h5_popovermenu_share","action":"hello"},{"name":"发财","icon":"H5Service.bundle/h5_popovermenu_abuse","action":"world"}]}
""Ysince 8.2
showProgressspboolYES/NO,是否显示加载的进度条
"NO"-since 8.2
canPullDownpdstringYES/NO,页面是否支持下拉(显示出黑色背景或者域名)
只有*.alipay.com/*.alipay.net/本地文件允许设置为NO
9.9.5废弃, 使用'allowsBounceVertical'替代
"YES"YESandroid since 8.3
ios since 8.4
showDomainsdboolYES/NO,页面下拉时是否显示域名
只有*.alipay.com/*.alipay.net/本地文件允许设置为NO,离线包强制设置为false,不容许显示
"YES"-android since 9.0.1
ios since 9.0
backgroundColorbcint设置背景颜色(十进制,例如:bc=16775138)
""-since 8.4
showOptionMenusoboolYES/NO,是否显示右上角点点点按钮对于H5App为NO
对于非H5App为YES
since 8.4
showTitleLoadingtlboolYES/NO,是否在TitleBar的标题左边显示小菊花)
NOYsince 8.6
enableScrollBaresboolYES/NO,是否使用webview的滚动条,包括垂直和水平。只对Android有效默认为"YES"-since 9.2