diff --git a/microsoft-edge/devtools-guide-chromium/css/css-overview-tool.md b/microsoft-edge/devtools-guide-chromium/css/css-overview-tool.md index ef6efd31c6..8faec41a5c 100644 --- a/microsoft-edge/devtools-guide-chromium/css/css-overview-tool.md +++ b/microsoft-edge/devtools-guide-chromium/css/css-overview-tool.md @@ -1,49 +1,161 @@ --- -title: CSS Overview tool +title: Optimize CSS styles with the CSS Overview tool description: The CSS Overview tool in Microsoft Edge DevTools. author: MSEdgeTeam ms.author: msedgedevrel ms.topic: conceptual ms.prod: microsoft-edge ms.technology: devtools -ms.date: 02/15/2022 +ms.date: 09/07/2022 --- - -# CSS Overview tool + +## Open the CSS Overview tool + +To open the **CSS Overview** tool: + +1. Navigate to the [TODO list demo app](https://microsoftedge.github.io/Demos/demo-to-do/) in Microsoft Edge, or to your own webpage. + +1. Open DevTools by pressing `F12` or `Ctrl`+`Shift`+`I` (Windows, Linux) or `Command`+`Option`+`I` (macOS). + +1. In the main toolbar, click **More Tools** and select **CSS Overview** from the list. + + ![Microsoft Edge, with the TODO list demo app, and DevTools next to it, showing the list of tools from the More Tools button](images/css-overview-tool-open.png) + +1. The **CSS Overview** tool opens and shows a welcome screen. + + ![Microsoft Edge, with the TODO list demo app, and DevTools next to it, showing the CSS Overview welcome screen](images/css-overview-tool-welcome.png) + + + +## Capture a CSS overview report + +Start using the tool by capturing a new report. Click **Capture overview**, the overview report appears. + +![Microsoft Edge, with the TODO list demo app, and DevTools next to it, showing the CSS Overview report for that site](images/css-overview-tool-report.png) + +If you make changes to your webpage and want to view a new report, click **Clear overview** and then capture a new overview. + +![Microsoft Edge, with the TODO list demo app, and DevTools next to it, showing a CSS Overview report with the Clear overview button at the top](images/css-overview-tool-clear.png) + + + +## Understand the report + +The overview report contains information organized in several sections: + +* **Summary**: statistics about key CSS rules, selectors, and media queries on the page. +* **Colors**: colors used on the page. +* **Font info**: list of fonts on the page. +* **Unused declarations**: list of unused CSS declarations. +* **Media queries**: list of media queries. + +To review the above sections, scroll through the report, or use the table of content sidebar. + +![Microsoft Edge, with the TODO list demo app and DevTools, showing the table of content and scrollbar in the CSS Overview report](images/css-overview-tool-scroll.png) + +### Summary + +The **Summary** section is useful to get a quick overview of your CSS code. It provides the number of external and inline stylesheets, the number of CSS rules, the number of selectors and their various types, and the number of media queries. + +This can be used to assess the volume and consistency of your CSS codebase on a given webpage. For example, if you decided to only use class selectors, the **Summary** section will make it quick to detect other types of selectors like ID or attribute. + +### Colors + +The **Colors** section lists all the colors used on the webpage, and groups them by background, text, fill, and border categories. + +This can be useful to discover cases when several similar colors are used instead of one common color. CSS custom properties (also known as CSS variables) can be used to avoid repeating colors throughout a CSS file and therefore avoid this problem. Learn more about CSS variables on [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/--*)). + +The **Colors** section also contains a list of color contrast issues on the page. To learn more, see [View elements with color contrast issues](#view-elements-with-color-contrast-issues). + +### Font info - +The **Font info** section lists all the font families used on the webpage and provides details about which sizes, weights, and line heights are used for each. -The **CSS Overview** tool displays a summary of CSS-related information about the webpage. This tool lists the colors, fonts, and media queries the webpage uses. The tool also lists the elements on your page that have color contrast issues, and the unused CSS declarations. The [CSS Overview Accessible Colors Demo](https://css-overview-accessible-colors-demo.glitch.me) page has an example of a color contrast issue. +When designing a webpage, using consistent typography settings can help reach a more aesthetically-pleasing result. The **Font info** section can be useful to detect when too many different fonts or font styles are used. -To view a list of elements that have a color contrast issue, on **Contrast issues**, click **Text**. +Each font in the **Font info** section contains links to the DOM elements they apply to. To reveal the elements a given font applies to: -To open the element in the **Elements** tool, click an element in the list. To help fix contrast issues, DevTools [automatically provides color suggestions](../whats-new/2020/08/devtools.md#accessible-color-suggestion-in-the-styles-pane). +1. On the overview report, click **Font info** in the sidebar to scroll to the relevant section of the report. +1. Find the font family and the size, weight, or line-height you are interested in. -For updates on this feature in the Chromium open-source project, see Issue [#1120316](https://crbug.com/1120316). +1. Click the **X occurrences** link next to it to reveal the list of elements. -![Low color contrast issues.](../whats-new/media/2020/10/css-overview.msft.png) +1. Move your mouse over the elements in the list to highlight them in the rendered page. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing the list of elements for a given font-size, and a highlighted element on hover](images/css-overview-tool-font-element.png) + +1. Click an element to automatically open the **Elements** tool with that element selected. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing Elements tool, with the right node selected](images/css-overview-tool-elements-tool.png) + +### Unused declarations + +The **Unused declarations** section lists some of the CSS declarations that don't have an effect on their target elements. + +CSS declarations are key/value pairs such as `top: 42px`. CSS declarations are contained in CSS rules, and rules target specific elements on the webpage. Depending on other styles applied to an element, a CSS declaration may not have any effect. + +As an example, the `top: 42px` declaration will not have any effect if the element it targets is not positioned with `position: absolute` or `position: relative` for example. + +These cases may be hard to find and the **Unused declarations** section helps by listing some of them. Note that not all possible cases are listed. For now, the following cases are reported: + + +* When the `top`, `right`, `bottom`, or `left` properties are used on statically positioned elements. +* When the `width` or `height` properties are used on inline elements. +* When the `vertical-align` property is used on elements that are not inline or table cells. + +### Media queries + +The **Media queries** section lists the CSS media queries found on the webpage. + +CSS media queries can be used to apply specific styles depending on the media type (for example `print` or `screen`) or depending on the viewport size. This is often used to make webpages respond to the available space. + +When a CSS codebase becomes complex, keeping track of all the CSS media queries can be hard. The **Media queries** section makes this easier. Each media query in the section also contains a link to the CSS file it's defined in. To reveal that file: + +1. On the overview report, click **Media queries** in the sidebar to scroll to the relevant section of the report. + +1. In the report, find the media query you are interested in. + +1. Click the **X occurrences** link next to it to reveal the corresponding files. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing the media queries section of the Overview tool, and the list of files that contain a given media query](images/css-overview-tool-media-query.png) + +1. Click one of the files to automatically open the **Sources** tool with that file opened. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing the Sources tool, with the file that contains a media query opened, at the right line](images/css-overview-tool-sources-tool.png) -> [!NOTE] -> Portions of this page are modifications based on work created and [shared by Google](https://developers.google.com/terms/site-policies) and used according to terms described in the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0). -> The original page is found [here](https://developer.chrome.com/docs/devtools/css-overview/) and is authored by [Jecelyn Yeen](https://developers.google.com/web/resources/contributors#jecelyn-yeen) (Developer advocate, Chrome DevTools). +## View elements with color contrast issues + +The **Colors** section of the overview report can also be used to find color contrast issues on a webpage. If the current webpage contains elements where the contrast between the font color and the background color is insufficient, the **Contrast issues** sub-section will be displayed. + +To find color contrast issues: + +1. Navigate to the [Animal Shelter](https://microsoftedge.github.io/Demos/devtools-a11y-testing/) demo website, which has color contrast issues, in Microsoft Edge. Or navigate to your own website. + +1. Open DevTools by pressing `Ctrl`+`Shift`+`I` (Windows, Linux) or `Command`+`Option`+`I` (macOS). + +1. In the main toolbar, click **More Tools** and select **CSS Overview** from the list. + +1. In the **CSS Overview** tool, click **Capture overview** and then click **Colors** in the overview report sidebar. + +1. Scroll down to the **Contrast issues** sub-section to view all issues. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing a list of contrast issues in the CSS Overview report](images/css-overview-tool-contrast-issues.png) + +1. To view the elements that have a particular color contrast issue, choose the issue you want to fix and click **Text**. The corresponding elements are listed. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing a list of elements with a color contrast issue](images/css-overview-tool-contrast-issues-elements.png) + +1. To open the corresponding element in the **Elements** tool, click an element in the list. + + ![Microsoft Edge, with the TODO list demo app and DevTools, showing the Elements tool, with the color-contrast issue element selected](images/css-overview-tool-contrast-issues-elements-tool.png) -[![Creative Commons License.](../../media/cc-logo/88x31.png)](https://creativecommons.org/licenses/by/4.0) -This work is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0). +To help fix contrast issues, check out the [Text contrast](../accessibility/reference.md#text-contrast) section of the accessibility-testing DevTools features. diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-clear.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-clear.png new file mode 100644 index 0000000000..31a993ca01 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-clear.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues-elements-tool.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues-elements-tool.png new file mode 100644 index 0000000000..4d1d75fc21 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues-elements-tool.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues-elements.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues-elements.png new file mode 100644 index 0000000000..c1f6ad26be Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues-elements.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues.png new file mode 100644 index 0000000000..6d8b6a4f61 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-contrast-issues.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-elements-tool.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-elements-tool.png new file mode 100644 index 0000000000..9f2e0bf4b7 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-elements-tool.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-font-element.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-font-element.png new file mode 100644 index 0000000000..af2918af4d Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-font-element.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-media-query.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-media-query.png new file mode 100644 index 0000000000..ebfd0f7919 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-media-query.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-open.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-open.png new file mode 100644 index 0000000000..ca6b4b01ef Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-open.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-report.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-report.png new file mode 100644 index 0000000000..1346e6a537 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-report.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-scroll.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-scroll.png new file mode 100644 index 0000000000..d17b5ee5e2 Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-scroll.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-sources-tool.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-sources-tool.png new file mode 100644 index 0000000000..4e302386bf Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-sources-tool.png differ diff --git a/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-welcome.png b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-welcome.png new file mode 100644 index 0000000000..a32f66aa2a Binary files /dev/null and b/microsoft-edge/devtools-guide-chromium/css/images/css-overview-tool-welcome.png differ diff --git a/microsoft-edge/toc.yml b/microsoft-edge/toc.yml index 71c8d331f2..961b443856 100644 --- a/microsoft-edge/toc.yml +++ b/microsoft-edge/toc.yml @@ -378,7 +378,7 @@ # CSS Overview tool ----------------------------------------------------------- - name: CSS Overview tool items: - - name: Identify potential CSS improvements # real content pending + - name: Optimize CSS styles with the CSS Overview tool href: devtools-guide-chromium/css/css-overview-tool.md displayName: CSS Overview tool # Detached Elements tool ------------------------------------------------------