FinClip为企业提供小程序生态圈技术产品,开发者可在FinClip小程序开发帮助中心找到相关FinClip小程序指引

# SDK 初始化

# 1. 初始化

在使用小程序的 API 之前,需要先初始化小程序 SDK。只有成功初始化之后,才能使用 SDK 提供的 API,否则 API 调用会失败。

# API

/**  
 * @param finAppConfig  小程序框架的配置信息
 * @param entryContext 当前 Ability 的 context
 * @param entryInfo 宿主应用注册给 SDK 使用的 Ability name
 * @returns FinAppClient 实例
 * */  
FinAppClient.init(finAppConfig: IFinAppConfig.IFinAppConfig, entryContext: common.UIAbilityContext, entryInfo: string | window.WindowStage):FinAppClient { 
}

# 2. 配置项

下面各类型都是在 IFinAppConfig 命名空间下,比如 IFinAppConfig.IFinAppConfigIFinAppConfig.IStoreConfig

请注意

FinClip 小程序 SDK 中鸿蒙相关接口正在开发过程中,实际的使用情况请以发布为准。若您在使用时发现有疑惑或相关问题,请及时与我们联系。

# 2.1 IFinAppConfig 配置项

配置名称 类型 是否必填 说明
finStoreConfigs Array<IStoreConfig> 小程序服务器配置信息集合
appletDebugMode Boolean 是否开启小程序的 vconsole 调试
pageCountLimit Number 小程序中页面栈个数的最大限制。默认值为0,表示不限制。
uiConfig IUIConfig 与UI相关的配置项

# 2.2 IStoreConfig 配置项

配置名称 类型 是否必填 说明
sdkKey String 创建应用时生成的sdkKey
sdkSecret String 创建应用时生成的sdkKey
apiServer String 服务器地址,客户部署的后台地址
apmServer String apm事件上报的服务器地址,不设置时使用apiServer
cryptType "sm" | "md5" 网络接口加密类型。默认为"sm"(国密),也可以设置为"md5"
fingerprint String SDK指纹,在证联环境时必须传,否则接口访问不通
enablePreloadFramework Boolean 默认为true。是否预下载基础库,如果设置为false,则初始化SDK时不会预下载基础库

# 2.3 IUIConfig 配置项

配置名称 类型 是否必填 配置描述
navigationBarTitleLightColor String 导航栏标题文字浅色颜色,用于深色主题
navigationBarTitleDarkColor String 导航栏标题文字深色颜色,用于浅色主题
capsuleConfig ICapsuleConfig 右上角胶囊的样式配置,具体参数见 ICapsuleConfig
navHomeConfig INavHomeConfig 返回首页按钮的配置的样式配置,具体参数见 INavHomeConfig
navigationBarHeight Number 导航栏高度,默认值为44
hideBackToHome Boolean 是否隐藏导航栏中回到首页按钮,默认是 false
hideShareAppletMenu Boolean 是否隐藏小程序更多菜单中的分享按钮,默认是 true
hideForwardMenu Boolean 是否隐藏更多菜单中的转发按钮,默认是 false
hideRefreshMenu Boolean 是否隐藏更多菜单中的重新进入按钮,默认是 false
hideSettingMenu Boolean 是否隐藏小程序更多菜单中的设置按钮,默认是 false
hideDebugMenu Boolean 是否隐藏更多菜单中打开/关闭调试按钮,默认是 false
hideFavoriteMenu Boolean 是否隐藏更多菜单中收藏/取消收藏按钮,默认是 true
autoAdaptDarkMode Boolean 是否适配暗黑模式,默认是 true

# 2.4 ICapsuleConfig 配置项

配置名称 类型 是否必填 配置描述
hideCapsuleCloseButton Boolean 隐藏小程序胶囊里的关闭按钮
capsuleWidth Number 胶囊的宽度
capsuleHeight Number 胶囊的高度
capsuleRightMargin Number 胶囊的右边框距离屏幕右边框的距离
capsuleCornerRadius Number 胶囊的圆角半径
capsuleBorderWidth Number 胶囊的边框宽度
moreBtnWidth Number 胶囊的更多按钮宽度
moreBtnLeftMargin Number 更多按钮的左边距
closeBtnWidth Number 胶囊里关闭按钮的宽度
closeBtnLeftMargin Number 胶囊里关闭按钮的左边距
capsuleBorderLightColor String 胶囊的浅色边框颜色
capsuleBorderDarkColor String 胶囊的深色边框颜色
capsuleBgLightColor String 胶囊的浅色下背景颜色
capsuleBgDarkColor String 胶囊的深色下背景颜色
capsuleDividerLightColor String 胶囊里浅色分割线颜色
capsuleDividerDarkColor String 胶囊里的深色分割线颜色

# 2.5 INavHomeConfig 配置项

配置名称 类型 是否必填 配置描述
width Number 返回首页按钮的宽度
height Number 返回首页按钮的高度
leftMargin Number 返回首页按钮的左侧距离屏幕左边框的距离
cornerRadius Number 返回首页按钮的圆角半径
borderWidth Number 返回首页按钮的边框宽度
borderLightColor String 返回首页按钮的浅色边框颜色
borderDarkColor String 返回首页按钮的深色边框颜色
bgLightColor String 返回首页按钮的浅色背景颜色
bgDarkColor String 返回首页按钮的深色背景颜色
© FinClip with ❤ , Since 2017