Console Panel

From FirebugWiki

(Difference between revisions)
Jump to: navigation, search
(Added a description of the panel menu)
m (Changed image for options menu arrow)
(21 intermediate revisions not shown)
Line 1: Line 1:
 +
[[Image:Console_Panel.png|thumb|400px|Console Panel]]
The console panel offers a JavaScript command line, lists all kinds of messages and offers a profiler for JavaScript commands.
The console panel offers a JavaScript command line, lists all kinds of messages and offers a profiler for JavaScript commands.
-
== Panel Menu ==
+
== Options Menu ==
 +
This menu is reachable via the little arrow in the panel tab ( [[File:ConsolePanelOptionsMenuArrow.png]] ) or by right-clicking on on the panel tab (since [[Firebug Release Notes#Firebug 1.9|Firebug 1.9]]).
 +
 
 +
{| class="wikitable" style="width:100%; vertical-align:top;"
 +
|- bgcolor=lightgrey
 +
! style="width:220px;" | Option || Preference || Description
 +
|-
 +
| Enabled || <code>extensions.firebug.console.enableSites</code> || Enables the Console Panel
 +
|-
 +
| Disabled || <code>extensions.firebug.console.enableSites</code> || Disables the Console Panel
 +
|-
 +
| Show JavaScript Errors || <code>extensions.firebug.showJSErrors</code> || Toggles logging of JavaScript error messages into the console
 +
|-
 +
| Show JavaScript Warnings || <code>extensions.firebug.showJSWarnings</code> || Toggles logging of JavaScript warning messages into the console
 +
|-
 +
| Show CSS Errors || <code>extensions.firebug.showCSSErrors</code> || Toggles logging of CSS error messages into the console
 +
|-
 +
| Show XML/HTML Errors || <code>extensions.firebug.showXMLErrors</code> || Toggles logging of XML and HTML error messages into the console
 +
|-
 +
| Show XMLHttpRequests || <code>extensions.firebug.showXMLHttpRequests</code> || Toggles logging of XMLHttpRequests into the console; see the [[Net Panel]] for more info
 +
|-
 +
| Show Chrome Errors || <code>extensions.firebug.showChromeErrors</code> || Toggles logging of program and add-on internal error messages into the console
 +
|-
 +
| Show Chrome Messages || <code>extensions.firebug.showChromeMessages</code> || Toggles logging of program and add-on internal messages into the console
 +
|-
 +
| Show External Errors || <code>extensions.firebug.showExternalErrors</code> || Toggles logging of external error messages into the console
 +
|-
 +
| Show Network Errors || <code>extensions.firebug.showNetworkErrors</code> || Toggles logging of network error messages into the console
 +
|-
 +
| Show Stack Trace With Errors || <code>extensions.firebug.service.showStackTrace</code> || Toggles the inclusion of the stack trace for error messages
 +
|-
 +
| Show Cookie Events || <code>extensions.firebug.cookies.logEvents</code> || Toggles logging of cookie events into the console; see the [[Cookies Panel]] for more info
 +
|-
 +
| Strict Warnings (performance penalty) || <code>javascript.options.strict</code> || Toggles logging of strict warnings into the console
 +
|-
 +
| Command Editor || <code>extensions.firebug.commandEditor</code> || Toggles between the [[Console Panel#Command Line|Command Line]] and the [[Console Panel#Command Editor|Command Editor]]
 +
|-
 +
| Show Completion List Popup|| <code>extensions.firebug.commandLineShowCompleterPopup</code> || Toggles the auto-completion of commands while typing
 +
|}
 +
 
 +
For more info about tweaks available in Firebug please see the [[Firebug Preferences|full list of preferences]].
 +
 
 +
== Panel Toolbar ==
=== Break On All Errors ===
=== Break On All Errors ===
-
As some of the other panels the console panel offers a "Break On..." feature. In this case it's "Break On All Errors", which means, that as soon as an error occurs the script execution is stopped.
+
As with some of the other panels the console panel offers a "Break On..." feature. In this case it's "Break On All Errors", which means that as soon as an error occurs the script execution is stopped.
=== Clear ===
=== Clear ===
Line 9: Line 52:
=== Persist ===
=== Persist ===
-
The "Persist" option prevents clearing the console at a page reload. That means, the messages will stay inside the console as long as this option is enabled.
+
This option prevents clearing the console when a page is reloaded. Thus all messages will stay inside the console as long as this option is enabled.
=== Profile ===
=== Profile ===
-
Enabling this option lets you profile JavaScript activity. For more info about this feature see the [[#Profiling]] section.
+
Enabling this option lets you profile JavaScript activity. For more info about this feature see the [[Console Panel#Profiling|Profiling]] section.
-
== Command Line ==
+
=== Memory Profile ===
-
The command line is simply used for executing JavaScript commands, but is designed to support people writing code and inspecting objects. For this reason it offers several functionalities, which are described below.
+
If <code>extensions.firebug.memoryProfilerEnable</code> is set to <code>true</code>, there's another button called ''Memory Profile''. Enabling this option lets you profile memory activity. For more info about this feature see the [[Console Panel#Profiling|Profiling]] section.
-
=== Autocomplete ===
+
== [[Command Line]] ==
-
To support the user analysing elements and writing code the command line integrates an auto-completion for the commands you are typing. Therefore after starting to type a command you simply have to press tab and Firebug is completing the command. If there are several commands starting with the same phrase like "getElem" then pressing tab several times alphabetically switches through all available commands. Thereby also the global variables, which you defined in your script, are used.
+
The [[Command Line]] is simply used for executing JavaScript commands, but is designed to support people writing code and inspecting objects. For this reason it offers several functionalities. Thereby there are some additional features available inside the Console Panel.
-
=== Command editor ===
+
=== Command Editor ===
-
The command editor offers you a bigger text field for entering JavaScript commands consisting of several lines. It has an integrated menu for running the command(s), clearing the text field and copying the contents to the clipboard.
+
The Command Editor offers you a bigger text field for entering JavaScript commands consisting of several lines. It has an integrated menu for running the command(s), clearing the text field and copying the contents to the clipboard.
=== Smart paste ===
=== Smart paste ===
If you are pasting code into the command line, that consists of several lines, the command editor is automatically opened to keep the line breaks.
If you are pasting code into the command line, that consists of several lines, the command editor is automatically opened to keep the line breaks.
-
 
-
=== Clipboard functionality ===
 
-
The entered script can be copied as bookmarklet via the menu of the command editor.
 
-
 
-
=== Shortcuts for inspected elements ===
 
-
The command line and the command editor offer you the possibility to easily access elements inside the DOM similar to the sizzle selector library integrated in the jQuery Framework. For a detailed description of the available commands see the [[Command Line API]].
 
-
 
-
=== Inspect object in other panel ===
 
-
How you inspect elements using the console is described above. Besides that it's also possible to inspect them in the most appropriate panel by hitting Shift+Enter instead of just Enter.
 
== Console ==
== Console ==
Line 41: Line 75:
The console knows four different types of messages, which are described below:
The console knows four different types of messages, which are described below:
-
{|
+
{| class="wikitable" style="vertical-align:top;"
-
!Type||Command||Description
+
|- bgcolor=lightgrey
 +
! style="width:80px" | Type || style="width:300px" | Command || Description
|-  
|-  
-
|Error||console.error(object[, object, ...])||Error messages occurring in JavaScript, CSS, XML, chrome, network and stack trace
+
| Error || <code>console.error(object[, object, ...])</code> || Error messages occurring in JavaScript, CSS, XML, chrome, network and stack trace
|-  
|-  
-
|Warning||console.warn(object[, object, ...])||Warnings occurring in JavaScript and CSS
+
| Warning || <code>console.warn(object[, object, ...])</code> || Warnings occurring in JavaScript and CSS
|-
|-
-
|Info||console.info(object[, object, ...])||Informative messages
+
| Info || <code>console.info(object[, object, ...])</code> || Informative messages
|-
|-
-
|Debug||console.debug(object[, object, ...])||Debugging messages
+
| Debug || <code>console.debug(object[, object, ...])</code> || Debugging messages
|}
|}
See also the [[Console API]] for more information about the different commands.
See also the [[Console API]] for more information about the different commands.
Line 58: Line 93:
=== Profiling ===
=== Profiling ===
-
The console also offers the functionality to profile JavaScript activity via a button in the panel menu. Pressing it once starts the profiler and clicking it again stops profiling. All JavaScript commands, that were executed while the profiler was active, will be listed including detailed statistics about the calls.
+
The console also offers functionality to profile JavaScript activity and memory consumption information via two buttons in the Panel Toolbar. For more information please see the [[Profiler]].
== See also ==
== See also ==
* [[Command Line API]]
* [[Command Line API]]
* [[Console API]]
* [[Console API]]

Revision as of 00:08, 24 December 2012

Console Panel

The console panel offers a JavaScript command line, lists all kinds of messages and offers a profiler for JavaScript commands.

Contents

Options Menu

This menu is reachable via the little arrow in the panel tab ( ConsolePanelOptionsMenuArrow.png ) or by right-clicking on on the panel tab (since Firebug 1.9).

Option Preference Description
Enabled extensions.firebug.console.enableSites Enables the Console Panel
Disabled extensions.firebug.console.enableSites Disables the Console Panel
Show JavaScript Errors extensions.firebug.showJSErrors Toggles logging of JavaScript error messages into the console
Show JavaScript Warnings extensions.firebug.showJSWarnings Toggles logging of JavaScript warning messages into the console
Show CSS Errors extensions.firebug.showCSSErrors Toggles logging of CSS error messages into the console
Show XML/HTML Errors extensions.firebug.showXMLErrors Toggles logging of XML and HTML error messages into the console
Show XMLHttpRequests extensions.firebug.showXMLHttpRequests Toggles logging of XMLHttpRequests into the console; see the Net Panel for more info
Show Chrome Errors extensions.firebug.showChromeErrors Toggles logging of program and add-on internal error messages into the console
Show Chrome Messages extensions.firebug.showChromeMessages Toggles logging of program and add-on internal messages into the console
Show External Errors extensions.firebug.showExternalErrors Toggles logging of external error messages into the console
Show Network Errors extensions.firebug.showNetworkErrors Toggles logging of network error messages into the console
Show Stack Trace With Errors extensions.firebug.service.showStackTrace Toggles the inclusion of the stack trace for error messages
Show Cookie Events extensions.firebug.cookies.logEvents Toggles logging of cookie events into the console; see the Cookies Panel for more info
Strict Warnings (performance penalty) javascript.options.strict Toggles logging of strict warnings into the console
Command Editor extensions.firebug.commandEditor Toggles between the Command Line and the Command Editor
Show Completion List Popup extensions.firebug.commandLineShowCompleterPopup Toggles the auto-completion of commands while typing

For more info about tweaks available in Firebug please see the full list of preferences.

Panel Toolbar

Break On All Errors

As with some of the other panels the console panel offers a "Break On..." feature. In this case it's "Break On All Errors", which means that as soon as an error occurs the script execution is stopped.

Clear

Clears the console by removing all messages from the output.

Persist

This option prevents clearing the console when a page is reloaded. Thus all messages will stay inside the console as long as this option is enabled.

Profile

Enabling this option lets you profile JavaScript activity. For more info about this feature see the Profiling section.

Memory Profile

If extensions.firebug.memoryProfilerEnable is set to true, there's another button called Memory Profile. Enabling this option lets you profile memory activity. For more info about this feature see the Profiling section.

Command Line

The Command Line is simply used for executing JavaScript commands, but is designed to support people writing code and inspecting objects. For this reason it offers several functionalities. Thereby there are some additional features available inside the Console Panel.

Command Editor

The Command Editor offers you a bigger text field for entering JavaScript commands consisting of several lines. It has an integrated menu for running the command(s), clearing the text field and copying the contents to the clipboard.

Smart paste

If you are pasting code into the command line, that consists of several lines, the command editor is automatically opened to keep the line breaks.

Console

The console offers three different functionalities. It is showing all messages Firefox' error console is showing. Furthermore it is displaying the results of the commands you entered into the command line. Last but not least it has an integrated profiler for JavaScript activities. For a detailed description of console commands see the Console API.

Message types

The console knows four different types of messages, which are described below:

Type Command Description
Error console.error(object[, object, ...]) Error messages occurring in JavaScript, CSS, XML, chrome, network and stack trace
Warning console.warn(object[, object, ...]) Warnings occurring in JavaScript and CSS
Info console.info(object[, object, ...]) Informative messages
Debug console.debug(object[, object, ...]) Debugging messages

See also the Console API for more information about the different commands.

Click functionality

Console messages offer you different kinds of options you can access via the mouse buttons resp. the mouse wheel. E. g. clicking on the links in an error message or warning jumps directly to the appropriate panel. Right clicking on them gives you the possibility to copy the message to the clipboard or set a breakpoint for the specific error or all errors. XML HTTP requests thereby let you copy the location or response body via the context menu. Clicking on them shows you detailed information about the request. And middle-clicking opens the requested URL in a new tab.

Profiling

The console also offers functionality to profile JavaScript activity and memory consumption information via two buttons in the Panel Toolbar. For more information please see the Profiler.

See also

Personal tools