summaryrefslogtreecommitdiffstats
path: root/devtools/docs/user/dom_property_viewer/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'devtools/docs/user/dom_property_viewer/index.rst')
-rw-r--r--devtools/docs/user/dom_property_viewer/index.rst53
1 files changed, 53 insertions, 0 deletions
diff --git a/devtools/docs/user/dom_property_viewer/index.rst b/devtools/docs/user/dom_property_viewer/index.rst
new file mode 100644
index 0000000000..c5893a82fa
--- /dev/null
+++ b/devtools/docs/user/dom_property_viewer/index.rst
@@ -0,0 +1,53 @@
+===================
+DOM Property Viewer
+===================
+
+.. container:: block_quote
+
+ The DOM Property Viewer is new in Firefox 48. It is disabled by default. Enable it in the :ref:`Developer Tools Settings <tool-toolbox-settings>`
+
+The DOM Property Viewer lets you inspect the properties of the `DOM <https://developer.mozilla.org/en-US/docs/Glossary/DOM>`_ as an expandable tree structure, starting from the `window <https://developer.mozilla.org/en-US/docs/Web/API/Window>`_ object of the current page or the :doc:`selected iframe <../working_with_iframes/index>`.
+
+.. image:: dom_inspector.png
+ :class: center
+
+
+Enabling the DOM Property Viewer
+********************************
+
+The DOM Property Viewer is not enabled by default. To enable it, open the :ref:`developer tools settings <tool-toolbox-settings>` and check the "DOM" box under "Default Firefox Developer Tools".
+
+
+Opening the DOM Property Viewer
+*******************************
+
+Once enabled, you can select the *DOM* panel in the Web Developer Tools, accessible from the Browser Tools submenu
+
+The :doc:`Toolbox <../tools_toolbox/index>` will appear at the bottom of the browser window, with the DOM Property Viewer activated. It's just called "DOM" in the Toolbox.
+
+DOM Property Viewer user interface
+**********************************
+
+DOM tree
+--------
+
+The different properties of the DOM are displayed as an expandable tree. The left-hand side shows the property's name, and the right-hand side shows its value. Up to three properties of an object and items of an array are displayed. If a property has more elements than this, you'll see a "more..." annotation, and will need to click the property to see all elements. A lock icon indicates that a property is not writable.
+
+Refreshing the display
+----------------------
+
+If the DOM changes you can hit the *Refresh* button to update the display:
+
+.. image:: dom_inspector_refresh_button.png
+ :alt: Button to update the DOM Inspector display
+ :class: center
+
+Filtering
+---------
+
+There is a search box within the toolbar:
+
+.. image:: dom_inspector_search_box.png
+ :class: center
+
+This filters the list to show only items which match the search term. Items match the search term if their name contains the search term. Matching is case-sensitive.