overlay

type BoxStyle struct {
	FillColor  *cdp.RGBA `json:"fillColor,omitempty,omitzero"`  // The background color for the box (default: transparent)
	HatchColor *cdp.RGBA `json:"hatchColor,omitempty,omitzero"` // The hatching color for the box (default: transparent)
}

type ColorFormat string

type ContainerQueryContainerHighlightConfig struct {
	ContainerBorder  *LineStyle `json:"containerBorder,omitempty,omitzero"`  // The style of the container border.
	DescendantBorder *LineStyle `json:"descendantBorder,omitempty,omitzero"` // The style of the descendants' borders.
}

type ContainerQueryHighlightConfig struct {
	ContainerQueryContainerHighlightConfig *ContainerQueryContainerHighlightConfig `json:"containerQueryContainerHighlightConfig"` // A descriptor for the highlight appearance of container query containers.
	NodeID                                 cdp.NodeID                              `json:"nodeId"`                                 // Identifier of the container node to highlight.
}

type ContrastAlgorithm string

type DisplayCutoutConfig struct {
	Rect         *dom.Rect          `json:"rect"`                            // A rectangle representing the cutout bounds.
	Shape        DisplayCutoutShape `json:"shape"`                           // Shape used to draw the cutout.
	BorderRadius int64              `json:"borderRadius,omitempty,omitzero"` // Border radius for rounded cutout shapes.
	UpperRadius  int64              `json:"upperRadius,omitempty,omitzero"`  // Upper shoulder radius for notch cutout shapes.
	LowerRadius  int64              `json:"lowerRadius,omitempty,omitzero"`  // Lower transition radius for notch cutout shapes.
	Cx           *int64             `json:"cx,omitempty,omitzero"`           // Center x coordinate for circle cutout shapes.
	Cy           *int64             `json:"cy,omitempty,omitzero"`           // Center y coordinate for circle cutout shapes.
	Radius       int64              `json:"radius,omitempty,omitzero"`       // Radius for circle cutout shapes.
	ContentColor *cdp.RGBA          `json:"contentColor,omitempty,omitzero"` // The cutout fill color (default: black).
}

type DisplayCutoutShape string

type EventInspectModeCanceled struct{}

type EventInspectNodeRequested struct {
	BackendNodeID cdp.BackendNodeID `json:"backendNodeId"` // Id of the node to inspect.
}

type EventInspectPanelShowRequested struct {
	BackendNodeID cdp.BackendNodeID `json:"backendNodeId"` // Id of the node to show in the panel.
}

type EventInspectedElementWindowRestored struct {
	BackendNodeID cdp.BackendNodeID `json:"backendNodeId"` // Id of the node to restore the floating window for.
}

type EventNodeHighlightRequested struct {
	NodeID cdp.NodeID `json:"nodeId"`
}

type EventScreenshotRequested struct {
	Viewport *page.Viewport `json:"viewport"` // Viewport to capture, in device independent pixels (dip).
}

type FlexContainerHighlightConfig struct {
	ContainerBorder       *LineStyle `json:"containerBorder,omitempty,omitzero"`       // The style of the container border
	LineSeparator         *LineStyle `json:"lineSeparator,omitempty,omitzero"`         // The style of the separator between lines
	ItemSeparator         *LineStyle `json:"itemSeparator,omitempty,omitzero"`         // The style of the separator between items
	MainDistributedSpace  *BoxStyle  `json:"mainDistributedSpace,omitempty,omitzero"`  // Style of content-distribution space on the main axis (justify-content).
	CrossDistributedSpace *BoxStyle  `json:"crossDistributedSpace,omitempty,omitzero"` // Style of content-distribution space on the cross axis (align-content).
	RowGapSpace           *BoxStyle  `json:"rowGapSpace,omitempty,omitzero"`           // Style of empty space caused by row gaps (gap/row-gap).
	ColumnGapSpace        *BoxStyle  `json:"columnGapSpace,omitempty,omitzero"`        // Style of empty space caused by columns gaps (gap/column-gap).
	CrossAlignment        *LineStyle `json:"crossAlignment,omitempty,omitzero"`        // Style of the self-alignment line (align-items).
}

type FlexItemHighlightConfig struct {
	BaseSizeBox      *BoxStyle  `json:"baseSizeBox,omitempty,omitzero"`      // Style of the box representing the item's base size
	BaseSizeBorder   *LineStyle `json:"baseSizeBorder,omitempty,omitzero"`   // Style of the border around the box representing the item's base size
	FlexibilityArrow *LineStyle `json:"flexibilityArrow,omitempty,omitzero"` // Style of the arrow representing if the item grew or shrank
}

type FlexNodeHighlightConfig struct {
	FlexContainerHighlightConfig *FlexContainerHighlightConfig `json:"flexContainerHighlightConfig"` // A descriptor for the highlight appearance of flex containers.
	NodeID                       cdp.NodeID                    `json:"nodeId"`                       // Identifier of the node to highlight.
}

type GetGridHighlightObjectsForTestParams struct {
	NodeIDs []cdp.NodeID `json:"nodeIds"` // Ids of the node to get highlight object for.
}

type GetGridHighlightObjectsForTestResult struct {
	Highlights jsonv2.Value `json:"highlights,omitempty,omitzero"`
}

type GetHighlightObjectForTestParams struct {
	NodeID                cdp.NodeID  `json:"nodeId"`                                   // Id of the node to get highlight object for.
	IncludeDistance       *bool       `json:"includeDistance,omitempty,omitzero"`       // Whether to include distance info.
	IncludeStyle          *bool       `json:"includeStyle,omitempty,omitzero"`          // Whether to include style info.
	ColorFormat           ColorFormat `json:"colorFormat,omitempty,omitzero"`           // The color format to get config with (default: hex).
	ShowAccessibilityInfo *bool       `json:"showAccessibilityInfo,omitempty,omitzero"` // Whether to show accessibility info (default: true).
}

type GetHighlightObjectForTestResult struct {
	Highlight jsonv2.Value `json:"highlight,omitempty,omitzero"`
}

type GetSourceOrderHighlightObjectForTestParams struct {
	NodeID cdp.NodeID `json:"nodeId"` // Id of the node to highlight.
}

type GetSourceOrderHighlightObjectForTestResult struct {
	Highlight jsonv2.Value `json:"highlight,omitempty,omitzero"`
}

type GridHighlightConfig struct {
	ShowGridExtensionLines  bool      `json:"showGridExtensionLines"`                 // Whether the extension lines from grid cells to the rulers should be shown (default: false).
	ShowPositiveLineNumbers bool      `json:"showPositiveLineNumbers"`                // Show Positive line number labels (default: false).
	ShowNegativeLineNumbers bool      `json:"showNegativeLineNumbers"`                // Show Negative line number labels (default: false).
	ShowAreaNames           bool      `json:"showAreaNames"`                          // Show area name labels (default: false).
	ShowLineNames           bool      `json:"showLineNames"`                          // Show line name labels (default: false).
	ShowTrackSizes          bool      `json:"showTrackSizes"`                         // Show track size labels (default: false).
	GridBorderColor         *cdp.RGBA `json:"gridBorderColor,omitempty,omitzero"`     // The grid container border highlight color (default: transparent).
	RowLineColor            *cdp.RGBA `json:"rowLineColor,omitempty,omitzero"`        // The row line color (default: transparent).
	ColumnLineColor         *cdp.RGBA `json:"columnLineColor,omitempty,omitzero"`     // The column line color (default: transparent).
	GridBorderDash          bool      `json:"gridBorderDash"`                         // Whether the grid border is dashed (default: false).
	RowLineDash             bool      `json:"rowLineDash"`                            // Whether row lines are dashed (default: false).
	ColumnLineDash          bool      `json:"columnLineDash"`                         // Whether column lines are dashed (default: false).
	RowGapColor             *cdp.RGBA `json:"rowGapColor,omitempty,omitzero"`         // The row gap highlight fill color (default: transparent).
	RowHatchColor           *cdp.RGBA `json:"rowHatchColor,omitempty,omitzero"`       // The row gap hatching fill color (default: transparent).
	ColumnGapColor          *cdp.RGBA `json:"columnGapColor,omitempty,omitzero"`      // The column gap highlight fill color (default: transparent).
	ColumnHatchColor        *cdp.RGBA `json:"columnHatchColor,omitempty,omitzero"`    // The column gap hatching fill color (default: transparent).
	AreaBorderColor         *cdp.RGBA `json:"areaBorderColor,omitempty,omitzero"`     // The named grid areas border color (Default: transparent).
	GridBackgroundColor     *cdp.RGBA `json:"gridBackgroundColor,omitempty,omitzero"` // The grid container background color (Default: transparent).
}

type GridNodeHighlightConfig struct {
	GridHighlightConfig *GridHighlightConfig `json:"gridHighlightConfig"` // A descriptor for the highlight appearance.
	NodeID              cdp.NodeID           `json:"nodeId"`              // Identifier of the node to highlight.
}

type HighlightConfig struct {
	ShowInfo                               bool                                    `json:"showInfo"`                                                  // Whether the node info tooltip should be shown (default: false).
	ShowStyles                             bool                                    `json:"showStyles"`                                                // Whether the node styles in the tooltip (default: false).
	ShowRulers                             bool                                    `json:"showRulers"`                                                // Whether the rulers should be shown (default: false).
	ShowAccessibilityInfo                  bool                                    `json:"showAccessibilityInfo"`                                     // Whether the a11y info should be shown (default: true).
	ShowExtensionLines                     bool                                    `json:"showExtensionLines"`                                        // Whether the extension lines from node to the rulers should be shown (default: false).
	ContentColor                           *cdp.RGBA                               `json:"contentColor,omitempty,omitzero"`                           // The content box highlight fill color (default: transparent).
	PaddingColor                           *cdp.RGBA                               `json:"paddingColor,omitempty,omitzero"`                           // The padding highlight fill color (default: transparent).
	BorderColor                            *cdp.RGBA                               `json:"borderColor,omitempty,omitzero"`                            // The border highlight fill color (default: transparent).
	MarginColor                            *cdp.RGBA                               `json:"marginColor,omitempty,omitzero"`                            // The margin highlight fill color (default: transparent).
	EventTargetColor                       *cdp.RGBA                               `json:"eventTargetColor,omitempty,omitzero"`                       // The event target element highlight fill color (default: transparent).
	ShapeColor                             *cdp.RGBA                               `json:"shapeColor,omitempty,omitzero"`                             // The shape outside fill color (default: transparent).
	ShapeMarginColor                       *cdp.RGBA                               `json:"shapeMarginColor,omitempty,omitzero"`                       // The shape margin fill color (default: transparent).
	CSSGridColor                           *cdp.RGBA                               `json:"cssGridColor,omitempty,omitzero"`                           // The grid layout color (default: transparent).
	ColorFormat                            ColorFormat                             `json:"colorFormat,omitempty,omitzero"`                            // The color format used to format color styles (default: hex).
	GridHighlightConfig                    *GridHighlightConfig                    `json:"gridHighlightConfig,omitempty,omitzero"`                    // The grid layout highlight configuration (default: all transparent).
	FlexContainerHighlightConfig           *FlexContainerHighlightConfig           `json:"flexContainerHighlightConfig,omitempty,omitzero"`           // The flex container highlight configuration (default: all transparent).
	FlexItemHighlightConfig                *FlexItemHighlightConfig                `json:"flexItemHighlightConfig,omitempty,omitzero"`                // The flex item highlight configuration (default: all transparent).
	ContrastAlgorithm                      ContrastAlgorithm                       `json:"contrastAlgorithm,omitempty,omitzero"`                      // The contrast algorithm to use for the contrast ratio (default: aa).
	ContainerQueryContainerHighlightConfig *ContainerQueryContainerHighlightConfig `json:"containerQueryContainerHighlightConfig,omitempty,omitzero"` // The container query container highlight configuration (default: all transparent).
	ImcbHighlightConfig                    *ImcbHighlightConfig                    `json:"imcbHighlightConfig,omitempty,omitzero"`                    // The IMCB highlight configuration (default: all transparent).
}

type HighlightNodeParams struct {
	HighlightConfig *HighlightConfig       `json:"highlightConfig"`                  // A descriptor for the highlight appearance.
	NodeID          cdp.NodeID             `json:"nodeId,omitempty,omitzero"`        // Identifier of the node to highlight.
	BackendNodeID   cdp.BackendNodeID      `json:"backendNodeId,omitempty,omitzero"` // Identifier of the backend node to highlight.
	ObjectID        runtime.RemoteObjectID `json:"objectId,omitempty,omitzero"`      // JavaScript object id of the node to be highlighted.
	Selector        string                 `json:"selector,omitempty,omitzero"`      // Selectors to highlight relevant nodes.
}

type HighlightQuadParams struct {
	Quad         dom.Quad  `json:"quad"`                            // Quad to highlight
	Color        *cdp.RGBA `json:"color,omitempty,omitzero"`        // The highlight fill color (default: transparent).
	OutlineColor *cdp.RGBA `json:"outlineColor,omitempty,omitzero"` // The highlight outline color (default: transparent).
}

type HighlightRectParams struct {
	X            int64     `json:"x"`                               // X coordinate
	Y            int64     `json:"y"`                               // Y coordinate
	Width        int64     `json:"width"`                           // Rectangle width
	Height       int64     `json:"height"`                          // Rectangle height
	Color        *cdp.RGBA `json:"color,omitempty,omitzero"`        // The highlight fill color (default: transparent).
	OutlineColor *cdp.RGBA `json:"outlineColor,omitempty,omitzero"` // The highlight outline color (default: transparent).
}

type HighlightSourceOrderParams struct {
	SourceOrderConfig *SourceOrderConfig     `json:"sourceOrderConfig"`                // A descriptor for the appearance of the overlay drawing.
	NodeID            cdp.NodeID             `json:"nodeId,omitempty,omitzero"`        // Identifier of the node to highlight.
	BackendNodeID     cdp.BackendNodeID      `json:"backendNodeId,omitempty,omitzero"` // Identifier of the backend node to highlight.
	ObjectID          runtime.RemoteObjectID `json:"objectId,omitempty,omitzero"`      // JavaScript object id of the node to be highlighted.
}

type HingeConfig struct {
	Rect         *dom.Rect `json:"rect"`                            // A rectangle represent hinge
	ContentColor *cdp.RGBA `json:"contentColor,omitempty,omitzero"` // The content box highlight fill color (default: a dark color).
	OutlineColor *cdp.RGBA `json:"outlineColor,omitempty,omitzero"` // The content box highlight outline color (default: transparent).
}

type ImcbHighlightConfig struct {
	ImcbBorderColor               *cdp.RGBA `json:"imcbBorderColor,omitempty,omitzero"`               // Border color for the Inset-Modified Containing Block (default: transparent).
	ImcbBackgroundColor           *cdp.RGBA `json:"imcbBackgroundColor,omitempty,omitzero"`           // Background fill color for the Inset-Modified Containing Block (default: transparent).
	InsetsBackgroundColor         *cdp.RGBA `json:"insetsBackgroundColor,omitempty,omitzero"`         // Fill color for the inset modifiers area (difference between CB and IMCB).
	InsetsHatchColor              *cdp.RGBA `json:"insetsHatchColor,omitempty,omitzero"`              // Hatch color for the inset modifiers area.
	AnchorBorderColor             *cdp.RGBA `json:"anchorBorderColor,omitempty,omitzero"`             // Border color for the referenced target anchor element(s) (when element is anchor-positioned).
	AnchorBackgroundColor         *cdp.RGBA `json:"anchorBackgroundColor,omitempty,omitzero"`         // Background fill color for the referenced target anchor element(s) (when element is anchor-positioned).
	ShowPositionAreaGrid          bool      `json:"showPositionAreaGrid"`                             // Whether to render the 3x3 position-area grid lines when position-area is used.
	PositionAreaGridLineColor     *cdp.RGBA `json:"positionAreaGridLineColor,omitempty,omitzero"`     // Line color for the 3x3 position-area grid lines.
	PositionAreaActiveRegionColor *cdp.RGBA `json:"positionAreaActiveRegionColor,omitempty,omitzero"` // Fill color for the active region within the position-area grid.
}

type InspectMode string

type InspectedElementAnchorConfig struct {
	NodeID        cdp.NodeID        `json:"nodeId,omitempty,omitzero"`        // Identifier of the node to highlight.
	BackendNodeID cdp.BackendNodeID `json:"backendNodeId,omitempty,omitzero"` // Identifier of the backend node to highlight.
}

type IsolatedElementHighlightConfig struct {
	IsolationModeHighlightConfig *IsolationModeHighlightConfig `json:"isolationModeHighlightConfig"` // A descriptor for the highlight appearance of an element in isolation mode.
	NodeID                       cdp.NodeID                    `json:"nodeId"`                       // Identifier of the isolated element to highlight.
}

type IsolationModeHighlightConfig struct {
	ResizerColor       *cdp.RGBA `json:"resizerColor,omitempty,omitzero"`       // The fill color of the resizers (default: transparent).
	ResizerHandleColor *cdp.RGBA `json:"resizerHandleColor,omitempty,omitzero"` // The fill color for resizer handles (default: transparent).
	MaskColor          *cdp.RGBA `json:"maskColor,omitempty,omitzero"`          // The fill color for the mask covering non-isolated elements (default: transparent).
}

type LineStyle struct {
	Color   *cdp.RGBA        `json:"color,omitempty,omitzero"`   // The color of the line (default: transparent)
	Pattern LineStylePattern `json:"pattern,omitempty,omitzero"` // The line pattern (default: solid)
}

type LineStylePattern string

type ScrollSnapContainerHighlightConfig struct {
	SnapportBorder     *LineStyle `json:"snapportBorder,omitempty,omitzero"`     // The style of the snapport border (default: transparent)
	SnapAreaBorder     *LineStyle `json:"snapAreaBorder,omitempty,omitzero"`     // The style of the snap area border (default: transparent)
	ScrollMarginColor  *cdp.RGBA  `json:"scrollMarginColor,omitempty,omitzero"`  // The margin highlight fill color (default: transparent).
	ScrollPaddingColor *cdp.RGBA  `json:"scrollPaddingColor,omitempty,omitzero"` // The padding highlight fill color (default: transparent).
}

type ScrollSnapHighlightConfig struct {
	ScrollSnapContainerHighlightConfig *ScrollSnapContainerHighlightConfig `json:"scrollSnapContainerHighlightConfig"` // A descriptor for the highlight appearance of scroll snap containers.
	NodeID                             cdp.NodeID                          `json:"nodeId"`                             // Identifier of the node to highlight.
}

type SetInspectModeParams struct {
	Mode            InspectMode      `json:"mode"`                               // Set an inspection mode.
	HighlightConfig *HighlightConfig `json:"highlightConfig,omitempty,omitzero"` // A descriptor for the highlight appearance of hovered-over nodes. May be omitted if enabled == false.
}

type SetPausedInDebuggerMessageParams struct {
	Message string `json:"message,omitempty,omitzero"` // The message to display, also triggers resume and step over controls.
}

type SetShowAdHighlightsParams struct {
	Show bool `json:"show"` // True for showing ad highlights
}

type SetShowContainerQueryOverlaysParams struct {
	ContainerQueryHighlightConfigs []*ContainerQueryHighlightConfig `json:"containerQueryHighlightConfigs"` // An array of node identifiers and descriptors for the highlight appearance.
}

type SetShowDebugBordersParams struct {
	Show bool `json:"show"` // True for showing debug borders
}

type SetShowDisplayCutoutParams struct {
	DisplayCutoutConfig *DisplayCutoutConfig `json:"displayCutoutConfig,omitempty,omitzero"` // display cutout data, null means hide display cutout
}

type SetShowFPSCounterParams struct {
	Show bool `json:"show"` // True for showing the FPS counter
}

type SetShowFlexOverlaysParams struct {
	FlexNodeHighlightConfigs []*FlexNodeHighlightConfig `json:"flexNodeHighlightConfigs"` // An array of node identifiers and descriptors for the highlight appearance.
}

type SetShowGridOverlaysParams struct {
	GridNodeHighlightConfigs []*GridNodeHighlightConfig `json:"gridNodeHighlightConfigs"` // An array of node identifiers and descriptors for the highlight appearance.
}

type SetShowHingeParams struct {
	HingeConfig *HingeConfig `json:"hingeConfig,omitempty,omitzero"` // hinge data, null means hideHinge
}

type SetShowInspectedElementAnchorParams struct {
	InspectedElementAnchorConfig *InspectedElementAnchorConfig `json:"inspectedElementAnchorConfig"` // Node identifier for which to show an anchor for.
}

type SetShowIsolatedElementsParams struct {
	IsolatedElementHighlightConfigs []*IsolatedElementHighlightConfig `json:"isolatedElementHighlightConfigs"` // An array of node identifiers and descriptors for the highlight appearance.
}

type SetShowLayoutShiftRegionsParams struct {
	Result bool `json:"result"` // True for showing layout shift regions
}

type SetShowPaintRectsParams struct {
	Result bool `json:"result"` // True for showing paint rectangles
}

type SetShowScrollBottleneckRectsParams struct {
	Show bool `json:"show"` // True for showing scroll bottleneck rects
}

type SetShowScrollSnapOverlaysParams struct {
	ScrollSnapHighlightConfigs []*ScrollSnapHighlightConfig `json:"scrollSnapHighlightConfigs"` // An array of node identifiers and descriptors for the highlight appearance.
}

type SetShowViewportSizeOnResizeParams struct {
	Show bool `json:"show"` // Whether to paint size or not.
}

type SetShowWindowControlsOverlayParams struct {
	WindowControlsOverlayConfig *WindowControlsOverlayConfig `json:"windowControlsOverlayConfig,omitempty,omitzero"` // Window Controls Overlay data, null means hide Window Controls Overlay
}

type SourceOrderConfig struct {
	ParentOutlineColor *cdp.RGBA `json:"parentOutlineColor"` // the color to outline the given element in.
	ChildOutlineColor  *cdp.RGBA `json:"childOutlineColor"`  // the color to outline the child elements in.
}

type WindowControlsOverlayConfig struct {
	ShowCSS          bool   `json:"showCSS"`          // Whether the title bar CSS should be shown when emulating the Window Controls Overlay.
	SelectedPlatform string `json:"selectedPlatform"` // Selected platforms to show the overlay.
	ThemeColor       string `json:"themeColor"`       // The theme color defined in app manifest.
}