Skip to content

Latest commit

 

History

History
214 lines (128 loc) · 3.37 KB

public_properties_methods.md

File metadata and controls

214 lines (128 loc) · 3.37 KB

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 // => "3.0.0"

vConsole.option

A configuration object.

  • Writable
  • Type: object
Key Type Optional Default value Description
defaultPlugins Array true ['system', 'network', 'element', 'storage'] Listed built-in plugins will be inited and loaded into vConsole.
maxLogNumber Number true 1000 Overflow logs will be removed from log tabs.

Example:

// get
vConsole.option // => {...}
// set
vConsole.setOption('maxLogNumber', 5000);
// or:
vConsole.setOption({maxLogNumber: 5000});

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.setOption(keyOrObj[, value])

Update vConsole.option.

Parameters:
  • (required) keyOrObj: The key of option, or a key-value object.
  • (optional) value: The value of an option.
Return:
  • None
Example:
vConsole.setOption('maxLogNumber', 5000);
// or:
vConsole.setOption({maxLogNumber: 5000});

vConsole.destroy()

Destroy an vConsole instance object and remove vConsole panel from document.

Parameters:
  • None
Return:
  • None
Example:
var vConsole = new VConsole();
// ... do something
vConsole.destroy();

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