全部产品
云市场

启动参数

更新时间:2020-05-11 10:15:44

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

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

另外,新实例的第一个 URL 也可以带一个魔法参数 webview_options,其内容将被容器取出并传给容器本身:

  1. ?webview_options=showOptionMenu%3DNO&startMultApp%3DYES
  2. // urlencode('showOptionMenu=NO&startMultApp=YES') => showOptionMenu%3DNO&startMultApp%3DYES

客户端透传给前端的启动参数,前端可以直接通过 AlipayJSBridge.startupParamsjsapi:getStartupParams 获取。

名称 缩写 类型 说明 默认值 pushWindow 可用 备注
url string 起始 URL “” Y
defaultTitle dt string 默认标题,在页面第一次加载之前显示在标题栏上 “” Y
showLoading sl string YES/NO,是否在页面加载前显示全局菊花 “NO” Y
readTitle rt string YES/NO,是否读取网页标题显示在 titleBar 上 “YES” Y
bizScenario bz string 业务场景来源,这个值会记录到每一个埋点中,可以用来区分不同来源。 “” -
backBehavior bb string back/pop/auto 指定后退按钮行为。
back: 如存在浏览器历史则后退上一页,否则关闭当前 webview。
pop: 直接关闭当前窗口。
auto: 在 iOS 上相当于 pop;在 Android 上,toolbar 可见时相当于 back,toolbar 不可见时相当于 pop。
非 H5App 的通用浏览器模式(appId 为 20000067)为 back,H5App(用 startApp 来启动)为 pop -
pullRefresh pr string YES/NO,是否支持下拉刷新。
只有本地文件允许设置为 YES
“NO” Y
toolbarMenu tm string JSON 字符串,更多的菜单项列表(放在分享、字号、复制链接后面)
例:{“menus”:[{“name”:”恭喜”,”icon”:”H5Service.bundle/h5_popovermenu_share”,”action”:”hello”},{“name”:”发财”,”icon”:”H5Service.bundle/h5_popovermenu_abuse”,”action”:”world”}]}
“” Y
showProgress sp bool YES/NO,是否显示加载的进度条 “NO” -
canPullDown pd string YES/NO,页面是否支持下拉(显示出黑色背景或者域名)
只有本地文件允许设置为 NO
“YES” YES
showDomain sd bool YES/NO,页面下拉时是否显示域名
只有本地文件允许设置为 NO,离线包强制设置为 NO,不允许显示
“YES” -
backgroundColor bc int 设置背景颜色(十进制,例如:bc=16775138) “” -
showOptionMenu so bool YES/NO,是否显示右上角的“…”按钮 对于 H5App 为 NO
对于非 H5App 为 YES
showTitleLoading tl bool YES/NO,是否在 TitleBar 的标题左边显示小菊花) NO Y
enableScrollBar es bool YES/NO,是否使用 webview 的滚动条,包括垂直和水平。只对 Android 有效 默认为”YES” -