Chrome DevTools

Page Domain

Actions and events related to the inspected page belong to the page domain.

Methods

Events

Types

Methods

Chrome DevTools

Page.addScriptToEvaluateOnNewDocument #

Evaluates given script in every frame upon creation (before loading frame's scripts).

Parameters

source
string
worldName
Optional
string

If specified, creates an isolated world with the given name and evaluates given script in it. This world name will be used as the ExecutionContextDescription::name when the corresponding event is emitted.

Experimental
includeCommandLineAPI
Optional
boolean

Specifies whether command line API should be available to the script, defaults to false.

Experimental
runImmediately
Optional
boolean

If true, runs the script immediately on existing execution contexts or worlds. Default: false.

Experimental

Return object

identifier
ScriptIdentifier

Identifier of the added script.


Chrome DevTools

Page.bringToFront #

Brings page to front (activates tab).


Chrome DevTools

Page.captureScreenshot #

Capture page screenshot.

Parameters

format
Optional
string

Image compression format (defaults to png).

Allowed values: jpeg, png, webp

quality
Optional
integer

Compression quality from range [0..100] (jpeg only).

clip
Optional
Viewport

Capture the screenshot of a given region only.

fromSurface
Optional
boolean

Capture the screenshot from the surface, rather than the view. Defaults to true.

Experimental
captureBeyondViewport
Optional
boolean

Capture the screenshot beyond the viewport. Defaults to false.

Experimental
optimizeForSpeed
Optional
boolean

Optimize image encoding for speed, not for resulting size (defaults to false)

Experimental

Return object

data
string

Base64-encoded image data. (Encoded as a base64 string when passed over JSON)


Chrome DevTools

Page.close #

Tries to close page, running its beforeunload hooks, if any.


Chrome DevTools

Page.createIsolatedWorld #

Creates an isolated world for the given frame.

Parameters

frameId
FrameId

Id of the frame in which the isolated world should be created.

worldName
Optional
string

An optional name which is reported in the Execution Context.

grantUniveralAccess
Optional
boolean

Whether or not universal access should be granted to the isolated world. This is a powerful option, use with caution.

Return object

executionContextId
Runtime.ExecutionContextId

Execution context of the isolated world.


Chrome DevTools

Page.disable #

Disables page domain notifications.


Chrome DevTools

Page.enable #

Enables page domain notifications.


Chrome DevTools

Page.getAppManifest #

Gets the processed manifest for this current document. This API always waits for the manifest to be loaded. If manifestId is provided, and it does not match the manifest of the current document, this API errors out. If there is not a loaded page, this API errors out immediately.

Parameters

manifestId
Optional
string

Return object

url
string

Manifest location.

errors
data
Optional
string

Manifest content.

parsed
Optional
AppManifestParsedProperties

Parsed manifest properties. Deprecated, use manifest instead.

ExperimentalDeprecated
manifest
WebAppManifestExperimental

Chrome DevTools

Page.getFrameTree #

Returns present frame tree structure.

Return object

frameTree
FrameTree

Present frame tree structure.


Chrome DevTools

Page.getLayoutMetrics #

Returns metrics relating to the layouting of the page, such as viewport bounds/scale.

Return object

layoutViewport
LayoutViewport

Deprecated metrics relating to the layout viewport. Is in device pixels. Use cssLayoutViewport instead.

Deprecated
visualViewport
VisualViewport

Deprecated metrics relating to the visual viewport. Is in device pixels. Use cssVisualViewport instead.

Deprecated
contentSize
DOM.Rect

Deprecated size of scrollable area. Is in DP. Use cssContentSize instead.

Deprecated
cssLayoutViewport
LayoutViewport

Metrics relating to the layout viewport in CSS pixels.

cssVisualViewport
VisualViewport

Metrics relating to the visual viewport in CSS pixels.

cssContentSize
DOM.Rect

Size of scrollable area in CSS pixels.


Chrome DevTools

Page.getNavigationHistory #

Returns navigation history for the current page.

Return object

currentIndex
integer

Index of the current navigation history entry.

entries
array[ NavigationEntry ]

Array of navigation history entries.


Chrome DevTools

Page.handleJavaScriptDialog #

Accepts or dismisses a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload).

Parameters

accept
boolean

Whether to accept or dismiss the dialog.

promptText
Optional
string

The text to enter into the dialog prompt before accepting. Used only if this is a prompt dialog.


Chrome DevTools

Page.navigate #

Navigates current page to the given URL.

Parameters

url
string

URL to navigate the page to.

referrer
Optional
string

Referrer URL.

transitionType
Optional
TransitionType

Intended transition type.

frameId
Optional
FrameId

Frame id to navigate, if not specified navigates the top frame.

referrerPolicy
Optional
ReferrerPolicy

Referrer-policy used for the navigation.

Experimental

Return object

frameId
FrameId

Frame id that has navigated (or failed to navigate)

loaderId
Optional
Network.LoaderId

Loader identifier. This is omitted in case of same-document navigation, as the previously committed loaderId would not change.

errorText
Optional
string

User friendly error message, present if and only if navigation has failed.


Chrome DevTools

Page.navigateToHistoryEntry #

Navigates current page to the given history entry.

Parameters

entryId
integer

Unique id of the entry to navigate to.


Chrome DevTools

Page.printToPDF #

Print page as PDF.

Parameters

landscape
Optional
boolean

Paper orientation. Defaults to false.

displayHeaderFooter
Optional
boolean

Display header and footer. Defaults to false.

printBackground
Optional
boolean

Print background graphics. Defaults to false.

scale
Optional
number

Scale of the webpage rendering. Defaults to 1.

paperWidth
Optional
number

Paper width in inches. Defaults to 8.5 inches.

paperHeight
Optional
number

Paper height in inches. Defaults to 11 inches.

marginTop
Optional
number

Top margin in inches. Defaults to 1cm (~0.4 inches).

marginBottom
Optional
number

Bottom margin in inches. Defaults to 1cm (~0.4 inches).

marginLeft
Optional
number

Left margin in inches. Defaults to 1cm (~0.4 inches).

marginRight
Optional
number

Right margin in inches. Defaults to 1cm (~0.4 inches).

pageRanges
Optional
string

Paper ranges to print, one based, e.g., '1-5, 8, 11-13'. Pages are printed in the document order, not in the order specified, and no more than once. Defaults to empty string, which implies the entire document is printed. The page numbers are quietly capped to actual page count of the document, and ranges beyond the end of the document are ignored. If this results in no pages to print, an error is reported. It is an error to specify a range with start greater than end.

headerTemplate
Optional
string

HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them:

  • date: formatted print date
  • title: document title
  • url: document location
  • pageNumber: current page number
  • totalPages: total pages in the document

For example, <span class=title></span> would generate span containing the title.

footerTemplate
Optional
string

HTML template for the print footer. Should use the same format as the headerTemplate.

preferCSSPageSize
Optional
boolean

Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.

transferMode
Optional
string

return as stream

Allowed values: ReturnAsBase64, ReturnAsStream

Experimental
generateTaggedPDF
Optional
boolean

Whether or not to generate tagged (accessible) PDF. Defaults to embedder choice.

Experimental
generateDocumentOutline
Optional
boolean

Whether or not to embed the document outline into the PDF.

Experimental

Return object

data
string

Base64-encoded pdf data. Empty if |returnAsStream| is specified. (Encoded as a base64 string when passed over JSON)

stream
Optional
IO.StreamHandle

A handle of the stream that holds resulting PDF data.

Experimental

React NativeChrome DevTools

Page.reload #

Reloads given page optionally ignoring the cache.

It isn't clear what the ignoreCache parameter of @cdp Page.reload should mean in React Native. We parse it, but don't do anything with it yet.

TODO: Implement scriptToEvaluateOnLoad parameter of @cdp Page.reload.

Parameters

ignoreCache
Optional
boolean

If true, browser cache is ignored (as if the user pressed Shift+refresh).

scriptToEvaluateOnLoad
Optional
string

If set, the script will be injected into all frames of the inspected page after reload. Argument will be ignored if reloading dataURL origin.

loaderId
Optional
Network.LoaderId

If set, an error will be thrown if the target page's main frame's loader id does not match the provided id. This prevents accidentally reloading an unintended target in case there's a racing navigation.

Experimental

Chrome DevTools

Page.removeScriptToEvaluateOnNewDocument #

Removes given script from the list.

Parameters

identifier

Chrome DevTools

Page.resetNavigationHistory #

Resets navigation history for the current page.


Chrome DevTools

Page.setBypassCSP #

Enable page Content Security Policy by-passing.

Parameters

enabled
boolean

Whether to bypass page CSP.


Chrome DevTools

Page.setDocumentContent #

Sets given markup as the document's HTML.

Parameters

frameId
FrameId

Frame id to set HTML for.

html
string

HTML content to set.


Chrome DevTools

Page.setInterceptFileChooserDialog #

Intercept file chooser requests and transfer control to protocol clients. When file chooser interception is enabled, native file chooser dialog is not shown. Instead, a protocol event Page.fileChooserOpened is emitted.

Parameters

enabled
boolean

Chrome DevTools

Page.setLifecycleEventsEnabled #

Controls whether page will emit lifecycle events.

Parameters

enabled
boolean

If true, starts emitting lifecycle events.


Chrome DevTools

Page.stopLoading #

Force the page stop all navigations and pending resource fetches.


Chrome DevTools

Page.clearGeolocationOverride Deprecated#

Clears the overridden Geolocation Position and Error.


Chrome DevTools

Page.setGeolocationOverride Deprecated#

Overrides the Geolocation Position or Error. Omitting any of the parameters emulates position unavailable.

Parameters

latitude
Optional
number

Mock latitude

longitude
Optional
number

Mock longitude

accuracy
Optional
number

Mock accuracy


Chrome DevTools

Page.addCompilationCache Experimental#

Seeds compilation cache for given url. Compilation cache does not survive cross-process navigation.

Parameters

url
string
data
string

Base64-encoded data (Encoded as a base64 string when passed over JSON)


Chrome DevTools

Page.captureSnapshot Experimental#

Returns a snapshot of the page as a string. For MHTML format, the serialization includes iframes, shadow DOM, external resources, and element-inline styles.

Parameters

format
Optional
string

Format (defaults to mhtml).

Allowed values: mhtml

Return object

data
string

Serialized page data.


Chrome DevTools

Page.clearCompilationCache Experimental#

Clears seeded compilation cache.


Chrome DevTools

Page.crash Experimental#

Crashes renderer on the IO thread, generates minidumps.


Chrome DevTools

Page.generateTestReport Experimental#

Generates a report for testing.

Parameters

message
string

Message to be displayed in the report.

group
Optional
string

Specifies the endpoint group to deliver the report to.


Chrome DevTools

Page.getAdScriptId Experimental#

Parameters

frameId

Return object

adScriptId
Optional
AdScriptId

Identifies the bottom-most script which caused the frame to be labelled as an ad. Only sent if frame is labelled as an ad and id is available.


Chrome DevTools

Page.getAppId Experimental#

Returns the unique (PWA) app id. Only returns values if the feature flag 'WebAppEnableManifestId' is enabled

Return object

appId
Optional
string

App id, either from manifest's id attribute or computed from start_url

recommendedId
Optional
string

Recommendation for manifest's id attribute to match current id computed from start_url


Chrome DevTools

Page.getInstallabilityErrors Experimental#

Return object

installabilityErrors

Chrome DevTools

Page.getOriginTrials Experimental#

Get Origin Trials on given frame.

Parameters

frameId

Return object

originTrials
array[ OriginTrial ]

Chrome DevTools

Page.getPermissionsPolicyState Experimental#

Get Permissions Policy state on given frame.

Parameters

frameId

Return object


Chrome DevTools

Page.getResourceContent Experimental#

Returns content of the given resource.

Parameters

frameId
FrameId

Frame id to get resource for.

url
string

URL of the resource to get content for.

Return object

content
string

Resource content.

base64Encoded
boolean

True, if content was served as base64.


Chrome DevTools

Page.getResourceTree Experimental#

Returns present frame / resource tree structure.

Return object

frameTree
FrameResourceTree

Present frame / resource tree structure.


Chrome DevTools

Page.produceCompilationCache Experimental#

Requests backend to produce compilation cache for the specified scripts. scripts are appended to the list of scripts for which the cache would be produced. The list may be reset during page navigation. When script with a matching URL is encountered, the cache is optionally produced upon backend discretion, based on internal heuristics. See also: Page.compilationCacheProduced.

Parameters

scripts

Chrome DevTools

Page.screencastFrameAck Experimental#

Acknowledges that a screencast frame has been received by the frontend.

Parameters

sessionId
integer

Frame number.


Chrome DevTools

Page.searchInResource Experimental#

Searches for given string in resource content.

Parameters

frameId
FrameId

Frame id for resource to search in.

url
string

URL of the resource to search in.

query
string

String to search for.

caseSensitive
Optional
boolean

If true, search is case sensitive.

isRegex
Optional
boolean

If true, treats string parameter as regex.

Return object

result
array[ Debugger.SearchMatch ]

List of search matches.


Chrome DevTools

Page.setAdBlockingEnabled Experimental#

Enable Chrome's experimental ad filter on all sites.

Parameters

enabled
boolean

Whether to block ads.


Chrome DevTools

Page.setFontFamilies Experimental#

Set generic font families.

Parameters

fontFamilies
FontFamilies

Specifies font families to set. If a font family is not specified, it won't be changed.

forScripts
Optional
array[ ScriptFontFamilies ]

Specifies font families to set for individual scripts.


Chrome DevTools

Page.setFontSizes Experimental#

Set default font sizes.

Parameters

fontSizes
FontSizes

Specifies font sizes to set. If a font size is not specified, it won't be changed.


Chrome DevTools

Page.setPrerenderingAllowed Experimental#

Enable/disable prerendering manually.

This command is a short-term solution for https://crbug.com/1440085. See https://docs.google.com/document/d/12HVmFxYj5Jc-eJr5OmWsa2bqTJsbgGLKI6ZIyx0_wpA for more details.

TODO(https://crbug.com/1440085): Remove this once Puppeteer supports tab targets.

Parameters

isAllowed
boolean

Chrome DevTools

Page.setRPHRegistrationMode Experimental#

Extensions for Custom Handlers API: https://html.spec.whatwg.org/multipage/system-state.html#rph-automation

Parameters


Chrome DevTools

Page.setSPCTransactionMode Experimental#

Sets the Secure Payment Confirmation transaction mode. https://w3c.github.io/secure-payment-confirmation/#sctn-automation-set-spc-transaction-mode

Parameters


Chrome DevTools

Page.setWebLifecycleState Experimental#

Tries to update the web lifecycle state of the page. It will transition the page to the given state according to: https://github.com/WICG/web-lifecycle/

Parameters

state
string

Target lifecycle state

Allowed values: frozen, active


Chrome DevTools

Page.startScreencast Experimental#

Starts sending each frame using the screencastFrame event.

Parameters

format
Optional
string

Image compression format.

Allowed values: jpeg, png

quality
Optional
integer

Compression quality from range [0..100].

maxWidth
Optional
integer

Maximum screenshot width.

maxHeight
Optional
integer

Maximum screenshot height.

everyNthFrame
Optional
integer

Send every n-th frame.


Chrome DevTools

Page.stopScreencast Experimental#

Stops sending each frame in the screencastFrame.


Chrome DevTools

Page.waitForDebugger Experimental#

Pauses page execution. Can be resumed using generic Runtime.runIfWaitingForDebugger.


Chrome DevTools

Page.addScriptToEvaluateOnLoad ExperimentalDeprecated#

Deprecated, please use addScriptToEvaluateOnNewDocument instead.

Parameters

scriptSource
string

Return object

identifier
ScriptIdentifier

Identifier of the added script.


Chrome DevTools

Page.clearDeviceMetricsOverride ExperimentalDeprecated#

Clears the overridden device metrics.


Chrome DevTools

Page.clearDeviceOrientationOverride ExperimentalDeprecated#

Clears the overridden Device Orientation.


Chrome DevTools

Page.deleteCookie ExperimentalDeprecated#

Deletes browser cookie with given name, domain and path.

Parameters

cookieName
string

Name of the cookie to remove.

url
string

URL to match cooke domain and path.


Chrome DevTools

Page.getManifestIcons ExperimentalDeprecated#

Deprecated because it's not guaranteed that the returned icon is in fact the one used for PWA installation.

Return object

primaryIcon
Optional
string

Chrome DevTools

Page.removeScriptToEvaluateOnLoad ExperimentalDeprecated#

Deprecated, please use removeScriptToEvaluateOnNewDocument instead.

Parameters

identifier

Chrome DevTools

Page.setDeviceMetricsOverride ExperimentalDeprecated#

Overrides the values of device screen dimensions (window.screen.width, window.screen.height, window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media query results).

Parameters

width
integer

Overriding width value in pixels (minimum 0, maximum 10000000). 0 disables the override.

height
integer

Overriding height value in pixels (minimum 0, maximum 10000000). 0 disables the override.

deviceScaleFactor
number

Overriding device scale factor value. 0 disables the override.

mobile
boolean

Whether to emulate mobile device. This includes viewport meta tag, overlay scrollbars, text autosizing and more.

scale
Optional
number

Scale to apply to resulting view image.

screenWidth
Optional
integer

Overriding screen width value in pixels (minimum 0, maximum 10000000).

screenHeight
Optional
integer

Overriding screen height value in pixels (minimum 0, maximum 10000000).

positionX
Optional
integer

Overriding view X position on screen in pixels (minimum 0, maximum 10000000).

positionY
Optional
integer

Overriding view Y position on screen in pixels (minimum 0, maximum 10000000).

dontSetVisibleSize
Optional
boolean

Do not set visible view size, rely upon explicit setVisibleSize call.

screenOrientation
Optional
Emulation.ScreenOrientation

Screen orientation override.

viewport
Optional
Viewport

The viewport dimensions and scale. If not set, the override is cleared.


Chrome DevTools

Page.setDeviceOrientationOverride ExperimentalDeprecated#

Overrides the Device Orientation.

Parameters

alpha
number

Mock alpha

beta
number

Mock beta

gamma
number

Mock gamma


Chrome DevTools

Page.setDownloadBehavior ExperimentalDeprecated#

Set the behavior when downloading a file.

Parameters

behavior
string

Whether to allow all or deny all download requests, or use default Chrome behavior if available (otherwise deny).

Allowed values: deny, allow, default

downloadPath
Optional
string

The default path to save downloaded files to. This is required if behavior is set to 'allow'


Chrome DevTools

Page.setTouchEmulationEnabled ExperimentalDeprecated#

Toggles mouse event-based touch event emulation.

Parameters

enabled
boolean

Whether the touch event emulation should be enabled.

configuration
Optional
string

Touch/gesture events configuration. Default: current platform.

Allowed values: mobile, desktop

Events

Chrome DevTools

Page.domContentEventFired #

Parameters


Chrome DevTools

Page.fileChooserOpened #

Emitted only when page.interceptFileChooser is enabled.

Parameters

frameId
FrameId

Id of the frame containing input node.

Experimental
mode
string

Input mode.

Allowed values: selectSingle, selectMultiple

backendNodeId
Optional
DOM.BackendNodeId

Input node id. Only present for file choosers opened via an <input type="file"> element.

Experimental

Chrome DevTools

Page.frameAttached #

Fired when frame has been attached to its parent.

Parameters

frameId
FrameId

Id of the frame that has been attached.

parentFrameId
FrameId

Parent frame identifier.

stack
Optional
Runtime.StackTrace

JavaScript stack trace of when frame was attached, only set if frame initiated from script.


Chrome DevTools

Page.frameDetached #

Fired when frame has been detached from its parent.

Parameters

frameId
FrameId

Id of the frame that has been detached.

reason
string

Allowed values: remove, swap

Experimental

Chrome DevTools

Page.frameNavigated #

Fired once navigation of the frame has completed. Frame is now associated with the new loader.

Parameters

frame
Frame

Frame object.

type
NavigationTypeExperimental

Chrome DevTools

Page.interstitialHidden #

Fired when interstitial page was hidden


Chrome DevTools

Page.interstitialShown #

Fired when interstitial page was shown


Chrome DevTools

Page.javascriptDialogClosed #

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been closed.

Parameters

result
boolean

Whether dialog was confirmed.

userInput
string

User input in case of prompt.


Chrome DevTools

Page.javascriptDialogOpening #

Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to open.

Parameters

url
string

Frame url.

message
string

Message that will be displayed by the dialog.

type
DialogType

Dialog type.

hasBrowserHandler
boolean

True iff browser is capable showing or acting on the given dialog. When browser has no dialog handler for given target, calling alert while Page domain is engaged will stall the page execution. Execution can be resumed via calling Page.handleJavaScriptDialog.

defaultPrompt
Optional
string

Default dialog prompt.


Chrome DevTools

Page.lifecycleEvent #

Fired for top level page lifecycle events such as navigation, load, paint, etc.

Parameters

frameId
FrameId

Id of the frame.

loaderId
Network.LoaderId

Loader identifier. Empty string if the request is fetched from worker.

name
string

Chrome DevTools

Page.loadEventFired #

Parameters


Chrome DevTools

Page.windowOpen #

Fired when a new window is going to be opened, via window.open(), link click, form submission, etc.

Parameters

url
string

The URL for the new window.

windowName
string

Window name.

windowFeatures
array[ string ]

An array of enabled window features.

userGesture
boolean

Whether or not it was triggered by user gesture.


Chrome DevTools

Page.frameClearedScheduledNavigation Deprecated#

Fired when frame no longer has a scheduled navigation.

Parameters

frameId
FrameId

Id of the frame that has cleared its scheduled navigation.


Chrome DevTools

Page.frameScheduledNavigation Deprecated#

Fired when frame schedules a potential navigation.

Parameters

frameId
FrameId

Id of the frame that has scheduled a navigation.

delay
number

Delay (in seconds) until the navigation is scheduled to begin. The navigation is not guaranteed to start.

reason
ClientNavigationReason

The reason for the navigation.

url
string

The destination URL for the scheduled navigation.


Chrome DevTools

Page.backForwardCacheNotUsed Experimental#

Fired for failed bfcache history navigations if BackForwardCache feature is enabled. Do not assume any ordering with the Page.frameNavigated event. This event is fired only for main-frame history navigation where the document changes (non-same-document navigations), when bfcache navigation fails.

Parameters

loaderId
Network.LoaderId

The loader id for the associated navigation.

frameId
FrameId

The frame id of the associated frame.

notRestoredExplanations
array[ BackForwardCacheNotRestoredExplanation ]

Array of reasons why the page could not be cached. This must not be empty.

notRestoredExplanationsTree
Optional
BackForwardCacheNotRestoredExplanationTree

Tree structure of reasons why the page could not be cached for each frame.


Chrome DevTools

Page.compilationCacheProduced Experimental#

Issued for every compilation cache generated. Is only available if Page.setGenerateCompilationCache is enabled.

Parameters

url
string
data
string

Base64-encoded data (Encoded as a base64 string when passed over JSON)


Chrome DevTools

Page.documentOpened Experimental#

Fired when opening document to write to.

Parameters

frame
Frame

Frame object.


Chrome DevTools

Page.frameRequestedNavigation Experimental#

Fired when a renderer-initiated navigation is requested. Navigation may still be cancelled after the event is issued.

Parameters

frameId
FrameId

Id of the frame that is being navigated.

reason
ClientNavigationReason

The reason for the navigation.

url
string

The destination URL for the requested navigation.

disposition
ClientNavigationDisposition

The disposition for the navigation.


Chrome DevTools

Page.frameResized Experimental#


Chrome DevTools

Page.frameStartedLoading Experimental#

Fired when frame has started loading.

Parameters

frameId
FrameId

Id of the frame that has started loading.


Chrome DevTools

Page.frameStoppedLoading Experimental#

Fired when frame has stopped loading.

Parameters

frameId
FrameId

Id of the frame that has stopped loading.


Chrome DevTools

Page.navigatedWithinDocument Experimental#

Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.

Parameters

frameId
FrameId

Id of the frame.

url
string

Frame's new url.


Chrome DevTools

Page.screencastFrame Experimental#

Compressed image data requested by the startScreencast.

Parameters

data
string

Base64-encoded compressed image. (Encoded as a base64 string when passed over JSON)

metadata
ScreencastFrameMetadata

Screencast frame metadata.

sessionId
integer

Frame number.


Chrome DevTools

Page.screencastVisibilityChanged Experimental#

Fired when the page with currently enabled screencast was shown or hidden `.

Parameters

visible
boolean

True if the page is visible.


Chrome DevTools

Page.downloadProgress ExperimentalDeprecated#

Fired when download makes progress. Last call has |done| == true. Deprecated. Use Browser.downloadProgress instead.

Parameters

guid
string

Global unique identifier of the download.

totalBytes
number

Total expected bytes to download.

receivedBytes
number

Total bytes received.

state
string

Download status.

Allowed values: inProgress, completed, canceled


Chrome DevTools

Page.downloadWillBegin ExperimentalDeprecated#

Fired when page is about to start a download. Deprecated. Use Browser.downloadWillBegin instead.

Parameters

frameId
FrameId

Id of the frame that caused download to begin.

guid
string

Global unique identifier of the download.

url
string

URL of the resource being downloaded.

suggestedFilename
string

Suggested file name of the resource (the actual name of the file saved on disk may differ).

Types

Chrome DevTools

Page.AppManifestError #

Error while paring app manifest.

Type: object

Properties

message
string

Error message.

critical
integer

If critical, this is a non-recoverable parse error.

line
integer

Error line.

column
integer

Error column.


Chrome DevTools

Page.DialogType #

Javascript dialog type.

Type: string

Allowed values: alert, confirm, prompt, beforeunload


Chrome DevTools

Page.Frame #

Information about the Frame on the page.

Type: object

Properties

id
FrameId

Frame unique identifier.

parentId
Optional
FrameId

Parent frame identifier.

loaderId
Network.LoaderId

Identifier of the loader associated with this frame.

name
Optional
string

Frame's name as specified in the tag.

url
string

Frame document's URL without fragment.

urlFragment
Optional
string

Frame document's URL fragment including the '#'.

Experimental
domainAndRegistry
string

Frame document's registered domain, taking the public suffixes list into account. Extracted from the Frame's url. Example URLs: http://www.google.com/file.html -> "google.com" http://a.b.co.uk/file.html -> "b.co.uk"

Experimental
securityOrigin
string

Frame document's security origin.

mimeType
string

Frame document's mimeType as determined by the browser.

unreachableUrl
Optional
string

If the frame failed to load, this contains the URL that could not be loaded. Note that unlike url above, this URL may contain a fragment.

Experimental
adFrameStatus
Optional
AdFrameStatus

Indicates whether this frame was tagged as an ad and why.

Experimental
secureContextType
SecureContextType

Indicates whether the main document is a secure context and explains why that is the case.

Experimental
crossOriginIsolatedContextType
CrossOriginIsolatedContextType

Indicates whether this is a cross origin isolated context.

Experimental
gatedAPIFeatures
array[ GatedAPIFeatures ]

Indicated which gated APIs / features are available.

Experimental

Chrome DevTools

Page.FrameId #

Unique frame identifier.

Type: string


Chrome DevTools

Page.FrameTree #

Information about the Frame hierarchy.

Type: object

Properties

frame
Frame

Frame information for this tree item.

childFrames
Optional
array[ FrameTree ]

Child frames.


Chrome DevTools

Page.LayoutViewport #

Layout viewport position and dimensions.

Type: object

Properties

pageX
integer

Horizontal offset relative to the document (CSS pixels).

pageY
integer

Vertical offset relative to the document (CSS pixels).

clientWidth
integer

Width (CSS pixels), excludes scrollbar if present.

clientHeight
integer

Height (CSS pixels), excludes scrollbar if present.


Chrome DevTools

Page.NavigationEntry #

Navigation history entry.

Type: object

Properties

id
integer

Unique id of the navigation history entry.

url
string

URL of the navigation history entry.

userTypedURL
string

URL that the user typed in the url bar.

title
string

Title of the navigation history entry.

transitionType
TransitionType

Transition type.


Chrome DevTools

Page.ScriptIdentifier #

Unique script identifier.

Type: string


Chrome DevTools

Page.TransitionType #

Transition type.

Type: string

Allowed values: link, typed, address_bar, auto_bookmark, auto_subframe, manual_subframe, generated, auto_toplevel, form_submit, reload, keyword, keyword_generated, other


Chrome DevTools

Page.Viewport #

Viewport for capturing screenshot.

Type: object

Properties

x
number

X offset in device independent pixels (dip).

y
number

Y offset in device independent pixels (dip).

width
number

Rectangle width in device independent pixels (dip).

height
number

Rectangle height in device independent pixels (dip).

scale
number

Page scale factor.


Chrome DevTools

Page.VisualViewport #

Visual viewport position, dimensions, and scale.

Type: object

Properties

offsetX
number

Horizontal offset relative to the layout viewport (CSS pixels).

offsetY
number

Vertical offset relative to the layout viewport (CSS pixels).

pageX
number

Horizontal offset relative to the document (CSS pixels).

pageY
number

Vertical offset relative to the document (CSS pixels).

clientWidth
number

Width (CSS pixels), excludes scrollbar if present.

clientHeight
number

Height (CSS pixels), excludes scrollbar if present.

scale
number

Scale relative to the ideal viewport (size at width=device-width).

zoom
Optional
number

Page zoom factor (CSS to device independent pixels ratio).


Chrome DevTools

Page.AdFrameExplanation Experimental#

Type: string

Allowed values: ParentIsAd, CreatedByAdScript, MatchedBlockingRule


Chrome DevTools

Page.AdFrameStatus Experimental#

Indicates whether a frame has been identified as an ad and why.

Type: object

Properties

adFrameType
explanations
Optional

Chrome DevTools

Page.AdFrameType Experimental#

Indicates whether a frame has been identified as an ad.

Type: string

Allowed values: none, child, root


Chrome DevTools

Page.AdScriptId Experimental#

Identifies the bottom-most script which caused the frame to be labelled as an ad.

Type: object

Properties

scriptId
Runtime.ScriptId

Script Id of the bottom-most script which caused the frame to be labelled as an ad.

debuggerId
Runtime.UniqueDebuggerId

Id of adScriptId's debugger.


Chrome DevTools

Page.AppManifestParsedProperties Experimental#

Parsed app manifest properties.

Type: object

Properties

scope
string

Computed scope value


Chrome DevTools

Page.AutoResponseMode Experimental#

Enum of possible auto-response for permission / prompt dialogs.

Type: string

Allowed values: none, autoAccept, autoReject, autoOptOut


Chrome DevTools

Page.BackForwardCacheBlockingDetails Experimental#

Type: object

Properties

url
Optional
string

Url of the file where blockage happened. Optional because of tests.

function
Optional
string

Function name where blockage happened. Optional because of anonymous functions and tests.

lineNumber
integer

Line number in the script (0-based).

columnNumber
integer

Column number in the script (0-based).


Chrome DevTools

Page.BackForwardCacheNotRestoredExplanation Experimental#

Type: object

Properties

reason
context
Optional
string

Context associated with the reason. The meaning of this context is dependent on the reason:

  • EmbedderExtensionSentMessageToCachedFrame: the extension ID.
details
Optional

Chrome DevTools

Page.BackForwardCacheNotRestoredExplanationTree Experimental#

Type: object

Properties

url
string

URL of each frame

explanations
array[ BackForwardCacheNotRestoredExplanation ]

Not restored reasons of each frame

children
array[ BackForwardCacheNotRestoredExplanationTree ]

Array of children frame


Chrome DevTools

Page.BackForwardCacheNotRestoredReason Experimental#

List of not restored reasons for back-forward cache.

Type: string

Allowed values: NotPrimaryMainFrame, BackForwardCacheDisabled, RelatedActiveContentsExist, HTTPStatusNotOK, SchemeNotHTTPOrHTTPS, Loading, WasGrantedMediaAccess, DisableForRenderFrameHostCalled, DomainNotAllowed, HTTPMethodNotGET, SubframeIsNavigating, Timeout, CacheLimit, JavaScriptExecution, RendererProcessKilled, RendererProcessCrashed, SchedulerTrackedFeatureUsed, ConflictingBrowsingInstance, CacheFlushed, ServiceWorkerVersionActivation, SessionRestored, ServiceWorkerPostMessage, EnteredBackForwardCacheBeforeServiceWorkerHostAdded, RenderFrameHostReused_SameSite, RenderFrameHostReused_CrossSite, ServiceWorkerClaim, IgnoreEventAndEvict, HaveInnerContents, TimeoutPuttingInCache, BackForwardCacheDisabledByLowMemory, BackForwardCacheDisabledByCommandLine, NetworkRequestDatapipeDrainedAsBytesConsumer, NetworkRequestRedirected, NetworkRequestTimeout, NetworkExceedsBufferLimit, NavigationCancelledWhileRestoring, NotMostRecentNavigationEntry, BackForwardCacheDisabledForPrerender, UserAgentOverrideDiffers, ForegroundCacheLimit, BrowsingInstanceNotSwapped, BackForwardCacheDisabledForDelegate, UnloadHandlerExistsInMainFrame, UnloadHandlerExistsInSubFrame, ServiceWorkerUnregistration, CacheControlNoStore, CacheControlNoStoreCookieModified, CacheControlNoStoreHTTPOnlyCookieModified, NoResponseHead, Unknown, ActivationNavigationsDisallowedForBug1234857, ErrorDocument, FencedFramesEmbedder, CookieDisabled, HTTPAuthRequired, CookieFlushed, BroadcastChannelOnMessage, WebViewSettingsChanged, WebViewJavaScriptObjectChanged, WebViewMessageListenerInjected, WebViewSafeBrowsingAllowlistChanged, WebViewDocumentStartJavascriptChanged, WebSocket, WebTransport, WebRTC, MainResourceHasCacheControlNoStore, MainResourceHasCacheControlNoCache, SubresourceHasCacheControlNoStore, SubresourceHasCacheControlNoCache, ContainsPlugins, DocumentLoaded, OutstandingNetworkRequestOthers, RequestedMIDIPermission, RequestedAudioCapturePermission, RequestedVideoCapturePermission, RequestedBackForwardCacheBlockedSensors, RequestedBackgroundWorkPermission, BroadcastChannel, WebXR, SharedWorker, WebLocks, WebHID, WebShare, RequestedStorageAccessGrant, WebNfc, OutstandingNetworkRequestFetch, OutstandingNetworkRequestXHR, AppBanner, Printing, WebDatabase, PictureInPicture, Portal, SpeechRecognizer, IdleManager, PaymentManager, SpeechSynthesis, KeyboardLock, WebOTPService, OutstandingNetworkRequestDirectSocket, InjectedJavascript, InjectedStyleSheet, KeepaliveRequest, IndexedDBEvent, Dummy, JsNetworkRequestReceivedCacheControlNoStoreResource, WebRTCSticky, WebTransportSticky, WebSocketSticky, SmartCard, LiveMediaStreamTrack, UnloadHandler, ParserAborted, ContentSecurityHandler, ContentWebAuthenticationAPI, ContentFileChooser, ContentSerial, ContentFileSystemAccess, ContentMediaDevicesDispatcherHost, ContentWebBluetooth, ContentWebUSB, ContentMediaSessionService, ContentScreenReader, EmbedderPopupBlockerTabHelper, EmbedderSafeBrowsingTriggeredPopupBlocker, EmbedderSafeBrowsingThreatDetails, EmbedderAppBannerManager, EmbedderDomDistillerViewerSource, EmbedderDomDistillerSelfDeletingRequestDelegate, EmbedderOomInterventionTabHelper, EmbedderOfflinePage, EmbedderChromePasswordManagerClientBindCredentialManager, EmbedderPermissionRequestManager, EmbedderModalDialog, EmbedderExtensions, EmbedderExtensionMessaging, EmbedderExtensionMessagingForOpenPort, EmbedderExtensionSentMessageToCachedFrame, RequestedByWebViewClient


Chrome DevTools

Page.BackForwardCacheNotRestoredReasonType Experimental#

Types of not restored reasons for back-forward cache.

Type: string

Allowed values: SupportPending, PageSupportNeeded, Circumstantial


Chrome DevTools

Page.ClientNavigationDisposition Experimental#

Type: string

Allowed values: currentTab, newTab, newWindow, download


Chrome DevTools

Page.ClientNavigationReason Experimental#

Type: string

Allowed values: formSubmissionGet, formSubmissionPost, httpHeaderRefresh, scriptInitiated, metaTagRefresh, pageBlockInterstitial, reload, anchorClick


Chrome DevTools

Page.CompilationCacheParams Experimental#

Per-script compilation cache parameters for Page.produceCompilationCache

Type: object

Properties

url
string

The URL of the script to produce a compilation cache entry for.

eager
Optional
boolean

A hint to the backend whether eager compilation is recommended. (the actual compilation mode used is upon backend discretion).


Chrome DevTools

Page.CrossOriginIsolatedContextType Experimental#

Indicates whether the frame is cross-origin isolated and why it is the case.

Type: string

Allowed values: Isolated, NotIsolated, NotIsolatedFeatureDisabled


Chrome DevTools

Page.FileFilter Experimental#

Type: object

Properties

name
Optional
string
accepts
Optional
array[ string ]

Chrome DevTools

Page.FileHandler Experimental#

Type: object

Properties

action
string
name
string
icons
Optional
array[ ImageResource ]
accepts
Optional
array[ FileFilter ]

Mimic a map, name is the key, accepts is the value.

launchType
string

Won't repeat the enums, using string for easy comparison. Same as the other enums below.


Chrome DevTools

Page.FontFamilies Experimental#

Generic font families collection.

Type: object

Properties

standard
Optional
string

The standard font-family.

fixed
Optional
string

The fixed font-family.

serif
Optional
string

The serif font-family.

sansSerif
Optional
string

The sansSerif font-family.

cursive
Optional
string

The cursive font-family.

fantasy
Optional
string

The fantasy font-family.

math
Optional
string

The math font-family.


Chrome DevTools

Page.FontSizes Experimental#

Default font sizes.

Type: object

Properties

standard
Optional
integer

Default standard font size.

fixed
Optional
integer

Default fixed font size.


Chrome DevTools

Page.FrameResource Experimental#

Information about the Resource on the page.

Type: object

Properties

url
string

Resource URL.

type
Network.ResourceType

Type of this resource.

mimeType
string

Resource mimeType as determined by the browser.

lastModified
Optional
Network.TimeSinceEpoch

last-modified timestamp as reported by server.

contentSize
Optional
number

Resource content size.

failed
Optional
boolean

True if the resource failed to load.

canceled
Optional
boolean

True if the resource was canceled during loading.


Chrome DevTools

Page.FrameResourceTree Experimental#

Information about the Frame hierarchy along with their cached resources.

Type: object

Properties

frame
Frame

Frame information for this tree item.

childFrames
Optional
array[ FrameResourceTree ]

Child frames.

resources
array[ FrameResource ]

Information about frame resources.


Chrome DevTools

Page.GatedAPIFeatures Experimental#

Type: string

Allowed values: SharedArrayBuffers, SharedArrayBuffersTransferAllowed, PerformanceMeasureMemory, PerformanceProfile


Chrome DevTools

Page.ImageResource Experimental#

The image definition used in both icon and screenshot.

Type: object

Properties

url
string

The src field in the definition, but changing to url in favor of consistency.

sizes
Optional
string
type
Optional
string

Chrome DevTools

Page.InstallabilityError Experimental#

The installability error

Type: object

Properties

errorId
string

The error id (e.g. 'manifest-missing-suitable-icon').

errorArguments
array[ InstallabilityErrorArgument ]

The list of error arguments (e.g. {name:'minimum-icon-size-in-pixels', value:'64'}).


Chrome DevTools

Page.InstallabilityErrorArgument Experimental#

Type: object

Properties

name
string

Argument name (e.g. name:'minimum-icon-size-in-pixels').

value
string

Argument value (e.g. value:'64').


Chrome DevTools

Page.LaunchHandler Experimental#

Type: object

Properties

clientMode
string

Chrome DevTools

Page.NavigationType Experimental#

The type of a frameNavigated event.

Type: string

Allowed values: Navigation, BackForwardCacheRestore


Chrome DevTools

Page.OriginTrial Experimental#

Type: object

Properties

trialName
string
tokensWithStatus

Chrome DevTools

Page.OriginTrialStatus Experimental#

Status for an Origin Trial.

Type: string

Allowed values: Enabled, ValidTokenNotProvided, OSNotSupported, TrialNotAllowed


Chrome DevTools

Page.OriginTrialToken Experimental#

Type: object

Properties

origin
string
matchSubDomains
boolean
trialName
string
isThirdParty
boolean

Chrome DevTools

Page.OriginTrialTokenStatus Experimental#

Origin Trial(https://www.chromium.org/blink/origin-trials) support. Status for an Origin Trial token.

Type: string

Allowed values: Success, NotSupported, Insecure, Expired, WrongOrigin, InvalidSignature, Malformed, WrongVersion, FeatureDisabled, TokenDisabled, FeatureDisabledForUser, UnknownTrial


Chrome DevTools

Page.OriginTrialTokenWithStatus Experimental#

Type: object

Properties

rawTokenText
string
parsedToken
Optional
OriginTrialToken

parsedToken is present only when the token is extractable and parsable.


Chrome DevTools

Page.OriginTrialUsageRestriction Experimental#

Type: string

Allowed values: None, Subset


Chrome DevTools

Page.PermissionsPolicyBlockLocator Experimental#

Type: object

Properties

frameId

Chrome DevTools

Page.PermissionsPolicyBlockReason Experimental#

Reason for a permissions policy feature to be disabled.

Type: string

Allowed values: Header, IframeAttribute, InFencedFrameTree, InIsolatedApp


Chrome DevTools

Page.PermissionsPolicyFeature Experimental#

All Permissions Policy features. This enum should match the one defined in third_party/blink/renderer/core/permissions_policy/permissions_policy_features.json5.

Type: string

Allowed values: accelerometer, ambient-light-sensor, attribution-reporting, autoplay, bluetooth, browsing-topics, camera, captured-surface-control, ch-dpr, ch-device-memory, ch-downlink, ch-ect, ch-prefers-color-scheme, ch-prefers-reduced-motion, ch-prefers-reduced-transparency, ch-rtt, ch-save-data, ch-ua, ch-ua-arch, ch-ua-bitness, ch-ua-platform, ch-ua-model, ch-ua-mobile, ch-ua-form-factors, ch-ua-full-version, ch-ua-full-version-list, ch-ua-platform-version, ch-ua-wow64, ch-viewport-height, ch-viewport-width, ch-width, clipboard-read, clipboard-write, compute-pressure, cross-origin-isolated, deferred-fetch, direct-sockets, display-capture, document-domain, encrypted-media, execution-while-out-of-viewport, execution-while-not-rendered, focus-without-user-activation, fullscreen, frobulate, gamepad, geolocation, gyroscope, hid, identity-credentials-get, idle-detection, interest-cohort, join-ad-interest-group, keyboard-map, local-fonts, magnetometer, microphone, midi, otp-credentials, payment, picture-in-picture, private-aggregation, private-state-token-issuance, private-state-token-redemption, publickey-credentials-create, publickey-credentials-get, run-ad-auction, screen-wake-lock, serial, shared-autofill, shared-storage, shared-storage-select-url, smart-card, speaker-selection, storage-access, sub-apps, sync-xhr, unload, usb, usb-unrestricted, vertical-scroll, web-printing, web-share, window-management, xr-spatial-tracking


Chrome DevTools

Page.PermissionsPolicyFeatureState Experimental#

Type: object

Properties

allowed
boolean

Chrome DevTools

Page.ProtocolHandler Experimental#

Type: object

Properties

protocol
string
url
string

Chrome DevTools

Page.ReferrerPolicy Experimental#

The referring-policy used for the navigation.

Type: string

Allowed values: noReferrer, noReferrerWhenDowngrade, origin, originWhenCrossOrigin, sameOrigin, strictOrigin, strictOriginWhenCrossOrigin, unsafeUrl


Chrome DevTools

Page.RelatedApplication Experimental#

Type: object

Properties

id
Optional
string
url
string

Chrome DevTools

Page.ScopeExtension Experimental#

Type: object

Properties

origin
string

Instead of using tuple, this field always returns the serialized string for easy understanding and comparison.

hasOriginWildcard
boolean

Chrome DevTools

Page.ScreencastFrameMetadata Experimental#

Screencast frame metadata.

Type: object

Properties

offsetTop
number

Top offset in DIP.

pageScaleFactor
number

Page scale factor.

deviceWidth
number

Device screen width in DIP.

deviceHeight
number

Device screen height in DIP.

scrollOffsetX
number

Position of horizontal scroll in CSS pixels.

scrollOffsetY
number

Position of vertical scroll in CSS pixels.

timestamp
Optional
Network.TimeSinceEpoch

Frame swap timestamp.


Chrome DevTools

Page.Screenshot Experimental#

Type: object

Properties

formFactor
string
label
Optional
string

Chrome DevTools

Page.ScriptFontFamilies Experimental#

Font families collection for a script.

Type: object

Properties

script
string

Name of the script which these font families are defined for.

fontFamilies
FontFamilies

Generic font families collection for the script.


Chrome DevTools

Page.SecureContextType Experimental#

Indicates whether the frame is a secure context and why it is the case.

Type: string

Allowed values: Secure, SecureLocalhost, InsecureScheme, InsecureAncestor


Chrome DevTools

Page.ShareTarget Experimental#

Type: object

Properties

action
string
method
string
enctype
string
title
Optional
string

Embed the ShareTargetParams

text
Optional
string
url
Optional
string
files
Optional
array[ FileFilter ]

Chrome DevTools

Page.Shortcut Experimental#

Type: object

Properties

name
string
url
string

Chrome DevTools

Page.WebAppManifest Experimental#

Type: object

Properties

backgroundColor
Optional
string
description
Optional
string

The extra description provided by the manifest.

dir
Optional
string
display
Optional
string
displayOverrides
Optional
array[ string ]

The overrided display mode controlled by the user.

fileHandlers
Optional
array[ FileHandler ]

The handlers to open files.

icons
Optional
array[ ImageResource ]
id
Optional
string
lang
Optional
string
launchHandler
Optional
LaunchHandler

TODO(crbug.com/1231886): This field is non-standard and part of a Chrome experiment. See: https://github.com/WICG/web-app-launch/blob/main/launch_handler.md

name
Optional
string
orientation
Optional
string
preferRelatedApplications
Optional
boolean
protocolHandlers
Optional
array[ ProtocolHandler ]

The handlers to open protocols.

relatedApplications
Optional
scope
Optional
string
scopeExtensions
Optional
array[ ScopeExtension ]

Non-standard, see https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-explainer.md

screenshots
Optional
array[ Screenshot ]

The screenshots used by chromium.

shareTarget
Optional
shortName
Optional
string
shortcuts
Optional
array[ Shortcut ]
startUrl
Optional
string
themeColor
Optional
string