Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
interface Protocol.Overlay.HighlightConfig
import { type Protocol } from "https://deno.land/x/puppeteer@14.1.1/vendor/puppeteer-core/puppeteer/api-docs-entry.d.ts";
const { HighlightConfig } = Protocol.Overlay;

Configuration data for the highlighting of page elements.

Properties

optional
showInfo: boolean

Whether the node info tooltip should be shown (default: false).

optional
showStyles: boolean

Whether the node styles in the tooltip (default: false).

optional
showRulers: boolean

Whether the rulers should be shown (default: false).

optional
showAccessibilityInfo: boolean

Whether the a11y info should be shown (default: true).

optional
showExtensionLines: boolean

Whether the extension lines from node to the rulers should be shown (default: false).

optional
contentColor: DOM.RGBA

The content box highlight fill color (default: transparent).

optional
paddingColor: DOM.RGBA

The padding highlight fill color (default: transparent).

optional
borderColor: DOM.RGBA

The border highlight fill color (default: transparent).

optional
marginColor: DOM.RGBA

The margin highlight fill color (default: transparent).

optional
eventTargetColor: DOM.RGBA

The event target element highlight fill color (default: transparent).

optional
shapeColor: DOM.RGBA

The shape outside fill color (default: transparent).

optional
shapeMarginColor: DOM.RGBA

The shape margin fill color (default: transparent).

optional
cssGridColor: DOM.RGBA

The grid layout color (default: transparent).

optional
colorFormat: ColorFormat

The color format used to format color styles (default: hex).

optional
gridHighlightConfig: GridHighlightConfig

The grid layout highlight configuration (default: all transparent).

optional
flexContainerHighlightConfig: FlexContainerHighlightConfig

The flex container highlight configuration (default: all transparent).

optional
flexItemHighlightConfig: FlexItemHighlightConfig

The flex item highlight configuration (default: all transparent).

optional
contrastAlgorithm: ContrastAlgorithm

The contrast algorithm to use for the contrast ratio (default: aa).

optional
containerQueryContainerHighlightConfig: ContainerQueryContainerHighlightConfig

The container query container highlight configuration (default: all transparent).