overlay

package
v0.33.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 4, 2022 License: MIT Imports: 7 Imported by: 6

Documentation

Overview

Package overlay implements the Overlay domain. This domain provides various functionality related to drawing atop the inspected page.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewClient 

func NewClient(conn *rpcc.Conn) *domainClient

NewClient returns a client for the Overlay domain with the connection set to conn.

Types

type BoxStyle added in v0.31.0 

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

BoxStyle Style information for drawing a box.

type ColorFormat added in v0.29.0 

type ColorFormat string

ColorFormat 

const (
	ColorFormatNotSet ColorFormat = ""
	ColorFormatRGB    ColorFormat = "rgb"
	ColorFormatHSL    ColorFormat = "hsl"
	ColorFormatHWB    ColorFormat = "hwb"
	ColorFormatHex    ColorFormat = "hex"
)

ColorFormat as enums.

func (ColorFormat) String added in v0.29.0 

func (e ColorFormat) String() string

func (ColorFormat) Valid added in v0.29.0 

func (e ColorFormat) Valid() bool

type ContainerQueryContainerHighlightConfig added in v0.32.0 

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

ContainerQueryContainerHighlightConfig

type ContainerQueryHighlightConfig added in v0.32.0 

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

ContainerQueryHighlightConfig

type ContrastAlgorithm added in v0.31.0 

type ContrastAlgorithm string

ContrastAlgorithm 

const (
	ContrastAlgorithmNotSet ContrastAlgorithm = ""
	ContrastAlgorithmAa     ContrastAlgorithm = "aa"
	ContrastAlgorithmAaa    ContrastAlgorithm = "aaa"
	ContrastAlgorithmApca   ContrastAlgorithm = "apca"
)

ContrastAlgorithm as enums.

func (ContrastAlgorithm) String added in v0.31.0 

func (e ContrastAlgorithm) String() string

func (ContrastAlgorithm) Valid added in v0.31.0 

func (e ContrastAlgorithm) Valid() bool

type FlexContainerHighlightConfig added in v0.31.0 

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

FlexContainerHighlightConfig Configuration data for the highlighting of Flex container elements.

type FlexItemHighlightConfig added in v0.31.0 

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

FlexItemHighlightConfig Configuration data for the highlighting of Flex item elements.

type FlexNodeHighlightConfig added in v0.31.0 

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

FlexNodeHighlightConfig

type GetGridHighlightObjectsForTestArgs added in v0.31.0 

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

GetGridHighlightObjectsForTestArgs represents the arguments for GetGridHighlightObjectsForTest in the Overlay domain.

func NewGetGridHighlightObjectsForTestArgs added in v0.31.0 

func NewGetGridHighlightObjectsForTestArgs(nodeIDs []dom.NodeID) *GetGridHighlightObjectsForTestArgs

NewGetGridHighlightObjectsForTestArgs initializes GetGridHighlightObjectsForTestArgs with the required arguments.

type GetGridHighlightObjectsForTestReply added in v0.31.0 

type GetGridHighlightObjectsForTestReply struct {
	Highlights json.RawMessage `json:"highlights"` // Grid Highlight data for the node ids provided.
}

GetGridHighlightObjectsForTestReply represents the return values for GetGridHighlightObjectsForTest in the Overlay domain.

type GetHighlightObjectForTestArgs 

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

GetHighlightObjectForTestArgs represents the arguments for GetHighlightObjectForTest in the Overlay domain.

func NewGetHighlightObjectForTestArgs 

func NewGetHighlightObjectForTestArgs(nodeID dom.NodeID) *GetHighlightObjectForTestArgs

NewGetHighlightObjectForTestArgs initializes GetHighlightObjectForTestArgs with the required arguments.

func (*GetHighlightObjectForTestArgs) SetColorFormat added in v0.29.0 

func (a *GetHighlightObjectForTestArgs) SetColorFormat(colorFormat ColorFormat) *GetHighlightObjectForTestArgs

SetColorFormat sets the ColorFormat optional argument. The color format to get config with (default: hex).

func (*GetHighlightObjectForTestArgs) SetIncludeDistance added in v0.23.2 

func (a *GetHighlightObjectForTestArgs) SetIncludeDistance(includeDistance bool) *GetHighlightObjectForTestArgs

SetIncludeDistance sets the IncludeDistance optional argument. Whether to include distance info.

func (*GetHighlightObjectForTestArgs) SetIncludeStyle added in v0.25.0 

func (a *GetHighlightObjectForTestArgs) SetIncludeStyle(includeStyle bool) *GetHighlightObjectForTestArgs

SetIncludeStyle sets the IncludeStyle optional argument. Whether to include style info.

func (*GetHighlightObjectForTestArgs) SetShowAccessibilityInfo added in v0.31.0 

func (a *GetHighlightObjectForTestArgs) SetShowAccessibilityInfo(showAccessibilityInfo bool) *GetHighlightObjectForTestArgs

SetShowAccessibilityInfo sets the ShowAccessibilityInfo optional argument. Whether to show accessibility info (default: true).

type GetHighlightObjectForTestReply 

type GetHighlightObjectForTestReply struct {
	Highlight json.RawMessage `json:"highlight"` // Highlight data for the node.
}

GetHighlightObjectForTestReply represents the return values for GetHighlightObjectForTest in the Overlay domain.

type GetSourceOrderHighlightObjectForTestArgs added in v0.31.0 

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

GetSourceOrderHighlightObjectForTestArgs represents the arguments for GetSourceOrderHighlightObjectForTest in the Overlay domain.

func NewGetSourceOrderHighlightObjectForTestArgs added in v0.31.0 

func NewGetSourceOrderHighlightObjectForTestArgs(nodeID dom.NodeID) *GetSourceOrderHighlightObjectForTestArgs

NewGetSourceOrderHighlightObjectForTestArgs initializes GetSourceOrderHighlightObjectForTestArgs with the required arguments.

type GetSourceOrderHighlightObjectForTestReply added in v0.31.0 

type GetSourceOrderHighlightObjectForTestReply struct {
	Highlight json.RawMessage `json:"highlight"` // Source order highlight data for the node id provided.
}

GetSourceOrderHighlightObjectForTestReply represents the return values for GetSourceOrderHighlightObjectForTest in the Overlay domain.

type GridHighlightConfig added in v0.29.0 

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

GridHighlightConfig Configuration data for the highlighting of Grid elements.

type GridNodeHighlightConfig added in v0.31.0 

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

GridNodeHighlightConfig Configurations for Persistent Grid Highlight

type HighlightConfig 

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

HighlightConfig Configuration data for the highlighting of page elements.

type HighlightFrameArgs 

type HighlightFrameArgs struct {
	FrameID             page.FrameID `json:"frameId"`                       // Identifier of the frame to highlight.
	ContentColor        *dom.RGBA    `json:"contentColor,omitempty"`        // The content box highlight fill color (default: transparent).
	ContentOutlineColor *dom.RGBA    `json:"contentOutlineColor,omitempty"` // The content box highlight outline color (default: transparent).
}

HighlightFrameArgs represents the arguments for HighlightFrame in the Overlay domain.

func NewHighlightFrameArgs 

func NewHighlightFrameArgs(frameID page.FrameID) *HighlightFrameArgs

NewHighlightFrameArgs initializes HighlightFrameArgs with the required arguments.

func (*HighlightFrameArgs) SetContentColor 

func (a *HighlightFrameArgs) SetContentColor(contentColor dom.RGBA) *HighlightFrameArgs

SetContentColor sets the ContentColor optional argument. The content box highlight fill color (default: transparent).

func (*HighlightFrameArgs) SetContentOutlineColor 

func (a *HighlightFrameArgs) SetContentOutlineColor(contentOutlineColor dom.RGBA) *HighlightFrameArgs

SetContentOutlineColor sets the ContentOutlineColor optional argument. The content box highlight outline color (default: transparent).

type HighlightNodeArgs 

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

HighlightNodeArgs represents the arguments for HighlightNode in the Overlay domain.

func NewHighlightNodeArgs 

func NewHighlightNodeArgs(highlightConfig HighlightConfig) *HighlightNodeArgs

NewHighlightNodeArgs initializes HighlightNodeArgs with the required arguments.

func (*HighlightNodeArgs) SetBackendNodeID 

func (a *HighlightNodeArgs) SetBackendNodeID(backendNodeID dom.BackendNodeID) *HighlightNodeArgs

SetBackendNodeID sets the BackendNodeID optional argument. Identifier of the backend node to highlight.

func (*HighlightNodeArgs) SetNodeID 

func (a *HighlightNodeArgs) SetNodeID(nodeID dom.NodeID) *HighlightNodeArgs

SetNodeID sets the NodeID optional argument. Identifier of the node to highlight.

func (*HighlightNodeArgs) SetObjectID 

func (a *HighlightNodeArgs) SetObjectID(objectID runtime.RemoteObjectID) *HighlightNodeArgs

SetObjectID sets the ObjectID optional argument. JavaScript object id of the node to be highlighted.

func (*HighlightNodeArgs) SetSelector added in v0.22.0 

func (a *HighlightNodeArgs) SetSelector(selector string) *HighlightNodeArgs

SetSelector sets the Selector optional argument. Selectors to highlight relevant nodes.

type HighlightQuadArgs 

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

HighlightQuadArgs represents the arguments for HighlightQuad in the Overlay domain.

func NewHighlightQuadArgs 

func NewHighlightQuadArgs(quad dom.Quad) *HighlightQuadArgs

NewHighlightQuadArgs initializes HighlightQuadArgs with the required arguments.

func (*HighlightQuadArgs) SetColor 

func (a *HighlightQuadArgs) SetColor(color dom.RGBA) *HighlightQuadArgs

SetColor sets the Color optional argument. The highlight fill color (default: transparent).

func (*HighlightQuadArgs) SetOutlineColor 

func (a *HighlightQuadArgs) SetOutlineColor(outlineColor dom.RGBA) *HighlightQuadArgs

SetOutlineColor sets the OutlineColor optional argument. The highlight outline color (default: transparent).

type HighlightRectArgs 

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

HighlightRectArgs represents the arguments for HighlightRect in the Overlay domain.

func NewHighlightRectArgs 

func NewHighlightRectArgs(x int, y int, width int, height int) *HighlightRectArgs

NewHighlightRectArgs initializes HighlightRectArgs with the required arguments.

func (*HighlightRectArgs) SetColor 

func (a *HighlightRectArgs) SetColor(color dom.RGBA) *HighlightRectArgs

SetColor sets the Color optional argument. The highlight fill color (default: transparent).

func (*HighlightRectArgs) SetOutlineColor 

func (a *HighlightRectArgs) SetOutlineColor(outlineColor dom.RGBA) *HighlightRectArgs

SetOutlineColor sets the OutlineColor optional argument. The highlight outline color (default: transparent).

type HighlightSourceOrderArgs added in v0.31.0 

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

HighlightSourceOrderArgs represents the arguments for HighlightSourceOrder in the Overlay domain.

func NewHighlightSourceOrderArgs added in v0.31.0 

func NewHighlightSourceOrderArgs(sourceOrderConfig SourceOrderConfig) *HighlightSourceOrderArgs

NewHighlightSourceOrderArgs initializes HighlightSourceOrderArgs with the required arguments.

func (*HighlightSourceOrderArgs) SetBackendNodeID added in v0.31.0 

func (a *HighlightSourceOrderArgs) SetBackendNodeID(backendNodeID dom.BackendNodeID) *HighlightSourceOrderArgs

SetBackendNodeID sets the BackendNodeID optional argument. Identifier of the backend node to highlight.

func (*HighlightSourceOrderArgs) SetNodeID added in v0.31.0 

func (a *HighlightSourceOrderArgs) SetNodeID(nodeID dom.NodeID) *HighlightSourceOrderArgs

SetNodeID sets the NodeID optional argument. Identifier of the node to highlight.

func (*HighlightSourceOrderArgs) SetObjectID added in v0.31.0 

func (a *HighlightSourceOrderArgs) SetObjectID(objectID runtime.RemoteObjectID) *HighlightSourceOrderArgs

SetObjectID sets the ObjectID optional argument. JavaScript object id of the node to be highlighted.

type HingeConfig added in v0.29.0 

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

HingeConfig Configuration for dual screen hinge

type InspectMode 

type InspectMode string

InspectMode 

const (
	InspectModeNotSet                InspectMode = ""
	InspectModeSearchForNode         InspectMode = "searchForNode"
	InspectModeSearchForUAShadowDOM  InspectMode = "searchForUAShadowDOM"
	InspectModeCaptureAreaScreenshot InspectMode = "captureAreaScreenshot"
	InspectModeShowDistances         InspectMode = "showDistances"
	InspectModeNone                  InspectMode = "none"
)

InspectMode as enums.

func (InspectMode) String 

func (e InspectMode) String() string

func (InspectMode) Valid 

func (e InspectMode) Valid() bool

type InspectModeCanceledClient added in v0.22.0 

type InspectModeCanceledClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*InspectModeCanceledReply, error)
	rpcc.Stream
}

InspectModeCanceledClient is a client for InspectModeCanceled events. Fired when user cancels the inspect mode.

type InspectModeCanceledReply added in v0.22.0 

type InspectModeCanceledReply struct {
}

InspectModeCanceledReply is the reply for InspectModeCanceled events.

type InspectNodeRequestedClient 

type InspectNodeRequestedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*InspectNodeRequestedReply, error)
	rpcc.Stream
}

InspectNodeRequestedClient is a client for InspectNodeRequested events. Fired when the node should be inspected. This happens after call to `setInspectMode` or when user manually inspects an element.

type InspectNodeRequestedReply 

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

InspectNodeRequestedReply is the reply for InspectNodeRequested events.

type IsolatedElementHighlightConfig added in v0.33.0 

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

IsolatedElementHighlightConfig

type IsolationModeHighlightConfig added in v0.33.0 

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

IsolationModeHighlightConfig

type LineStyle added in v0.31.0 

type LineStyle struct {
	Color *dom.RGBA `json:"color,omitempty"` // The color of the line (default: transparent)
	// Pattern The line pattern (default: solid)
	//
	// Values: "dashed", "dotted".
	Pattern *string `json:"pattern,omitempty"`
}

LineStyle Style information for drawing a line.

type NodeHighlightRequestedClient 

type NodeHighlightRequestedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*NodeHighlightRequestedReply, error)
	rpcc.Stream
}

NodeHighlightRequestedClient is a client for NodeHighlightRequested events. Fired when the node should be highlighted. This happens after call to `setInspectMode`.

type NodeHighlightRequestedReply 

type NodeHighlightRequestedReply struct {
	NodeID dom.NodeID `json:"nodeId"` // No description.
}

NodeHighlightRequestedReply is the reply for NodeHighlightRequested events.

type ScreenshotRequestedClient added in v0.9.1 

type ScreenshotRequestedClient interface {
	// Recv calls RecvMsg on rpcc.Stream, blocks until the event is
	// triggered, context canceled or connection closed.
	Recv() (*ScreenshotRequestedReply, error)
	rpcc.Stream
}

ScreenshotRequestedClient is a client for ScreenshotRequested events. Fired when user asks to capture screenshot of some area on the page.

type ScreenshotRequestedReply added in v0.9.1 

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

ScreenshotRequestedReply is the reply for ScreenshotRequested events.

type ScrollSnapContainerHighlightConfig added in v0.32.0 

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

ScrollSnapContainerHighlightConfig

type ScrollSnapHighlightConfig added in v0.32.0 

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

ScrollSnapHighlightConfig

type SetInspectModeArgs 

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

SetInspectModeArgs represents the arguments for SetInspectMode in the Overlay domain.

func NewSetInspectModeArgs 

func NewSetInspectModeArgs(mode InspectMode) *SetInspectModeArgs

NewSetInspectModeArgs initializes SetInspectModeArgs with the required arguments.

func (*SetInspectModeArgs) SetHighlightConfig 

func (a *SetInspectModeArgs) SetHighlightConfig(highlightConfig HighlightConfig) *SetInspectModeArgs

SetHighlightConfig sets the HighlightConfig optional argument. A descriptor for the highlight appearance of hovered-over nodes. May be omitted if `enabled == false`.

type SetPausedInDebuggerMessageArgs 

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

SetPausedInDebuggerMessageArgs represents the arguments for SetPausedInDebuggerMessage in the Overlay domain.

func NewSetPausedInDebuggerMessageArgs 

func NewSetPausedInDebuggerMessageArgs() *SetPausedInDebuggerMessageArgs

NewSetPausedInDebuggerMessageArgs initializes SetPausedInDebuggerMessageArgs with the required arguments.

func (*SetPausedInDebuggerMessageArgs) SetMessage 

func (a *SetPausedInDebuggerMessageArgs) SetMessage(message string) *SetPausedInDebuggerMessageArgs

SetMessage sets the Message optional argument. The message to display, also triggers resume and step over controls.

type SetShowAdHighlightsArgs added in v0.22.0 

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

SetShowAdHighlightsArgs represents the arguments for SetShowAdHighlights in the Overlay domain.

func NewSetShowAdHighlightsArgs added in v0.22.0 

func NewSetShowAdHighlightsArgs(show bool) *SetShowAdHighlightsArgs

NewSetShowAdHighlightsArgs initializes SetShowAdHighlightsArgs with the required arguments.

type SetShowContainerQueryOverlaysArgs added in v0.32.0 

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

SetShowContainerQueryOverlaysArgs represents the arguments for SetShowContainerQueryOverlays in the Overlay domain.

func NewSetShowContainerQueryOverlaysArgs added in v0.32.0 

func NewSetShowContainerQueryOverlaysArgs(containerQueryHighlightConfigs []ContainerQueryHighlightConfig) *SetShowContainerQueryOverlaysArgs

NewSetShowContainerQueryOverlaysArgs initializes SetShowContainerQueryOverlaysArgs with the required arguments.

type SetShowDebugBordersArgs 

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

SetShowDebugBordersArgs represents the arguments for SetShowDebugBorders in the Overlay domain.

func NewSetShowDebugBordersArgs 

func NewSetShowDebugBordersArgs(show bool) *SetShowDebugBordersArgs

NewSetShowDebugBordersArgs initializes SetShowDebugBordersArgs with the required arguments.

type SetShowFPSCounterArgs 

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

SetShowFPSCounterArgs represents the arguments for SetShowFPSCounter in the Overlay domain.

func NewSetShowFPSCounterArgs 

func NewSetShowFPSCounterArgs(show bool) *SetShowFPSCounterArgs

NewSetShowFPSCounterArgs initializes SetShowFPSCounterArgs with the required arguments.

type SetShowFlexOverlaysArgs added in v0.31.0 

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

SetShowFlexOverlaysArgs represents the arguments for SetShowFlexOverlays in the Overlay domain.

func NewSetShowFlexOverlaysArgs added in v0.31.0 

func NewSetShowFlexOverlaysArgs(flexNodeHighlightConfigs []FlexNodeHighlightConfig) *SetShowFlexOverlaysArgs

NewSetShowFlexOverlaysArgs initializes SetShowFlexOverlaysArgs with the required arguments.

type SetShowGridOverlaysArgs added in v0.31.0 

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

SetShowGridOverlaysArgs represents the arguments for SetShowGridOverlays in the Overlay domain.

func NewSetShowGridOverlaysArgs added in v0.31.0 

func NewSetShowGridOverlaysArgs(gridNodeHighlightConfigs []GridNodeHighlightConfig) *SetShowGridOverlaysArgs

NewSetShowGridOverlaysArgs initializes SetShowGridOverlaysArgs with the required arguments.

type SetShowHingeArgs added in v0.29.0 

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

SetShowHingeArgs represents the arguments for SetShowHinge in the Overlay domain.

func NewSetShowHingeArgs added in v0.29.0 

func NewSetShowHingeArgs() *SetShowHingeArgs

NewSetShowHingeArgs initializes SetShowHingeArgs with the required arguments.

func (*SetShowHingeArgs) SetHingeConfig added in v0.29.0 

func (a *SetShowHingeArgs) SetHingeConfig(hingeConfig HingeConfig) *SetShowHingeArgs

SetHingeConfig sets the HingeConfig optional argument. hinge data, null means hideHinge

type SetShowHitTestBordersArgs added in v0.21.0 

type SetShowHitTestBordersArgs struct {
	Show bool `json:"show"` // True for showing hit-test borders
}

SetShowHitTestBordersArgs represents the arguments for SetShowHitTestBorders in the Overlay domain.

func NewSetShowHitTestBordersArgs added in v0.21.0 

func NewSetShowHitTestBordersArgs(show bool) *SetShowHitTestBordersArgs

NewSetShowHitTestBordersArgs initializes SetShowHitTestBordersArgs with the required arguments.

type SetShowIsolatedElementsArgs added in v0.33.0 

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

SetShowIsolatedElementsArgs represents the arguments for SetShowIsolatedElements in the Overlay domain.

func NewSetShowIsolatedElementsArgs added in v0.33.0 

func NewSetShowIsolatedElementsArgs(isolatedElementHighlightConfigs []IsolatedElementHighlightConfig) *SetShowIsolatedElementsArgs

NewSetShowIsolatedElementsArgs initializes SetShowIsolatedElementsArgs with the required arguments.

type SetShowLayoutShiftRegionsArgs added in v0.23.4 

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

SetShowLayoutShiftRegionsArgs represents the arguments for SetShowLayoutShiftRegions in the Overlay domain.

func NewSetShowLayoutShiftRegionsArgs added in v0.23.4 

func NewSetShowLayoutShiftRegionsArgs(result bool) *SetShowLayoutShiftRegionsArgs

NewSetShowLayoutShiftRegionsArgs initializes SetShowLayoutShiftRegionsArgs with the required arguments.

type SetShowPaintRectsArgs 

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

SetShowPaintRectsArgs represents the arguments for SetShowPaintRects in the Overlay domain.

func NewSetShowPaintRectsArgs 

func NewSetShowPaintRectsArgs(result bool) *SetShowPaintRectsArgs

NewSetShowPaintRectsArgs initializes SetShowPaintRectsArgs with the required arguments.

type SetShowScrollBottleneckRectsArgs 

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

SetShowScrollBottleneckRectsArgs represents the arguments for SetShowScrollBottleneckRects in the Overlay domain.

func NewSetShowScrollBottleneckRectsArgs 

func NewSetShowScrollBottleneckRectsArgs(show bool) *SetShowScrollBottleneckRectsArgs

NewSetShowScrollBottleneckRectsArgs initializes SetShowScrollBottleneckRectsArgs with the required arguments.

type SetShowScrollSnapOverlaysArgs added in v0.32.0 

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

SetShowScrollSnapOverlaysArgs represents the arguments for SetShowScrollSnapOverlays in the Overlay domain.

func NewSetShowScrollSnapOverlaysArgs added in v0.32.0 

func NewSetShowScrollSnapOverlaysArgs(scrollSnapHighlightConfigs []ScrollSnapHighlightConfig) *SetShowScrollSnapOverlaysArgs

NewSetShowScrollSnapOverlaysArgs initializes SetShowScrollSnapOverlaysArgs with the required arguments.

type SetShowViewportSizeOnResizeArgs 

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

SetShowViewportSizeOnResizeArgs represents the arguments for SetShowViewportSizeOnResize in the Overlay domain.

func NewSetShowViewportSizeOnResizeArgs 

func NewSetShowViewportSizeOnResizeArgs(show bool) *SetShowViewportSizeOnResizeArgs

NewSetShowViewportSizeOnResizeArgs initializes SetShowViewportSizeOnResizeArgs with the required arguments.

type SetShowWebVitalsArgs added in v0.31.0 

type SetShowWebVitalsArgs struct {
	Show bool `json:"show"` // No description.
}

SetShowWebVitalsArgs represents the arguments for SetShowWebVitals in the Overlay domain.

func NewSetShowWebVitalsArgs added in v0.31.0 

func NewSetShowWebVitalsArgs(show bool) *SetShowWebVitalsArgs

NewSetShowWebVitalsArgs initializes SetShowWebVitalsArgs with the required arguments.

type SourceOrderConfig added in v0.31.0 

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

SourceOrderConfig Configuration data for drawing the source order of an elements children.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.