Hitbim SDK Documentation

component

Description:

An Object which is a collection of functions that manage components. The component currently has "tabbar" only.

Source:

bim.sdk.js, line 5639

Properties:

Name	Type	Description
`hide`	function	Function to hide component. See bim.component.hide for more details.
`show`	function	Function to show component. See bim.component.show for more details.
`active`	function	Function to activate component. See bim.component.active for more details.
`set`	function	Function to set component. See bim.component.set for more details.
`build`	function	Function to build component. See bim.component.build for more details

Methods

(static) hide(params)

Description:

Function to hide component. Currently, only "tabbar" is supported. Defaultly sets the animation delay to 500 ms.

Source:

bim.sdk.js, line 5665

Example

bim.component.hide({type: "tabbar", delay: 300});

Parameters:

Name Type Description

params

Object

Required.

Properties

Name	Type	Attributes	Default	Description
`type`	string			Currently, only "tabbar" is supported.
`delay`	number	<optional>	`500`	Delay of the animation.

Returns:

(static) show(params)

Description:

Function to show component. Currently, only "tabbar" is supported.

Source:

bim.sdk.js, line 5695

Example

bim.component.show({type: "tabbar"});

Parameters:

Name Type Description

params

Object

Required.

Properties

Name	Type	Description
`type`	string	Currently, only "tabbar" is supported.

Returns:

(static) active(params)

Description:

Function to activate component. Currently, only "tabbar" is supported.

Source:

bim.sdk.js, line 5720

Example

bim.component.active({type: "tabbar"});

Parameters:

Name Type Description

params

Object

Required.

Properties

Name	Type	Description
`type`	string	Currently, only "tabbar" is supported.

Returns:

(static) set(params)

Description:

Function to set component.

Source:

bim.sdk.js, line 5747

Example

const bimComponent = {
 type: "tabbar",
 id: ${1:id},
 css: ${2:css},
 js: ${3:js},
 assets: ${4:assets},
 level: ${5:level},
 body: ${6:body},
};
bim.component.set(bimComponent);

Parameters:

Name Type Description

params

Object

Required.

Properties

Name	Type	Description
`type`	*	*Required.*
`id`	*	*Required.*
`css`	*	*Required.*
`js`	*	*Required.*
`assets`	*	*Required.*
`level`	*	*Required.*
`body`	*	*Required.*

Returns:

(static) build(params)

Description:

Function to build component. Currently, only "Android" is supported. Currently, only "tabbar" is supported.

Source:

bim.sdk.js, line 5804

Deprecated:

It is same with bim.component.show

Example

bim.component.build({type: "tabbar"});

Parameters:

Name Type Description

params

Object

Properties

Name	Type	Description
`type`	string	Currently, only "tabbar" is supported.