setTabBarBadge

Requires:

MiniKit≥1.0.0@ray-js/ray≥0.3.23

Platforms:

iOSAndroid

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

// Promise usage
try {
  const res = await setTabBarBadge({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Method signature

setTabBarBadge(params: )

Description

Add text to the top-right corner of a tabBar item

Parameters

Property	Type	Required	Description
`index`	number	Yes	Which tabBar item, counting from the left
`text`	string	Yes	Text to display; if longer than 4 characters, it shows as ...
`complete`	() => void	No	Completion callback (executed on both success and failure)
`success`	() => void	No	Callback on successful API call
`fail`	(params: Object) => void	No	Failure callback

fail callback parameters

Property	Type	Description
`errorMsg`	string	Error message
`errorCode`	string \| number	Error code
		Error extension

Return Value

None

Examples

import { setTabBarBadge } from '@ray-js/ray'

setTabBarBadge({
  index: 0,
  text: "99",
  success: data => { console.log(data); },
  fail: error => { console.error(error); },
});