From fd956a21d244279396072d93834e7f68b93ab866 Mon Sep 17 00:00:00 2001 From: Playwright Service <89237858+playwrightmachine@users.noreply.github.com> Date: Thu, 18 Jul 2024 03:13:32 -0700 Subject: [PATCH] feat(roll): roll to ToT Playwright (18-07-24) (#1445) --- dotnet/docs/api/class-elementhandle.mdx | 84 +++++++++++++++---- dotnet/docs/api/class-filechooser.mdx | 7 +- dotnet/docs/api/class-frame.mdx | 93 +++++++++++++++++---- dotnet/docs/api/class-locator.mdx | 105 ++++++++++++++++++++---- dotnet/docs/api/class-page.mdx | 91 ++++++++++++++++---- java/docs/api/class-elementhandle.mdx | 84 +++++++++++++++---- java/docs/api/class-filechooser.mdx | 7 +- java/docs/api/class-frame.mdx | 93 +++++++++++++++++---- java/docs/api/class-locator.mdx | 105 ++++++++++++++++++++---- java/docs/api/class-page.mdx | 91 ++++++++++++++++---- nodejs/docs/api/class-elementhandle.mdx | 84 +++++++++++++++---- nodejs/docs/api/class-filechooser.mdx | 7 +- nodejs/docs/api/class-frame.mdx | 93 +++++++++++++++++---- nodejs/docs/api/class-locator.mdx | 105 ++++++++++++++++++++---- nodejs/docs/api/class-page.mdx | 91 ++++++++++++++++---- nodejs/docs/test-assertions.mdx | 2 + python/docs/api/class-elementhandle.mdx | 84 +++++++++++++++---- python/docs/api/class-filechooser.mdx | 7 +- python/docs/api/class-frame.mdx | 93 +++++++++++++++++---- python/docs/api/class-locator.mdx | 105 ++++++++++++++++++++---- python/docs/api/class-page.mdx | 91 ++++++++++++++++---- 21 files changed, 1254 insertions(+), 268 deletions(-) diff --git a/dotnet/docs/api/class-elementhandle.mdx b/dotnet/docs/api/class-elementhandle.mdx index 709b51901f..f173637f1e 100644 --- a/dotnet/docs/api/class-elementhandle.mdx +++ b/dotnet/docs/api/class-elementhandle.mdx @@ -170,7 +170,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -190,7 +189,12 @@ await ElementHandle.CheckAsync(options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)* Added in: v1.11# - `X` [float] Added in: v1.11# @@ -257,6 +261,11 @@ await ElementHandle.ClickAsync(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Position` Position? *(optional)*# - `X` [float]# @@ -293,7 +302,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -325,7 +333,12 @@ await ElementHandle.DblClickAsync(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -523,7 +536,12 @@ await ElementHandle.FillAsync(value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -601,7 +619,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -623,7 +640,12 @@ await ElementHandle.HoverAsync(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -909,6 +931,11 @@ await ElementHandle.PressAsync(key, options); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Timeout` [float]? *(optional)*# @@ -1135,6 +1162,11 @@ await handle.SelectOptionAsync(new[] { Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Timeout` [float]? *(optional)*# @@ -1197,7 +1229,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1218,7 +1249,12 @@ await ElementHandle.SetCheckedAsync(checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -1274,7 +1310,12 @@ await ElementHandle.SetInputFilesAsync(files, options); - `options` `ElementHandleSetInputFilesOptions?` *(optional)* - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1299,7 +1340,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1325,7 +1365,12 @@ await ElementHandle.TapAsync(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -1397,7 +1442,12 @@ To press a special key, like `Control` or `ArrowDown`, use [ElementHandle.PressA Time to wait between key presses in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1423,7 +1473,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1443,7 +1492,12 @@ await ElementHandle.UncheckAsync(options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)* Added in: v1.11# - `X` [float] Added in: v1.11# diff --git a/dotnet/docs/api/class-filechooser.mdx b/dotnet/docs/api/class-filechooser.mdx index afdbb97423..9103d5a440 100644 --- a/dotnet/docs/api/class-filechooser.mdx +++ b/dotnet/docs/api/class-filechooser.mdx @@ -99,7 +99,12 @@ await FileChooser.SetFilesAsync(files, options); - `options` `FileChooserSetFilesOptions?` *(optional)* - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/dotnet/docs/api/class-frame.mdx b/dotnet/docs/api/class-frame.mdx index f715b1c855..3e75c9cbde 100644 --- a/dotnet/docs/api/class-frame.mdx +++ b/dotnet/docs/api/class-frame.mdx @@ -167,7 +167,12 @@ await Frame.DragAndDropAsync(source, target, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `SourcePosition` SourcePosition? *(optional)* Added in: v1.14# - `X` [float] Added in: v1.14# @@ -1074,7 +1079,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1095,7 +1099,12 @@ await Frame.CheckAsync(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)* Added in: v1.11# - `X` [float] Added in: v1.11# @@ -1167,6 +1176,11 @@ await Frame.ClickAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Position` Position? *(optional)*# - `X` [float]# @@ -1206,8 +1220,7 @@ This method double clicks an element matching `selector` by performing the follo 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM. 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. -1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. +1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1240,7 +1253,12 @@ await Frame.DblClickAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -1448,7 +1466,12 @@ await Frame.FillAsync(selector, value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Strict` [bool]? *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -1552,7 +1575,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1575,7 +1597,12 @@ await Frame.HoverAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -1937,6 +1964,11 @@ await Frame.PressAsync(selector, key, options); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Strict` [bool]? *(optional)* Added in: v1.14# @@ -2183,6 +2215,11 @@ await frame.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" }) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Strict` [bool]? *(optional)* Added in: v1.14# @@ -2214,7 +2251,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2238,7 +2274,12 @@ await Frame.SetCheckedAsync(selector, checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -2300,7 +2341,12 @@ await Frame.SetInputFilesAsync(selector, files, options); - `options` `FrameSetInputFilesOptions?` *(optional)* - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Strict` [bool]? *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2329,7 +2375,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2356,7 +2401,12 @@ await Frame.TapAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -2446,7 +2496,12 @@ To press a special key, like `Control` or `ArrowDown`, use [Keyboard.PressAsync( Time to wait between key presses in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Strict` [bool]? *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2476,7 +2531,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2497,7 +2551,12 @@ await Frame.UncheckAsync(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)* Added in: v1.11# - `X` [float] Added in: v1.11# diff --git a/dotnet/docs/api/class-locator.mdx b/dotnet/docs/api/class-locator.mdx index af23b9fb78..bf4a9ec9be 100644 --- a/dotnet/docs/api/class-locator.mdx +++ b/dotnet/docs/api/class-locator.mdx @@ -190,7 +190,12 @@ await page.GetByRole(AriaRole.Checkbox).CheckAsync(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -216,7 +221,6 @@ Performs the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -244,7 +248,12 @@ await page.GetByRole(AriaRole.Textbox).ClearAsync(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -303,6 +312,11 @@ await page.Locator("canvas").ClickAsync(new() { Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Position` Position? *(optional)*# - `X` [float]# @@ -409,7 +423,12 @@ await Locator.DblClickAsync(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -434,7 +453,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -534,7 +552,12 @@ await source.DragToAsync(target, new() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `SourcePosition` SourcePosition? *(optional)*# - `X` [float]# @@ -702,7 +725,12 @@ await page.GetByRole(AriaRole.Textbox).FillAsync("example value"); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1224,7 +1252,12 @@ await page.GetByRole(AriaRole.Link).HoverAsync(); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -1249,7 +1282,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1654,6 +1686,11 @@ await page.GetByRole(AriaRole.Textbox).PressAsync("Backspace"); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Timeout` [float]? *(optional)*# @@ -1717,7 +1754,12 @@ await locator.PressAsync("Enter"); Time to wait between key presses in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1872,6 +1914,11 @@ await element.SelectOptionAsync(new[] { "red", "green", "blue" }); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Timeout` [float]? *(optional)*# @@ -1942,7 +1989,12 @@ await page.GetByRole(AriaRole.Checkbox).SetCheckedAsync(true); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -1969,7 +2021,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2020,7 +2071,12 @@ await page.GetByLabel("Upload file").SetInputFilesAsync(new FilePayload - `options` `LocatorSetInputFilesOptions?` *(optional)* - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -2058,7 +2114,12 @@ await Locator.TapAsync(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -2083,7 +2144,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2141,7 +2201,12 @@ await page.GetByRole(AriaRole.Checkbox).UncheckAsync(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -2167,7 +2232,6 @@ This method unchecks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2292,7 +2356,12 @@ To press a special key, like `Control` or `ArrowDown`, use [Locator.PressAsync() Time to wait between key presses in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Timeout` [float]? *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.SetDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.SetDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/dotnet/docs/api/class-page.mdx b/dotnet/docs/api/class-page.mdx index b5f43551c6..60a9397d07 100644 --- a/dotnet/docs/api/class-page.mdx +++ b/dotnet/docs/api/class-page.mdx @@ -354,7 +354,12 @@ await Page.DragAndDropAsync("#source", "#target", new() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `SourcePosition` SourcePosition? *(optional)* Added in: v1.14# - `X` [float] Added in: v1.14# @@ -3146,7 +3151,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3167,7 +3171,12 @@ await Page.CheckAsync(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)* Added in: v1.11# - `X` [float] Added in: v1.11# @@ -3239,6 +3248,11 @@ await Page.ClickAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Position` Position? *(optional)*# - `X` [float]# @@ -3279,7 +3293,6 @@ This method double clicks an element matching `selector` by performing the follo 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3312,7 +3325,12 @@ await Page.DblClickAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -3515,7 +3533,12 @@ await Page.FillAsync(selector, value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Strict` [bool]? *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -3619,7 +3642,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3642,7 +3664,12 @@ await Page.HoverAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -4049,6 +4076,11 @@ await page.ScreenshotAsync(new() { Path = "O.png" }); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Strict` [bool]? *(optional)* Added in: v1.14# @@ -4283,6 +4315,11 @@ await page.SelectOptionAsync("select#colors", new[] { "red", "green", "blue" }); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `Strict` [bool]? *(optional)* Added in: v1.14# @@ -4314,7 +4351,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4338,7 +4374,12 @@ await Page.SetCheckedAsync(selector, checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -4400,7 +4441,12 @@ await Page.SetInputFilesAsync(selector, files, options); - `options` `PageSetInputFilesOptions?` *(optional)* - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Strict` [bool]? *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -4429,7 +4475,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4456,7 +4501,12 @@ await Page.TapAsync(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)*# - `X` [float]# @@ -4546,7 +4596,12 @@ To press a special key, like `Control` or `ArrowDown`, use [Keyboard.PressAsync( Time to wait between key presses in milliseconds. Defaults to 0. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Strict` [bool]? *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -4576,7 +4631,6 @@ This method unchecks an element matching `selector` by performing the following 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.Mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4597,7 +4651,12 @@ await Page.UncheckAsync(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `NoWaitAfter` [bool]? *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `Position` Position? *(optional)* Added in: v1.11# - `X` [float] Added in: v1.11# diff --git a/java/docs/api/class-elementhandle.mdx b/java/docs/api/class-elementhandle.mdx index 24442cb379..fd9c8d8d96 100644 --- a/java/docs/api/class-elementhandle.mdx +++ b/java/docs/api/class-elementhandle.mdx @@ -171,7 +171,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -192,7 +191,12 @@ ElementHandle.check(options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)* Added in: v1.11# - `setX` [double] Added in: v1.11# @@ -260,6 +264,11 @@ ElementHandle.click(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -296,7 +305,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -329,7 +337,12 @@ ElementHandle.dblclick(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -528,7 +541,12 @@ ElementHandle.fill(value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -606,7 +624,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -629,7 +646,12 @@ ElementHandle.hover(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -917,6 +939,11 @@ ElementHandle.press(key, options); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setTimeout` [double] *(optional)*# @@ -1140,6 +1167,11 @@ handle.selectOption(new String[] {"red", "green", "blue"}); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setTimeout` [double] *(optional)*# @@ -1203,7 +1235,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1225,7 +1256,12 @@ ElementHandle.setChecked(checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1282,7 +1318,12 @@ ElementHandle.setInputFiles(files, options); - `options` `ElementHandle.SetInputFilesOptions` *(optional)* - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1307,7 +1348,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.touchscreen()](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1334,7 +1374,12 @@ ElementHandle.tap(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1406,7 +1451,12 @@ To press a special key, like `Control` or `ArrowDown`, use [ElementHandle.press( Time to wait between key presses in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1432,7 +1482,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1453,7 +1502,12 @@ ElementHandle.uncheck(options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)* Added in: v1.11# - `setX` [double] Added in: v1.11# diff --git a/java/docs/api/class-filechooser.mdx b/java/docs/api/class-filechooser.mdx index 81b602be61..34282dbef2 100644 --- a/java/docs/api/class-filechooser.mdx +++ b/java/docs/api/class-filechooser.mdx @@ -97,7 +97,12 @@ FileChooser.setFiles(files, options); - `options` `FileChooser.SetFilesOptions` *(optional)* - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/java/docs/api/class-frame.mdx b/java/docs/api/class-frame.mdx index 347043cdff..5eb3da7096 100644 --- a/java/docs/api/class-frame.mdx +++ b/java/docs/api/class-frame.mdx @@ -167,7 +167,12 @@ Frame.dragAndDrop(source, target, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setSourcePosition` SourcePosition *(optional)* Added in: v1.14# - `setX` [double] Added in: v1.14# @@ -1078,7 +1083,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1100,7 +1104,12 @@ Frame.check(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)* Added in: v1.11# - `setX` [double] Added in: v1.11# @@ -1173,6 +1182,11 @@ Frame.click(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1212,8 +1226,7 @@ This method double clicks an element matching `selector` by performing the follo 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM. 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. -1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. +1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1247,7 +1260,12 @@ Frame.dblclick(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1458,7 +1476,12 @@ Frame.fill(selector, value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setStrict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -1564,7 +1587,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1588,7 +1610,12 @@ Frame.hover(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1959,6 +1986,11 @@ Frame.press(selector, key, options); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setStrict` [boolean] *(optional)* Added in: v1.14# @@ -2099,6 +2131,11 @@ frame.selectOption("select#colors", new String[] {"red", "green", "blue"}); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setStrict` [boolean] *(optional)* Added in: v1.14# @@ -2130,7 +2167,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2155,7 +2191,12 @@ Frame.setChecked(selector, checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -2218,7 +2259,12 @@ Frame.setInputFiles(selector, files, options); - `options` `Frame.SetInputFilesOptions` *(optional)* - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setStrict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2247,7 +2293,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.touchscreen()](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2275,7 +2320,12 @@ Frame.tap(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -2366,7 +2416,12 @@ To press a special key, like `Control` or `ArrowDown`, use [Keyboard.press()](/a Time to wait between key presses in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setStrict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2396,7 +2451,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2418,7 +2472,12 @@ Frame.uncheck(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)* Added in: v1.11# - `setX` [double] Added in: v1.11# diff --git a/java/docs/api/class-locator.mdx b/java/docs/api/class-locator.mdx index b89a7b9fc4..81b30a1a4b 100644 --- a/java/docs/api/class-locator.mdx +++ b/java/docs/api/class-locator.mdx @@ -191,7 +191,12 @@ page.getByRole(AriaRole.CHECKBOX).check(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -217,7 +222,6 @@ Performs the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -245,7 +249,12 @@ page.getByRole(AriaRole.TEXTBOX).clear(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -303,6 +312,11 @@ page.locator("canvas").click(new Locator.ClickOptions() Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -410,7 +424,12 @@ Locator.dblclick(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -435,7 +454,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -532,7 +550,12 @@ source.dragTo(target, new Locator.DragToOptions() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setSourcePosition` SourcePosition *(optional)*# - `setX` [double]# @@ -701,7 +724,12 @@ page.getByRole(AriaRole.TEXTBOX).fill("example value"); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1223,7 +1251,12 @@ page.getByRole(AriaRole.LINK).hover(); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1248,7 +1281,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1656,6 +1688,11 @@ page.getByRole(AriaRole.TEXTBOX).press("Backspace"); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setTimeout` [double] *(optional)*# @@ -1719,7 +1756,12 @@ locator.press("Enter"); Time to wait between key presses in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1874,6 +1916,11 @@ element.selectOption(new String[] {"red", "green", "blue"}); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setTimeout` [double] *(optional)*# @@ -1945,7 +1992,12 @@ page.getByRole(AriaRole.CHECKBOX).setChecked(true); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -1972,7 +2024,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2019,7 +2070,12 @@ page.getByLabel("Upload file").setInputFiles(new FilePayload( - `options` `Locator.SetInputFilesOptions` *(optional)* - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -2058,7 +2114,12 @@ Locator.tap(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -2083,7 +2144,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.touchscreen()](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2142,7 +2202,12 @@ page.getByRole(AriaRole.CHECKBOX).uncheck(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -2168,7 +2233,6 @@ This method unchecks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2294,7 +2358,12 @@ To press a special key, like `Control` or `ArrowDown`, use [Locator.press()](/ap Time to wait between key presses in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setTimeout` [double] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [BrowserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [Page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/java/docs/api/class-page.mdx b/java/docs/api/class-page.mdx index 84f5e863db..8c597cbebe 100644 --- a/java/docs/api/class-page.mdx +++ b/java/docs/api/class-page.mdx @@ -354,7 +354,12 @@ page.dragAndDrop("#source", '#target', new Page.DragAndDropOptions() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setSourcePosition` SourcePosition *(optional)* Added in: v1.14# - `setX` [double] Added in: v1.14# @@ -2986,7 +2991,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3008,7 +3012,12 @@ Page.check(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)* Added in: v1.11# - `setX` [double] Added in: v1.11# @@ -3081,6 +3090,11 @@ Page.click(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -3121,7 +3135,6 @@ This method double clicks an element matching `selector` by performing the follo 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3155,7 +3168,12 @@ Page.dblclick(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -3362,7 +3380,12 @@ Page.fill(selector, value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setStrict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -3468,7 +3491,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3492,7 +3514,12 @@ Page.hover(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -3908,6 +3935,11 @@ page.screenshot(new Page.ScreenshotOptions().setPath(Paths.get("O.png" ))); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setStrict` [boolean] *(optional)* Added in: v1.14# @@ -4036,6 +4068,11 @@ page.selectOption("select#colors", new String[] {"red", "green", "blue"}); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `setStrict` [boolean] *(optional)* Added in: v1.14# @@ -4067,7 +4104,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4092,7 +4128,12 @@ Page.setChecked(selector, checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -4155,7 +4196,12 @@ Page.setInputFiles(selector, files, options); - `options` `Page.SetInputFilesOptions` *(optional)* - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setStrict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -4184,7 +4230,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.touchscreen()](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4212,7 +4257,12 @@ Page.tap(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)*# - `setX` [double]# @@ -4303,7 +4353,12 @@ To press a special key, like `Control` or `ArrowDown`, use [Keyboard.press()](/a Time to wait between key presses in milliseconds. Defaults to 0. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setStrict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -4333,7 +4388,6 @@ This method unchecks an element matching `selector` by performing the following 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [Page.mouse()](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4355,7 +4409,12 @@ Page.uncheck(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `setNoWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `setPosition` Position *(optional)* Added in: v1.11# - `setX` [double] Added in: v1.11# diff --git a/nodejs/docs/api/class-elementhandle.mdx b/nodejs/docs/api/class-elementhandle.mdx index 159eb470b1..947175c666 100644 --- a/nodejs/docs/api/class-elementhandle.mdx +++ b/nodejs/docs/api/class-elementhandle.mdx @@ -321,7 +321,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -342,7 +341,12 @@ await elementHandle.check(options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)* Added in: v1.11# - `x` [number] Added in: v1.11# @@ -410,6 +414,11 @@ await elementHandle.click(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Object] *(optional)*# - `x` [number]# @@ -446,7 +455,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -479,7 +487,12 @@ await elementHandle.dblclick(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -588,7 +601,12 @@ await elementHandle.fill(value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -666,7 +684,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -689,7 +706,12 @@ await elementHandle.hover(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -977,6 +999,11 @@ await elementHandle.press(key, options); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [number] *(optional)*# @@ -1144,6 +1171,11 @@ handle.selectOption(['red', 'green', 'blue']); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [number] *(optional)*# @@ -1207,7 +1239,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1229,7 +1260,12 @@ await elementHandle.setChecked(checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -1286,7 +1322,12 @@ await elementHandle.setInputFiles(files, options); - `options` [Object] *(optional)* - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1311,7 +1352,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1338,7 +1378,12 @@ await elementHandle.tap(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -1410,7 +1455,12 @@ To press a special key, like `Control` or `ArrowDown`, use [elementHandle.press( Time to wait between key presses in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1436,7 +1486,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1457,7 +1506,12 @@ await elementHandle.uncheck(options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)* Added in: v1.11# - `x` [number] Added in: v1.11# diff --git a/nodejs/docs/api/class-filechooser.mdx b/nodejs/docs/api/class-filechooser.mdx index de01c17f51..d38d7c2564 100644 --- a/nodejs/docs/api/class-filechooser.mdx +++ b/nodejs/docs/api/class-filechooser.mdx @@ -100,7 +100,12 @@ await fileChooser.setFiles(files, options); - `options` [Object] *(optional)* - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/nodejs/docs/api/class-frame.mdx b/nodejs/docs/api/class-frame.mdx index 926384373d..8cb796fc0d 100644 --- a/nodejs/docs/api/class-frame.mdx +++ b/nodejs/docs/api/class-frame.mdx @@ -162,7 +162,12 @@ await frame.dragAndDrop(source, target, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `sourcePosition` [Object] *(optional)* Added in: v1.14# - `x` [number] Added in: v1.14# @@ -1237,7 +1242,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1259,7 +1263,12 @@ await frame.check(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)* Added in: v1.11# - `x` [number] Added in: v1.11# @@ -1332,6 +1341,11 @@ await frame.click(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Object] *(optional)*# - `x` [number]# @@ -1371,8 +1385,7 @@ This method double clicks an element matching `selector` by performing the follo 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM. 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. -1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. +1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1406,7 +1419,12 @@ await frame.dblclick(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -1531,7 +1549,12 @@ await frame.fill(selector, value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -1637,7 +1660,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1661,7 +1683,12 @@ await frame.hover(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -2032,6 +2059,11 @@ await frame.press(selector, key, options); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2099,6 +2131,11 @@ frame.selectOption('select#colors', 'red', 'green', 'blue'); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -2130,7 +2167,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2155,7 +2191,12 @@ await frame.setChecked(selector, checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -2218,7 +2259,12 @@ await frame.setInputFiles(selector, files, options); - `options` [Object] *(optional)* - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2247,7 +2293,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2275,7 +2320,12 @@ await frame.tap(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -2366,7 +2416,12 @@ To press a special key, like `Control` or `ArrowDown`, use [keyboard.press()](/a Time to wait between key presses in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2396,7 +2451,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2418,7 +2472,12 @@ await frame.uncheck(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)* Added in: v1.11# - `x` [number] Added in: v1.11# diff --git a/nodejs/docs/api/class-locator.mdx b/nodejs/docs/api/class-locator.mdx index 5485703be0..b00c802859 100644 --- a/nodejs/docs/api/class-locator.mdx +++ b/nodejs/docs/api/class-locator.mdx @@ -191,7 +191,12 @@ await page.getByRole('checkbox').check(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -217,7 +222,6 @@ Performs the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -245,7 +249,12 @@ await page.getByRole('textbox').clear(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -304,6 +313,11 @@ await page.locator('canvas').click({ Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Object] *(optional)*# - `x` [number]# @@ -411,7 +425,12 @@ await locator.dblclick(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -436,7 +455,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -533,7 +551,12 @@ await source.dragTo(target, { Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `sourcePosition` [Object] *(optional)*# - `x` [number]# @@ -702,7 +725,12 @@ await page.getByRole('textbox').fill('example value'); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1227,7 +1255,12 @@ await page.getByRole('link').hover(); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -1252,7 +1285,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1660,6 +1692,11 @@ await page.getByRole('textbox').press('Backspace'); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [number] *(optional)*# @@ -1723,7 +1760,12 @@ await locator.press('Enter'); Time to wait between key presses in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1878,6 +1920,11 @@ element.selectOption(['red', 'green', 'blue']); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [number] *(optional)*# @@ -1949,7 +1996,12 @@ await page.getByRole('checkbox').setChecked(true); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -1976,7 +2028,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2029,7 +2080,12 @@ await page.getByLabel('Upload file').setInputFiles({ - `options` [Object] *(optional)* - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -2068,7 +2124,12 @@ await locator.tap(options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -2093,7 +2154,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2152,7 +2212,12 @@ await page.getByRole('checkbox').uncheck(); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -2178,7 +2243,6 @@ This method unchecks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2304,7 +2368,12 @@ To press a special key, like `Control` or `ArrowDown`, use [locator.press()](/ap Time to wait between key presses in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [number] *(optional)*# Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout` option in the config, or by using the [browserContext.setDefaultTimeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.setDefaultTimeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/nodejs/docs/api/class-page.mdx b/nodejs/docs/api/class-page.mdx index 7fb21c30cc..0916c65b4f 100644 --- a/nodejs/docs/api/class-page.mdx +++ b/nodejs/docs/api/class-page.mdx @@ -367,7 +367,12 @@ await page.dragAndDrop('#source', '#target', { Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `sourcePosition` [Object] *(optional)* Added in: v1.14# - `x` [number] Added in: v1.14# @@ -2891,7 +2896,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2913,7 +2917,12 @@ await page.check(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)* Added in: v1.11# - `x` [number] Added in: v1.11# @@ -2986,6 +2995,11 @@ await page.click(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Object] *(optional)*# - `x` [number]# @@ -3026,7 +3040,6 @@ This method double clicks an element matching `selector` by performing the follo 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3060,7 +3073,12 @@ await page.dblclick(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -3185,7 +3203,12 @@ await page.fill(selector, value, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -3291,7 +3314,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3315,7 +3337,12 @@ await page.hover(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -3732,6 +3759,11 @@ await browser.close(); Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -3800,6 +3832,11 @@ page.selectOption('select#colors', ['red', 'green', 'blue']); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [boolean] *(optional)* Added in: v1.14# @@ -3831,7 +3868,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3856,7 +3892,12 @@ await page.setChecked(selector, checked, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -3919,7 +3960,12 @@ await page.setInputFiles(selector, files, options); - `options` [Object] *(optional)* - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -3948,7 +3994,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3976,7 +4021,12 @@ await page.tap(selector, options); Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)*# - `x` [number]# @@ -4067,7 +4117,12 @@ To press a special key, like `Control` or `ArrowDown`, use [keyboard.press()](/a Time to wait between key presses in milliseconds. Defaults to 0. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [boolean] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -4097,7 +4152,6 @@ This method unchecks an element matching `selector` by performing the following 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4119,7 +4173,12 @@ await page.uncheck(selector, options); Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `noWaitAfter` [boolean] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Object] *(optional)* Added in: v1.11# - `x` [number] Added in: v1.11# diff --git a/nodejs/docs/test-assertions.mdx b/nodejs/docs/test-assertions.mdx index d47f0c8516..6d35bd3340 100644 --- a/nodejs/docs/test-assertions.mdx +++ b/nodejs/docs/test-assertions.mdx @@ -304,6 +304,8 @@ test('amount', async () => { }); ``` +### Compatibility with expect library + :::note Do not confuse Playwright's `expect` with the [`expect` library](https://jestjs.io/docs/expect). The latter is not fully integrated with Playwright test runner, so make sure to use Playwright's own `expect`. ::: diff --git a/python/docs/api/class-elementhandle.mdx b/python/docs/api/class-elementhandle.mdx index 04c83cba07..6a94323b7c 100644 --- a/python/docs/api/class-elementhandle.mdx +++ b/python/docs/api/class-elementhandle.mdx @@ -256,7 +256,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -276,7 +275,12 @@ element_handle.check(**kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)* Added in: v1.11# - `x` [float] Added in: v1.11# @@ -343,6 +347,11 @@ element_handle.click(**kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Dict] *(optional)*# - `x` [float]# @@ -379,7 +388,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -411,7 +419,12 @@ element_handle.dblclick(**kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -692,7 +705,12 @@ element_handle.fill(value, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -770,7 +788,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -792,7 +809,12 @@ element_handle.hover(**kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -1078,6 +1100,11 @@ element_handle.press(key, **kwargs) Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [float] *(optional)*# @@ -1311,6 +1338,11 @@ await handle.select_option(value=["red", "green", "blue"]) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [float] *(optional)*# @@ -1385,7 +1417,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1406,7 +1437,12 @@ element_handle.set_checked(checked, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -1462,7 +1498,12 @@ element_handle.set_input_files(files, **kwargs) File content - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1487,7 +1528,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1513,7 +1553,12 @@ element_handle.tap(**kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -1584,7 +1629,12 @@ To press a special key, like `Control` or `ArrowDown`, use [element_handle.press Time to wait between key presses in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1610,7 +1660,6 @@ This method checks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -1630,7 +1679,12 @@ element_handle.uncheck(**kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)* Added in: v1.11# - `x` [float] Added in: v1.11# diff --git a/python/docs/api/class-filechooser.mdx b/python/docs/api/class-filechooser.mdx index 40f4a1615d..526e4ff9bb 100644 --- a/python/docs/api/class-filechooser.mdx +++ b/python/docs/api/class-filechooser.mdx @@ -70,7 +70,12 @@ file_chooser.set_files(files, **kwargs) File content - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/python/docs/api/class-frame.mdx b/python/docs/api/class-frame.mdx index 4748b0dd07..265d6288c3 100644 --- a/python/docs/api/class-frame.mdx +++ b/python/docs/api/class-frame.mdx @@ -185,7 +185,12 @@ frame.drag_and_drop(source, target, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `source_position` [Dict] *(optional)* Added in: v1.14# - `x` [float] Added in: v1.14# @@ -1517,7 +1522,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1538,7 +1542,12 @@ frame.check(selector, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)* Added in: v1.11# - `x` [float] Added in: v1.11# @@ -1610,6 +1619,11 @@ frame.click(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Dict] *(optional)*# - `x` [float]# @@ -1649,8 +1663,7 @@ This method double clicks an element matching `selector` by performing the follo 1. Find an element matching `selector`. If there is none, wait until a matching element is attached to the DOM. 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. -1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. +1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -1683,7 +1696,12 @@ frame.dblclick(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2042,7 +2060,12 @@ frame.fill(selector, value, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [bool] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2146,7 +2169,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2169,7 +2191,12 @@ frame.hover(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2531,6 +2558,11 @@ frame.press(selector, key, **kwargs) Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [bool] *(optional)* Added in: v1.14# @@ -2682,6 +2714,11 @@ await frame.select_option("select#colors", value=["red", "green", "blue"]) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [bool] *(optional)* Added in: v1.14# @@ -2725,7 +2762,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2749,7 +2785,12 @@ frame.set_checked(selector, checked, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2811,7 +2852,12 @@ frame.set_input_files(selector, files, **kwargs) File content - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [bool] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2840,7 +2886,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2867,7 +2912,12 @@ frame.tap(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2956,7 +3006,12 @@ To press a special key, like `Control` or `ArrowDown`, use [keyboard.press()](/a Time to wait between key presses in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [bool] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -2986,7 +3041,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3007,7 +3061,12 @@ frame.uncheck(selector, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)* Added in: v1.11# - `x` [float] Added in: v1.11# diff --git a/python/docs/api/class-locator.mdx b/python/docs/api/class-locator.mdx index 4acdb48aaf..d0eacdcd7b 100644 --- a/python/docs/api/class-locator.mdx +++ b/python/docs/api/class-locator.mdx @@ -310,7 +310,12 @@ await page.get_by_role("checkbox").check() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -336,7 +341,6 @@ Performs the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -383,7 +387,12 @@ await page.get_by_role("textbox").clear() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -481,6 +490,11 @@ await page.locator("canvas").click( Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Dict] *(optional)*# - `x` [float]# @@ -583,7 +597,12 @@ locator.dblclick(**kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -608,7 +627,6 @@ This method double clicks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. If the element is detached from the DOM at any moment during the action, this method throws. @@ -775,7 +793,12 @@ await source.drag_to( Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `source_position` [Dict] *(optional)*# - `x` [float]# @@ -1003,7 +1026,12 @@ await page.get_by_role("textbox").fill("example value") Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -1711,7 +1739,12 @@ await page.get_by_role("link").hover() Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -1736,7 +1769,6 @@ This method hovers over the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2304,6 +2336,11 @@ await page.get_by_role("textbox").press("Backspace") Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [float] *(optional)*# @@ -2409,7 +2446,12 @@ await locator.press("Enter") Time to wait between key presses in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -2612,6 +2654,11 @@ await element.select_option(value=["red", "green", "blue"]) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `timeout` [float] *(optional)*# @@ -2713,7 +2760,12 @@ await page.get_by_role("checkbox").set_checked(True) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2740,7 +2792,6 @@ This method checks or unchecks an element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -2826,7 +2877,12 @@ await page.get_by_label("Upload file").set_input_files( File content - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. @@ -2864,7 +2920,12 @@ locator.tap(**kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2889,7 +2950,6 @@ This method taps the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. If the element is detached from the DOM at any moment during the action, this method throws. @@ -2966,7 +3026,12 @@ await page.get_by_role("checkbox").uncheck() Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -2992,7 +3057,6 @@ This method unchecks the element by performing the following steps: 1. Wait for [actionability](../actionability.mdx) checks on the element, unless `force` option is set. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. If the element is detached from the DOM at any moment during the action, this method throws. @@ -3256,7 +3320,12 @@ To press a special key, like `Control` or `ArrowDown`, use [locator.press()](/ap Time to wait between key presses in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `timeout` [float] *(optional)*# Maximum time in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default value can be changed by using the [browser_context.set_default_timeout()](/api/class-browsercontext.mdx#browser-context-set-default-timeout) or [page.set_default_timeout()](/api/class-page.mdx#page-set-default-timeout) methods. diff --git a/python/docs/api/class-page.mdx b/python/docs/api/class-page.mdx index 563d72f23e..0240df8082 100644 --- a/python/docs/api/class-page.mdx +++ b/python/docs/api/class-page.mdx @@ -523,7 +523,12 @@ await page.drag_and_drop( Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `source_position` [Dict] *(optional)* Added in: v1.14# - `x` [float] Added in: v1.14# @@ -3932,7 +3937,6 @@ This method checks an element matching `selector` by performing the following st 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -3953,7 +3957,12 @@ page.check(selector, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)* Added in: v1.11# - `x` [float] Added in: v1.11# @@ -4025,6 +4034,11 @@ page.click(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `position` [Dict] *(optional)*# - `x` [float]# @@ -4065,7 +4079,6 @@ This method double clicks an element matching `selector` by performing the follo 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to double click in the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. Note that if the first click of the `dblclick()` triggers a navigation event, this method will throw. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4098,7 +4111,12 @@ page.dblclick(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -4455,7 +4473,12 @@ page.fill(selector, value, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [bool] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -4559,7 +4582,6 @@ This method hovers over an element matching `selector` by performing the followi 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to hover over the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -4582,7 +4604,12 @@ page.hover(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)* Added in: v1.28# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -5017,6 +5044,11 @@ await browser.close() Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [bool] *(optional)* Added in: v1.14# @@ -5156,6 +5188,11 @@ await page.select_option("select#colors", value=["red", "green", "blue"]) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# + :::warning[Deprecated] + This option will default to `true` in the future. + ::: + + Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. - `strict` [bool] *(optional)* Added in: v1.14# @@ -5199,7 +5236,6 @@ This method checks or unchecks an element matching `selector` by performing the 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now checked or unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -5223,7 +5259,12 @@ page.set_checked(selector, checked, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -5285,7 +5326,12 @@ page.set_input_files(selector, files, **kwargs) File content - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [bool] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -5314,7 +5360,6 @@ This method taps an element matching `selector` by performing the following step 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.touchscreen](/api/class-page.mdx#page-touchscreen) to tap the center of the element, or the specified `position`. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -5341,7 +5386,12 @@ page.tap(selector, **kwargs) Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)*# - `x` [float]# @@ -5430,7 +5480,12 @@ To press a special key, like `Control` or `ArrowDown`, use [keyboard.press()](/a Time to wait between key presses in milliseconds. Defaults to 0. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `strict` [bool] *(optional)* Added in: v1.14# When true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception. @@ -5460,7 +5515,6 @@ This method unchecks an element matching `selector` by performing the following 1. Wait for [actionability](../actionability.mdx) checks on the matched element, unless `force` option is set. If the element is detached during the checks, the whole action is retried. 1. Scroll the element into view if needed. 1. Use [page.mouse](/api/class-page.mdx#page-mouse) to click in the center of the element. -1. Wait for initiated navigations to either succeed or fail, unless `no_wait_after` option is set. 1. Ensure that the element is now unchecked. If not, this method throws. When all steps combined have not finished during the specified `timeout`, this method throws a [TimeoutError]. Passing zero timeout disables this. @@ -5481,7 +5535,12 @@ page.uncheck(selector, **kwargs) Whether to bypass the [actionability](../actionability.mdx) checks. Defaults to `false`. - `no_wait_after` [bool] *(optional)*# - Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. Defaults to `false`. + :::warning[Deprecated] + This option has no effect. + ::: + + + This option has no effect. - `position` [Dict] *(optional)* Added in: v1.11# - `x` [float] Added in: v1.11#