guide

来自于:开发者立即使用

概述

概述

guide 封装了首次下载或者是版本更新后启动应用时的导航页,模块自动记录是否为第一次启动,导航页分为视频、图片两大类。图片导航在最后一个页面点击立即体验会关闭导航页。视频导航仅支持格式为MP4格式。视频导航分为循环视频导航和播放一次视频导航,循环视频导航点击进入按钮后导航页关闭。播放一次视频导航,视频播放完后会自动关闭导航页,建议视频不要太大,时间不要太长(太长会影响用户体验效果,建议10s左右)。 注意:每次生成正式版的APP时iOS version code不会增加,需要手动增加,当新版iOS version code和旧版的iOS version code不同时就会出现效果。建议编译正式版APP需要版本iOS version code一致,这样就出现更新后版本的效果。如图

Image text

实例widget下载地址

模块接口

openGuidePage

打开图片导航

openGuidePage({params})

params

imgs:

  • 类型:数组
  • 描述:导航图片(支持 widget:// fs:// 不支持相对路径)。

point_normal

  • 类型:字符串
  • 描述:(可选项)普通页面分页控件图片地址(widget:// fs:// 相对路径都是支持),尺寸图片建议30 × 30。

point_select

  • 类型:字符串
  • 描述:(可选项)当前页面分页控件数图片地址(widget:// fs:// 相对路径都是支持),尺寸图片建议30 × 30。

btnColor

  • 类型:字符串
  • 描述:(可选项)关闭按钮背景颜色(00FFFF)。

time

  • 类型:字符串
  • 描述:(可选项)导航页消失的时间,以秒为单位。

hideStatusBar

  • 类型:布尔类型 -描述:(可选)是否隐藏状态栏,默认值为true(隐藏状态栏)

代码示例

var guide = api.require('guide');
guide.openGuidePage({
    imgs: ['widget://image/guide/load_1.jpg', 'widget://image/guide/load_2.jpg', 'widget://image/guide/load_3.jpg'],
    point_normal:'widget://image/guide/point_normal@2x.png',
    point_select:'widget://image/guide/point_select@2x.png',
    btnColor:'00FFFF',
    time:'2',
    hideStatusBar:false
};

可用性

iOS系统

可提供的1.0.0及更高版本

openGuideVideo

打开视频导航

openGuideVideo({params})

params

path:

  • 类型:字符串
  • 描述:导航视频本地地址(widget:// fs:// 相对路径都是支持)。

time

  • 类型:字符串
  • 描述:(可选项)导航页消失的时间。

hideStatusBar

  • 类型:布尔类型 -描述:(可选)是否隐藏状态栏,默认值为true(隐藏状态栏)

代码示例

var guide = api.require('guide');
guide.openGuidePage({
    path: 'widget://video/guide/video.mp4',
    time:'2',
    hideStatusBar:false
};

可用性

iOS系统

可提供的1.0.0及更高版本

openGuideRepeatVideo

打开循环视频导航

openGuideRepeatVideo({params})

params

path:

  • 类型:字符串
  • 描述:导航视频本地地址(widget:// fs:// 相对路径都是支持)。

borderColor:

  • 类型:字符串
  • 描述:进入按钮边缘颜色,默认值是#FFFFFF(白色)。

titleColor

  • 类型:字符串
  • 描述:进入按钮字体颜色,默认值是#FFFFFF(白色)。

title

  • 类型:字符串
  • 描述:进入按钮文字,默认值字符串为 进入应用。

hideStatusBar

  • 类型:布尔类型 -描述:(可选)是否隐藏状态栏,默认值为true(隐藏状态栏)

代码示例

var guide = api.require('guide');
    guide.openGuideRepeatVideo({
    path: 'widget://video/guide/video.mp4',
    borderColor:'FF0000',
    titleColor:'FF0000',
    title:'立即体验',
    hideStatusBar:false
};

可用性

iOS系统

可提供的1.0.0及更高版本