智能小程序 Ray 开发基础API——框架和多语言 API 合集

框架 API 

getApp

获取应用唯一 App 实例，实例对象为 src/App.tsx

引入

import { getApp } from '@ray-js/ray';

签名

getApp(): AppInstance

getCurrentPages

获取当前页面栈

引入

import { getCurrentPages } from '@ray-js/ray';

签名

getCurrentPages() => Page[]

getElementById

获取页面节点

引入

import { getElementById } from '@ray-js/ray';

签名

getElementById(id: string) => Promise<Element>

showNotification

打开通知栏

引入

import { showNotification } from '@ray-js/ray';

签名

showNotification(options: Options) => void

Options

字段	类型	默认值	说明
icon	success ｜ warning ｜ error	'warning'	通知栏类型
backgroundColor	string	#FFF	背景颜色值，有效值为十六进制颜色
image	string	\	图片资源
closeIcon	string	x	关闭图标的路径
closeIconCenter	boolean	false	关闭图标按钮是否垂直居中
closeIconColor	string	'#81828B'	关闭图标的颜色
showCloseButton	boolean	false	是否显示关闭按钮
autoCloseTime	number	1500	自动关闭时间。需配合 showCloseButton: false 使用
message	string	\	通知栏文案
messageColor	'#495054'	\	通知栏文案颜色
onClose	(evt: { type: 'close' }) => void	\	关闭回调

hideNotification

关闭通知栏

引入

import { hideNotification } from '@ray-js/ray';

签名

hideNotification() => void

多语言 API

getLangContent

获取多语言

引入

import { getLangContent } from '@ray-js/ray';

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
langContent	object	多语言

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

getLangKey

获取手机当前地区语言 zh-hans 、en-GB

引入

import { getLangKey } from '@ray-js/ray';

需引入BizKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
langKey	string	手机当前地区语言

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }