Skip to content

Latest commit

 

History

History
151 lines (86 loc) · 2.08 KB

public_properties_methods.md

File metadata and controls

151 lines (86 loc) · 2.08 KB
Raw

Public Properties & Methods

Some useful vConsole properties and methods are available for plugin development.

Properties

vConsole.version

The current version of vConsole.

  • Readonly
  • Type: string

Example:

vConsole.version // => "2.1.0"

vConsole.activedTab

The actived tab's plugin id.

  • Readonly
  • Type: string
  • Default: "default"

Example:

vConsole.activedTab // => "system"

vConsole.tabList

A list of installed tabs' plugin id.

  • Readonly
  • Type: array(string)

Example:

vConsole.tabList // => ["default", "system"]

vConsole.$dom

vConsole's HTML element.

  • Type: HTMLDivElement

Methods

vConsole.addPlugin(plugin)

Add a new plugin to vConsole. Duplicate plugin will be ignored.

Parameters:
  • (required) plugin: An VConsolePlugin object.
Return:
  • Boolean: true for success, false for failure.
Example:
var myPlugin = new VConsolePlugin('my_plugin', 'My Plugin');
vConsole.addPlugin(myPlugin);

vConsole.removePlugin(pluginID)

Remove an existing plugin.

Parameters:
  • (required) pluginID: A string, plugin's id.
Return:
  • Boolean: true for success, false for failure.
Example:
vConsole.removePlugin('my_plugin');

vConsole.showTab(pluginID)

Activating a tab according to its plugin id.

Plugin event hide will be triggered for previous actived tab, and show for current actived tab.

Parameters:
  • (required) pluginID: A string, tab's plugin id.
Return:
  • None
Example:
vConsole.showTab("system"); // show System tab

vConsole.show()

Show vConsole panel. This method will trigger plugin event showConsole.

Parameters:
  • None
Return:
  • None
Example:
vConsole.show();

vConsole.hide()

Hide vConsole panel. This method will trigger plugin event hideConsole.

Parameters:
  • None
Return:
  • None
Example:
vConsole.hide();

Back to Index