summaryrefslogtreecommitdiffstats
path: root/devtools/docs/user/web_console/rich_output/index.rst
blob: 3ebed8428e95b346969a92642fde72af50f09f4c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
===========
Rich output
===========

When the Web console prints objects, it includes a richer set of information than just the object's name. In particular, it:


- :ref:`provides extra information for certain types <web_console_rich_output_type_specific>`
- :ref:`enables detailed examination of the object's properties <web_console_rich_output_examining_object_properties>`
- :ref:`provides richer information for DOM elements, and enables you to select them in the Inspector <web_console_rich_output_highlighting_and_inspecting_dom_nodes>`


.. _web_console_rich_output_type_specific:

Type-specific rich output
*************************

The Web Console provides rich output for many object types, including the following:


.. list-table::
  :widths: 20 80
  :header-rows: 0

  * - ``Object``
    - .. image:: web-console-object.png

  * - ``Date``
    - .. image:: web-console-date.png

  * - ``Promise``
    - .. image:: web-console-promise.png

  * - ``RegExp``
    - .. image:: web-console-regexp.png

  * - ``Window``
    - .. image:: web-console-window.png

  * - ``Document``
    - .. image:: web-console-document.png

  * - ``Element``
    - .. image:: web-console-element.png

  * - ``Event``
    - .. image:: webconsole-events.png


.. _web_console_rich_output_examining_object_properties:

Examining object properties
***************************

When an object is logged to the console it has a right-pointing triangle next to it, indicating that it can be expanded. Click on the triangle, and the object will be expanded to show its contents:

.. image:: console_logobject.png
  :class: border


Starting with Firefox 67 (available now in Firefox Developer) you can use the arrow keys on your keyboard to navigate through objects displayed in the console. The right-arrow key opens the details of an object and the left-arrow key closes open objects.


.. _web_console_rich_output_examining_request_details:

Examining request details
*************************


Similar to examining object details, you can see the details about a network request directly in the console. Click on the arrow next to the request and a details panel will open that is equivalent to the Headers panel in the Network Monitor tool.

.. raw:: html

  <iframe width="560" height="315" src="https://www.youtube.com/embed/Cj3Pjq6jk9s" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
  <br/>
  <br/>


Export output to the clipboard
******************************

Once you have output in the console window, you can save it to the clipboard by right-clicking on the output and selecting **Export visible messages to clipboard**:

.. image:: console_export.png
  :class: center


This will copy all of the output to the clipboard. Then you can paste it into a document. The output will look something like this:

.. code-block::

  console.log(todoList)
  Array(4) [ {…}, {…}, {…}, {…} ]
  debugger eval code:1:9
  undefined

If you expand objects, such as arrays, you get slightly different content. For example, by expanding the array in the above list, I get the following:

.. code-block::

  console.log(todoList)
  (4) […]

  0: Object { status: "Done", description: "Morning Pages", dateCreated: 1552404478137 }

  1: Object { status: "In Progress", description: "Refactor styles", dateCreated: 1552404493169 }

  2: Object { status: "To Do", description: "Create feedback form", dateCreated: 1552404512630 }

  3: Object { status: "To Do", description: "Normalize table", dateCreated: 1552404533790 }

  length: 4

  <prototype>: Array []
  debugger eval code:1:9
  undefined


.. _web_console_rich_output_highlighting_and_inspecting_dom_nodes:

Highlighting and inspecting DOM nodes
*************************************

If you hover the mouse over any DOM element in the console output, it's highlighted on the page:

.. image:: commandline-highlightnode.png
  :class: center

In the screenshot above you'll also see a blue "target" icon next to the node in the console output: click it to switch to the :doc:`Inspector <../../page_inspector/index>` with that node selected.