summaryrefslogtreecommitdiffstats
path: root/devtools/docs/user/page_inspector/ui_tour
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 17:32:43 +0000
commit6bf0a5cb5034a7e684dcc3500e841785237ce2dd (patch)
treea68f146d7fa01f0134297619fbe7e33db084e0aa /devtools/docs/user/page_inspector/ui_tour
parentInitial commit. (diff)
downloadthunderbird-upstream.tar.xz
thunderbird-upstream.zip
Adding upstream version 1:115.7.0.upstream/1%115.7.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'devtools/docs/user/page_inspector/ui_tour')
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/animation_detail.pngbin0 -> 8765 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/compat_panel_settings.pngbin0 -> 28317 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/compat_view.pngbin0 -> 22691 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/index.rst161
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/indpextor_rules.pngbin0 -> 8157 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/inspector_2pane.pngbin0 -> 22241 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/inspector_computed.pngbin0 -> 5761 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/inspector_fonts.pngbin0 -> 4306 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/inspector_layout.pngbin0 -> 5968 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/inspector_tool.pngbin0 -> 28629 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/pageinspector.pngbin0 -> 53683 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/select_element_button.pngbin0 -> 1069 bytes
-rw-r--r--devtools/docs/user/page_inspector/ui_tour/track_changes.pngbin0 -> 10359 bytes
13 files changed, 161 insertions, 0 deletions
diff --git a/devtools/docs/user/page_inspector/ui_tour/animation_detail.png b/devtools/docs/user/page_inspector/ui_tour/animation_detail.png
new file mode 100644
index 0000000000..95909753cf
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/animation_detail.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/compat_panel_settings.png b/devtools/docs/user/page_inspector/ui_tour/compat_panel_settings.png
new file mode 100644
index 0000000000..2401873c8e
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/compat_panel_settings.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/compat_view.png b/devtools/docs/user/page_inspector/ui_tour/compat_view.png
new file mode 100644
index 0000000000..138621bcd2
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/compat_view.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/index.rst b/devtools/docs/user/page_inspector/ui_tour/index.rst
new file mode 100644
index 0000000000..33abe11538
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/index.rst
@@ -0,0 +1,161 @@
+=======
+UI Tour
+=======
+
+This article is a quick tour of the main sections of the Page Inspector's user interface.
+
+It covers the three top-level components of the Inspector's UI:
+
+- the "Select element" button
+- the HTML pane
+- the CSS pane
+
+
+.. image:: pageinspector.png
+ :alt: The all-new Inspector panel in Firefox 57.
+
+This guide is intentionally kept as short as possible. It links to various how to guides for the details of how to work with the Inspector.
+
+
+.. _page_inspector_select_element_button:
+
+Select element button
+*********************
+
+The Inspector gives you detailed information about the currently selected element. The Select element button is one way you can select an element for inspection:
+
+.. image:: select_element_button.png
+ :alt: This is the button in Firefox 57 Inspector you can use to select elements on a web page.
+ :class: center
+
+Note that it's actually part of the :ref:`main toolbox toolbar <tools-toolbox-toolbar>`, so it's immediately accessible from any tool, not just the Inspector.
+
+To learn how to select an element, see the guide to :doc:`selecting an element <../how_to/select_an_element/index>`.
+
+
+.. _page_inspector_ui_tour_html_pane:
+
+HTML pane
+*********
+
+The Inspector is split into two or three sections, depending on your settings. You can toggle the 3-pane view of the Inspector. The following image shows the 2-pane layout:
+
+.. image:: inspector_2pane.png
+ :alt: These are the tasty new HTML and CSS panes in Firefox 57.
+ :class: border
+
+
+In 2-pane mode, the Inspector includes the HTML Pane, and the CSS Pane, which can contain one of six tools:
+
+- Rules view
+- Layout view
+- Computed view
+- Changes view
+- Compatibility view (Firefox Developer Edition 77 and later)
+- Fonts view
+- Animations view
+
+The following image shows the 3-pane mode (available from Firefox 62 onwards) which moves the CSS Rules view into a separate pane in the center of the Inspector. The following image shows 3-pane mode:
+
+.. image:: inspector_tool.png
+ :class: border
+
+As you can see, the CSS pane has moved into the center of the Inspector. To learn more about the structure of the HTML pane, see the guide to :doc:`examining and editing HTML <../how_to/examine_and_edit_html/index>`.
+
+
+.. _page_inspector_ui_tour_rules_view:
+
+Rules view
+**********
+
+The Rules view lists all the rules that apply to the selected element, ordered from most-specific to least-specific. See above.
+
+.. image:: indpextor_rules.png
+ :alt: The rules view within the Inspector.
+ :class: border
+
+See :doc:`Examine and edit CSS <../how_to/examine_and_edit_css/index>` for more details.
+
+
+Layout view
+***********
+
+The Layout view displays the box model of the page. If the page includes any sections using either the Flexbox display model or CSS Grids, this view shows the Flexbox or Grid settings used on the page.
+
+.. image:: inspector_layout.png
+ :class: border
+
+To learn more about the Layout view, see :doc:`Examine and edit the box model <../how_to/examine_and_edit_the_box_model/index>`. Note that before Firefox 50, the box model view did not appear in the "Layout view" tab, but had its own tab.
+
+
+Changes view
+************
+
+When you are editing in the Rules view, you can see the changes you have made in the Changes view.
+
+.. image:: track_changes.png
+ :class: border
+
+.. _page_inspector_ui_tour_computed_view:
+
+Computed view
+*************
+
+The Computed view shows you the complete computed CSS for the selected element (The computed values are the same as what `getComputedStyle <https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle>`_ would return):
+
+.. image:: inspector_computed.png
+ :alt: The Computed view within the Inspector
+ :class: border
+
+To learn more about the CSS declarations listed in this view, see :ref:`Examine computed CSS <page_inspector_how_to_examine_and_edit_css_examine_computed_css>`.
+
+
+.. _page_inspector_ui_tour_compatibility_view:
+
+Compatibility view
+******************
+
+Starting with Firefox Developer Edition version 77, the Compatibility view shows CSS compatibility issues, if any, for properties applied to the selected element, and for the current page as a whole. It shows icons for the browsers that *do* support the properties, and notes properties that are experimental or deprecated.
+
+.. image:: compat_view.png
+ :alt: Screenshot of the Compatibility view
+ :class: center
+
+
+- Click the name of the property to open the reference article for that property on *MDN Web Docs*. The "Browser compatibility" section of the article gives details of browser support for the property.
+
+- In the **All Issues** section, click the name of the element that uses the property to select that element in the inspector. If more than one element has a given property applied to it, click the triangle to show all the occurrences.
+
+- To configure the set of browsers you want the Compatibility view to check for, click **Settings** at the bottom of the panel.
+
+.. image:: compat_panel_settings.png
+ :alt: Screenshot of the Settings for the Compatibility view
+
+
+Untick the checkbox for any browser you are not interested in. As new browser versions are released, the version numbers in this list will be updated.
+
+
+Fonts view
+**********
+
+The Fonts view shows all the fonts in the page along with editable samples.
+
+.. image:: inspector_fonts.png
+ :alt: The all-new Inspector panel in Firefox 57.
+ :class: border
+
+See :doc:`View fonts <../how_to/edit_fonts/index>` for more details.
+
+
+.. _page_inspector_ui_tour_animations_view:
+
+Animations view
+***************
+
+The Animations view gives you details of any animations applied to the selected element, and a controller to pause them:
+
+.. image:: animation_detail.png
+ :alt: This is the Animations pane in the Firefox 57 Inspector.
+ :class: border
+
+See :doc:`Work with animations <../how_to/work_with_animations/index>` for more details.
diff --git a/devtools/docs/user/page_inspector/ui_tour/indpextor_rules.png b/devtools/docs/user/page_inspector/ui_tour/indpextor_rules.png
new file mode 100644
index 0000000000..c1f3c35e7c
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/indpextor_rules.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/inspector_2pane.png b/devtools/docs/user/page_inspector/ui_tour/inspector_2pane.png
new file mode 100644
index 0000000000..42834664ea
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/inspector_2pane.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/inspector_computed.png b/devtools/docs/user/page_inspector/ui_tour/inspector_computed.png
new file mode 100644
index 0000000000..dcd8594aca
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/inspector_computed.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/inspector_fonts.png b/devtools/docs/user/page_inspector/ui_tour/inspector_fonts.png
new file mode 100644
index 0000000000..138361f572
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/inspector_fonts.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/inspector_layout.png b/devtools/docs/user/page_inspector/ui_tour/inspector_layout.png
new file mode 100644
index 0000000000..dfdcc2b714
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/inspector_layout.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/inspector_tool.png b/devtools/docs/user/page_inspector/ui_tour/inspector_tool.png
new file mode 100644
index 0000000000..9c32d3ae62
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/inspector_tool.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/pageinspector.png b/devtools/docs/user/page_inspector/ui_tour/pageinspector.png
new file mode 100644
index 0000000000..a43b0d71e9
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/pageinspector.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/select_element_button.png b/devtools/docs/user/page_inspector/ui_tour/select_element_button.png
new file mode 100644
index 0000000000..8c19f3b1c0
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/select_element_button.png
Binary files differ
diff --git a/devtools/docs/user/page_inspector/ui_tour/track_changes.png b/devtools/docs/user/page_inspector/ui_tour/track_changes.png
new file mode 100644
index 0000000000..d4e234b9c5
--- /dev/null
+++ b/devtools/docs/user/page_inspector/ui_tour/track_changes.png
Binary files differ