WWW::Selenium(3pm)

📦

version 1.36 · 4 versions

1.36 · debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
1.36 · fedora 43
1.36 · ubuntu jammy
1.36 · fedora 44

, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 WWW::Selenium(3pm) — User Contributed Perl Documentation 💖

okay bestie, welcome to WWW::Selenium(3pm), the User Contributed Perl Documentation page that's about to make your Selenium Remote Control era iconic. no cap, we're keeping every single locator, flag, pattern, and method right here. let's get into it 💅

✨ NAME ✨

WWW::Selenium — Perl Client for the Selenium Remote Control test tool

🌟 VERSION 🌟

version 1.36

🦋 SYNOPSIS 🦋

here's the vibe check, bestie — this is how you spin up the whole thing:

           use WWW::Selenium;

           my $sel = WWW::Selenium->new( host => "localhost",
                                         port => 4444,
                                         browser => "*iexplore",
                                         browser_url => "http://www.google.com",
                                       );

           $sel->start;
           $sel->open("http://www.google.com");
           $sel->type("q", "hello world");
           $sel->click("btnG");
           $sel->wait_for_page_to_load(5000);
           print $sel->get_title;
           $sel->stop;

🌈 DESCRIPTION 🌈

Selenium Remote Control (SRC) is literally the test tool that lets you write automated web application UI tests in any programming language against any HTTP website using any mainstream JavaScript-enabled browser. SRC gives you a Selenium Server that can automatically start/stop/control any supported browser. The way it works? It uses Selenium Core, a pure-HTML+JS library that performs automated tasks in JavaScript; and the Selenium Server communicates directly with the browser using AJAX (XmlHttpRequest). it's giving remote control, periodt.

<http://www.openqa.org/selenium-rc/>

This module is the bestie that sends commands directly to the Server using simple HTTP GET/POST requests. Team it up with the Selenium Server, and boom — you can automatically control any supported browser.

Important: to use this module, you need to have already downloaded and started the Selenium Server. (Yes, the Selenium Server is a Java application. slay.)

🧭 Element Locators 🧭

Element Locators tell Selenium which HTML element a command refers to. The format of a locator is exactly this:

locatorType=argument

We support the following strategies for locating elements:

identifier=id — picks the element with the specified @id attribute. If no match is found, it selects the first element whose @name attribute is id. (This is normally the default; see below.) lowkey the fallback queen.
id=id — selects the element with the specified @id attribute. simple.
name=name — selects the first element with the specified @name attribute.
- username
- name=username

The name may optionally be followed by one or more element-filters, separated from the name by whitespace. If the filterType is not specified, value is assumed.

name=flavour value=chocolate

dom=javascriptExpression — finds an element by evaluating the specified string. This lets you traverse the HTML Document Object Model using JavaScript. Note that you must not return a value in this string; simply make it the last expression in the block. iykyk.
- dom=document.forms['myForm'].myDropdown
- dom=document.images[56]
- dom=function foo() { return document.links[1]; }; foo();
xpath=xpathExpression — locates an element using an XPath expression. periodt.
- xpath=//img[@alt='The image alt text']
- xpath=//table[@id='table1']//tr[4]/td[2]
- xpath=//a[contains(@href,'#id1')]
- xpath=//a[contains(@href,'#id1')]/@class
- xpath=(//table[@class='stylee'])//th[text()='theHeaderText']/../td
- xpath=//input[@name='name2' and @value='yes']
- xpath=//*[text()="right"]
link=textPattern — selects the link (anchor) element which contains text matching the specified pattern.
- link=The link text
css=cssSelectorSyntax — selects the element using css selectors. Please refer to http://www.w3.org/TR/REC-CSS2/selector.html (CSS2 selectors), http://www.w3.org/TR/2001/CR-css3-selectors-20011113/ (CSS3 selectors) for more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.
- css=a[href="#id3"]
- css=span#firstChild + span

Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after).

ui=uiSpecifierString — locates an element by resolving the UI specifier string to another locator, and evaluating it. See the http://svn.openqa.org/fisheye/browse/~raw,r=trunk/selenium/trunk/src/main/resources/core/scripts/ui-doc.html (Selenium UI-Element Reference) for more details.
- ui=loginPages::loginButton()
- ui=settingsPages::toggle(label=Hide Email)
- ui=forumPages::postBody(index=2)//a[2]

Without an explicit locator prefix, Selenium uses the following default strategies:

dom, for locators starting with "document."
xpath, for locators starting with "//"
identifier, otherwise

🧼 Element Filters 🧼

Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.

Filters look much like locators, ie.

filterType=argument

Supported element-filters are:

value=valuePattern — Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.
index=index — Selects a single element based on its position in the list (offset from zero).

🎀 String-match Patterns 🎀

Various Pattern syntaxes are available for matching string values:

glob:pattern — Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a kind of limited regular-expression syntax typically used in command-line shells. In a glob pattern, "*" represents any sequence of characters, and "?" represents any single character. Glob patterns match against the entire string.
regexp:regexp — Match a string using a regular-expression. The full power of JavaScript regular-expressions is available.
regexpi:regexpi — Match a string using a case-insensitive regular-expression.
exact:string — Match a string exactly, verbatim, without any of that fancy wildcard stuff.

If no pattern prefix is specified, Selenium assumes that it's a "glob" pattern.

For commands that return multiple values (such as verifySelectOptions), the string being matched is a comma-separated list of the return values, where both commas and backslashes in the values are backslash-escaped. When providing a pattern, the optional matching syntax (i.e. glob, regexp, etc.) is specified once, as usual, at the beginning of the pattern.

👑 METHODS 👑

The following methods are available:

`$sel = WWW::Selenium->new( %args )`

Constructs a new "WWW::Selenium" object, specifying a Selenium Server host/port, a command to launch the browser, and a starting URL for the browser.

Options:

"host" — host is the host name on which the Selenium Server resides.
"port" — port is the port on which the Selenium Server is listening.
"browser_url" — browser_url is the starting URL including just a domain name. We'll start the browser pointing at the Selenium resources on this URL, e.g. "http://www.google.com" would send the browser to "http://www.google.com/selenium-server/SeleneseRunner.html"
"browser" or "browser_start_command" — This is the command string used to launch the browser, e.g. "*firefox", "*iexplore" or "/usr/bin/firefox"

This option may be any one of the following:

"*firefox [absolute path]" — Automatically launch a new Firefox process using a custom Firefox profile. This profile will be automatically configured to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify an absolute path to your firefox executable, or just say "*firefox". If no absolute path is specified, we'll look for firefox.exe in a default location (normally c:\program files\mozilla firefox\firefox.exe), which you can override by setting the Java system property "firefoxDefaultPath" to the correct path to Firefox.
"*iexplore [absolute path]" — Automatically launch a new Internet Explorer process using custom Windows registry settings. This process will be automatically configured to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify an absolute path to your iexplore executable, or just say "*iexplore". If no absolute path is specified, we'll look for iexplore.exe in a default location (normally c:\program files\internet explorer\iexplore.exe), which you can override by setting the Java system property "iexploreDefaultPath" to the correct path to Internet Explorer.
"/path/to/my/browser [other arguments]" — You may also simply specify the absolute path to your browser executable, or use a relative path to your executable (which we'll try to find on your path). Warning: If you specify your own custom browser, it's up to you to configure it correctly. At a minimum, you'll need to configure your browser to use the Selenium Server as a proxy, and disable all browser-specific prompting.

"auto_stop" — Defaults to true, and will attempt to close the browser if the object goes out of scope and stop hasn't been called.
"keep_alive" — Number of connections LWP should cache. This is just a minor speed improvement. Defaults to 5.
"http_method"> — Choose which HTTP method should be used for requests to the Selenium server. Only GET and POST are supported.

`$sel->pause($timeout)`

Waits $timeout milliseconds (default: 1 second)

`$sel->click($locator)`

Clicks on a link, button, checkbox or radio button. If the click action causes a new page to load (like a link usually does), call waitForPageToLoad.

`$sel->double_click($locator)`

Double clicks on a link, button, checkbox or radio button. 💅 If that double click makes a new page load (which is literally what links do, bestie), then you gotta call waitForPageToLoad.

$locator — an element locator

`$sel->context_menu($locator)`

Simulates opening the context menu for the element you point at — like when a user right-clicks on it. 🖱️

$locator — an element locator

`$sel->click_at($locator, $coord_string)`

Clicks on a link, button, checkbox or radio button. Again, if the click makes a new page load (very link of it), call waitForPageToLoad. ✨

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->double_click_at($locator, $coord_string)`

Double clicks on a link, button, checkbox or radio button. Same deal: if the action makes a new page load, call waitForPageToLoad. 💖

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->context_menu_at($locator, $coord_string)`

Simulates opening the context menu for the specified element, like the user right-clicked it. 🫶

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->fire_event($locator, $event_name)`

Explicitly simulates an event, so it triggers the matching onevent handler. 🔥

$locator — an element locator
$event_name — the event name, e.g. "focus" or "blur"

`$sel->focus($locator)`

Moves the focus to the specified element. So if it's an input field, the cursor lands right in that field. 🎯

$locator — an element locator

`$sel->key_press($locator, $key_sequence)`

Simulates a user pressing and releasing a key. ⌨️

$locator — an element locator
$key_sequence — either a string ("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

`$sel->shift_key_down()`

Presses the shift key and holds it down until doShiftUp() is called or a new page loads. ⬆️

`$sel->shift_key_up()`

Releases the shift key. 🌸

`$sel->meta_key_down()`

Presses the meta key and holds it down until doMetaUp() is called or a new page loads. 💫

`$sel->meta_key_up()`

Releases the meta key. 🌈

`$sel->alt_key_down()`

Presses the alt key and holds it down until doAltUp() is called or a new page loads. ⭐

`$sel->alt_key_up()`

Releases the alt key. 💜

`$sel->control_key_down()`

Presses the control key and holds it down until doControlUp() is called or a new page loads. 🎀

`$sel->control_key_up()`

Releases the control key. ✨

`$sel->key_down($locator, $key_sequence)`

Simulates a user pressing a key — and not letting go yet. 👑

$locator — an element locator
$key_sequence — either a string ("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

`$sel->key_up($locator, $key_sequence)`

Simulates a user releasing a key. 🦋

$locator — an element locator
$key_sequence — either a string ("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".

`$sel->mouse_over($locator)`

Simulates a user hovering a mouse over the specified element. 🖱️✨

$locator — an element locator

`$sel->mouse_out($locator)`

Simulates a user moving the mouse pointer away from the specified element. 👋

$locator — an element locator

`$sel->mouse_down($locator)`

Simulates a user pressing the left mouse button (without releasing it yet) on the specified element. 🖱️

$locator — an element locator

`$sel->mouse_down_right($locator)`

Simulates a user pressing the right mouse button (without releasing it yet) on the specified element. 🖱️👉

$locator — an element locator

`$sel->mouse_down_at($locator, $coord_string)`

Simulates a user pressing the left mouse button (without releasing it yet) at the specified location. 📍

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->mouse_down_right_at($locator, $coord_string)`

Simulates a user pressing the right mouse button (without releasing it yet) at the specified location. 📍💅

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->mouse_up($locator)`

Simulates the event that happens when the user releases the mouse button (i.e. stops holding the button down) on the specified element. 🫶

$locator — an element locator

`$sel->mouse_up_right($locator)`

Simulates the event that happens when the user releases the right mouse button (i.e. stops holding the button down) on the specified element. 🫶👉

$locator — an element locator

`$sel->mouse_up_at($locator, $coord_string)`

Simulates the event that happens when the user releases the mouse button (i.e. stops holding the button down) at the specified location. 📍

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->mouse_up_right_at($locator, $coord_string)`

Simulates the event that happens when the user releases the right mouse button (i.e. stops holding the button down) at the specified location. 📍🌸

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->mouse_move($locator)`

Simulates a user pressing the mouse button (without releasing it yet) on the specified element. 🖱️

$locator — an element locator

`$sel->mouse_move_at($locator, $coord_string)`

Simulates a user pressing the mouse button (without releasing it yet) on the specified element. 🖱️📍

$locator — an element locator
$coord_string — specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

`$sel->type($locator, $value)`

Sets the value of an input field, like you literally typed it in yourself. ⌨️💖 It also works for setting the value of combo boxes, check boxes, etc. — but heads up, in those cases $value should be the value of the option selected, not the visible text. 👀

$locator — an element locator
$value — the value to type

`$sel->type_keys($locator, $value)`

Simulates keystroke events on the specified element, as though you typed the value key-by-key. 🎹 This is a convenience method that calls keyDown, keyUp and keyPress for every character in the string you pass — which is super useful for dynamic UI widgets (like auto-completing combo boxes) that need explicit key events. 🔥

Unlike the simple type command, which forces the specified value straight into the page, this command may or may not have any visible effect — even in cases where typing keys would normally have a visible effect. For example, if you use typeKeys on a form element, you may or may not see the results of what you typed in the field. 😭

In some cases, you may need to use the simple type command to set the value of the field, and then the typeKeys command to send the keystroke events corresponding to what you just typed. 💡

$locator — an element locator
$value — the value to type

`$sel->set_speed($value)`

Set execution speed — i.e. set the millisecond length of a delay that will follow each selenium operation. ⏱️ By default there is no such delay, i.e. the delay is 0 milliseconds.

$value — the number of milliseconds to pause after operation

`$sel->get_speed()`

Get execution speed — i.e. get the millisecond length of the delay following each selenium operation. ⏱️✨ By default there is no such delay, i.e. the delay is 0 milliseconds. See also setSpeed.

Returns the execution speed in milliseconds.

`$sel->check($locator)`

Checks a toggle-button (checkbox/radio). ✅

$locator — an element locator

`$sel->uncheck($locator)`

Unchecks a toggle-button (checkbox/radio). ❌

$locator — an element locator

`$sel->select($select_locator, $option_locator)`

Selects an option from a drop-down using an option locator. 🌈 Option locators give you different ways of specifying options of an HTMLSelect element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator, bestie:

label=labelPattern: matches options based on their labels, i.e. the visible text. (This is the default.)
- label=regexp:^[Oo]ther
value=valuePattern: matches options based on their values.
- value=other
id=id: matches options based on their ids.
- id=option1
index=index: matches an option based on its index (offset from zero).
- index=2

If no option locator prefix is provided, the default behaviour is to match on label. 💅

$select_locator — an element locator identifying a drop-down menu
$option_locator — an option locator (a label by default)

`$sel->add_selection($locator, $option_locator)`

Adds a selection to the set of selected options in a multi-select element using an option locator. @see #doSelect for details of option locators. 🎀

$locator — an element locator identifying a multi-select box
$option_locator — an option locator (a label by default)

`$sel->remove_selection($locator, $option_locator)`

Removes a selection from the set of selected options in a multi-select element using an option locator. @see #doSelect for details of option locators. 🦋

$locator — an element locator identifying a multi-select box
$option_locator — an option locator (a label by default)

`$sel->remove_all_selections($locator)`

Unselects all of the selected options in a multi-select element. 💀🧹

$locator is an element locator identifying a multi-select box 🫶

$sel->submit($form_locator) — Submit the specified form. Highkey a lifesaver for forms that have no submit button at all, like those single-input "Search" boxes that just vibe there and hope you press Enter ✨

$form_locator is an element locator for the form you want to submit

$sel->open($url) — Opens an URL in the test frame. Bestie it takes both relative and absolute URLs, no judgment 💅 The open command waits for the page to load before proceeding, ie. the AndWait suffix is implicit — so don't go adding it yourself, she already did that.

Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain. fr fr, no sneaking around this one 😭

$url is the URL to open; may be relative or absolute

$sel->open_window($url, $window_id) — Opens a popup window (if a window with that ID isn't already open 👀). After opening the window, you'll need to select it using the selectWindow command. This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow") ✨

$url is the URL to open, which can be blank

$window_id is the JavaScript window ID of the window to select

$sel->select_window($window_id) — Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target. Window locators provide different ways of specifying the window object: by title, by internal JavaScript "name," or by JavaScript variable. Slay, options 💅
- title=My Special Window: Finds the window using the text that appears in the title bar. Be careful — two windows can share the same title. If that happens, this locator will just pick one. 🙈
- name=myWindow: Finds the window using its internal JavaScript "name" property. This is the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which Selenium intercepts).
- var=variableName: Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using "var=foo" ✨

If no window locator prefix is provided, we'll try to guess what you mean like this:

if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).
if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method.
Otherwise, selenium looks in a hash it maintains that maps string names to window "names".
If that fails, we'll try looping over all of the known windows to try to find the appropriate "title". Since "title" is not necessarily unique, this may have unexpected behavior. bestie, unpredictable is the vibe here and not in a cute way 💀

If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages like the following for each window as it is opened:

"debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow""

In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) url, like this: openWindow("", "myFunnyWindow").

$window_id is the JavaScript window ID of the window to select

$sel->select_pop_up($window_id) — Simplifies the process of selecting a popup window (and does not offer functionality beyond what "selectWindow()" already provides). It's giving convenience, not new powers ✨
- If "windowID" is either not specified, or specified as "null", the first non-top window is selected. The top window is the one that would be selected by "selectWindow()" without providing a "windowID". This should not be used when more than one popup window is in play. 😭
- Otherwise, the window will be looked up considering "windowID" as the following in order: 1) the "name" of the window, as specified to "window.open()"; 2) a javascript variable which is a reference to a window; and 3) the title of the window. This is the same ordered lookup performed by "selectWindow".

$window_id is an identifier for the popup window, which can take on a number of different meanings

$sel->deselect_pop_up() — Selects the main window. Functionally equivalent to using "selectWindow()" and specifying no value for "windowID". Back to home base, periodt 🏠
$sel->select_frame($locator) — Selects a frame within the current window. (You may invoke this command multiple times to select nested frames. 🪆) To select the parent frame, use "relative=parent" as a locator; to select the top frame, use "relative=top". You can also select a frame by its 0-based index number; select the first frame with "index=0", or the third frame with "index=2". You may also use a DOM expression to identify the frame you want directly, like this: "dom=frames["main"].frames["subframe"]" — iconic tbh 💅

$locator is an element locator identifying a frame or iframe

$sel->get_whether_this_frame_match_frame_expression($current_frame_string, $target) — Determine whether current/locator identify the frame containing this running code. This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" frame. In this case, when the test calls selectFrame, this routine is called for each frame to figure out which one has been selected. The selected frame will return true, while all others will return false 👑

$current_frame_string is starting frame

$target is new frame (which might be relative to the current one)

Returns true if the new frame is this code's window

$sel->get_whether_this_window_match_window_expression($current_window_string, $target) — Determine whether currentWindowString plus target identify the window containing this running code. This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" window. In this case, when the test calls selectWindow, this routine is called for each window to figure out which one has been selected. The selected window will return true, while all others will return false ✨

$current_window_string is starting window

$target is new window (which might be relative to the current one, e.g., "_parent")

Returns true if the new window is this code's window

$sel->wait_for_pop_up($window_id, $timeout) — Waits for a popup window to appear and load up. Patience era 🧘‍♀️

$window_id is the JavaScript window "name" of the window that will appear (not the text of the title bar). If unspecified, or specified as "null", this command will wait for the first non-top window to appear (don't rely on this if you are working with multiple popups simultaneously).

$timeout is a timeout in milliseconds, after which the action will return with an error. If this value is not specified, the default Selenium timeout will be used. See the setTimeout() command.

$sel->choose_cancel_on_next_confirmation() — By default, Selenium's overridden window.confirm() function will return true, as if the user had manually clicked OK; after running this command, the next call to confirm() will return false, as if the user had clicked Cancel. Selenium will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation.

Take note — every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail. no skipping, bestie, that's how you get a red test run 😭

$sel->choose_ok_on_next_confirmation() — Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn't need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.

Take note — every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail. same warning, still true 💜

$sel->answer_on_next_prompt($answer) — Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. Scripting the dialogue, main character energy 👑

$answer is the answer to give in response to the prompt pop-up

$sel->go_back() — Simulates the user clicking the "back" button on their browser. ⬅️
$sel->refresh() — Simulates the user clicking the "Refresh" button on their browser. 🔄
$sel->close() — Simulates the user clicking the "close" button in the titlebar of a popup window or tab. bye bye window 👋
$sel->is_alert_present() — Has an alert occurred? This function never throws an exception 🫶

Returns true if there is an alert

$sel->is_prompt_present() — Has a prompt occurred? This function never throws an exception 🫶

Returns true if there is a pending prompt

$sel->is_confirmation_present() — Has confirm() been called? This function never throws an exception 🫶
Returns true if there's a pending confirmation 💖

$sel->get_alert() — ok so this one snags the message of a JavaScript alert that got generated during the previous action, and it will fail if there were no alerts at all 😭

Getting an alert has the exact same effect as manually clicking OK. And heads up bestie: if an alert is generated but you don't consume it with getAlert, the next Selenium action will fail. no cap 🫠

Under Selenium, JavaScript alerts will NOT pop up a visible alert dialog.

Selenium does NOT support JavaScript alerts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK. 💀

Returns the message of the most recent JavaScript alert ⭐

$sel->get_confirmation() — pulls the message of a JavaScript confirmation dialog that got generated during the previous action 🎀

By default, the confirm function will return true, which has the same effect as manually clicking OK. You can change that by running the chooseCancelOnNextConfirmation command beforehand. 👑

If a confirmation is generated but you don't consume it with getConfirmation, the next Selenium action will fail.

NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog.

NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK. 😭

Returns the message of the most recent JavaScript confirmation dialog ✨

$sel->get_prompt() — grabs the message of a JavaScript question prompt dialog that got generated during the previous action 🌸

Successfully handling the prompt requires running the answerOnNextPrompt command beforehand. If a prompt is generated but you don't get/verify it, the next Selenium action will fail. fr fr.

NOTE: under Selenium, JavaScript prompts will NOT pop up a visible dialog.

NOTE: Selenium does NOT support JavaScript prompts that are generated in a page's onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK. 🦋

Returns the message of the most recent JavaScript question prompt 💜

$sel->get_location() — gets the absolute URL of the current page. that's it, that's the whole vibe 🔥
- Returns the absolute URL of the current page
$sel->get_title() — gets the title of the current page 🎀
- Returns the title of the current page
$sel->get_body_text() — gets the entire text of the page. all of it. every last crumb 🍓
- Returns the entire text of the page
$sel->get_value($locator) — gets the (whitespace-trimmed) value of an input field, or honestly anything else that has a value parameter 💅

For checkbox/radio elements, the value will be "on" or "off" depending on whether the element is checked or not.

$locator is an element locator
Returns the element value, or "on/off" for checkbox/radio elements

$sel->get_text($locator) — gets the text of an element, and it works for any element that contains text 🙌

This command uses either the textContent (Mozilla-like browsers) or the innerText (IE-like browsers) of the element, which is the rendered text shown to the user.

$locator is an element locator
Returns the text of the element ⭐

$sel->highlight($locator) — briefly changes the backgroundColor of the specified element to yellow 🟡 sooo useful for debugging, iconic behaviour honestly
- $locator is an element locator
$sel->get_eval($script) — gets the result of evaluating the specified JavaScript snippet 👑

The snippet may have multiple lines, but only the result of the last line will be returned. Note that, by default, the snippet will run in the context of the "selenium" object itself, so "this" will refer to the Selenium object. Use "window" to refer to the window of your application, e.g. window.document.getElementById('foo') ✨

If you need to use a locator to refer to a single element in your application page, you can use this.browserbot.findElement("id=foo") where "id=foo" is your locator. 💖

$script is the JavaScript snippet to run
Returns the results of evaluating the snippet

$sel->is_checked($locator) — tells you whether a toggle-button (checkbox/radio) is checked ✅

It fails if the specified element doesn't exist or isn't a toggle-button. 🙈

$locator is an element locator pointing to a checkbox or radio button
Returns true if the checkbox is checked, false otherwise

$sel->get_table($table_cell_address) — gets the text from a cell of a table 🎀

The cellAddress syntax is tableLocator.row.column, where row and column start at 0.

$table_cell_address is a cell address, e.g. "foo.1.4"
Returns the text from the specified cell

$sel->get_selected_labels($select_locator) — gets all option labels (the visible text) for the selected options in the specified select or multi-select element 💅
- $select_locator is an element locator identifying a drop-down menu
- Returns an array of all selected option labels in the specified select drop-down
$sel->get_selected_label($select_locator) — gets the option label (visible text) for the selected option in the specified select element ✨
- $select_locator is an element locator identifying a drop-down menu
- Returns the selected option label in the specified select drop-down
$sel->get_selected_values($select_locator) — gets all option values (the value attributes) for the selected options in the specified select or multi-select element 🌈
- $select_locator is an element locator identifying a drop-down menu
- Returns an array of all selected option values in the specified select drop-down
$sel->get_selected_value($select_locator) — gets the option value (value attribute) for the selected option in the specified select element ⭐
- $select_locator is an element locator identifying a drop-down menu
- Returns the selected option value in the specified select drop-down
$sel->get_selected_indexes($select_locator) — gets all option indexes (option number, starting at 0) for the selected options in the specified select or multi-select element 🔢
- $select_locator is an element locator identifying a drop-down menu
- Returns an array of all selected option indexes in the specified select drop-down
$sel->get_selected_index($select_locator) — gets the option index (option number, starting at 0) for the selected option in the specified select element 👑
- $select_locator is an element locator identifying a drop-down menu
- Returns the selected option index in the specified select drop-down
$sel->get_selected_ids($select_locator) — gets all option element IDs for the selected options in the specified select or multi-select element 🆔
- $select_locator is an element locator identifying a drop-down menu
- Returns an array of all selected option IDs in the specified select drop-down
$sel->get_selected_id($select_locator) — gets the option element ID for the selected option in the specified select element 💜
- $select_locator is an element locator identifying a drop-down menu
- Returns the selected option ID in the specified select drop-down
$sel->is_something_selected($select_locator) — figures out whether some option in a drop-down menu is selected 👀
- $select_locator is an element locator identifying a drop-down menu
- Returns true if some option has been selected, false otherwise
$sel->get_select_options($select_locator) — gets all option labels in the specified select drop-down 🌸
- $select_locator is an element locator identifying a drop-down menu
- Returns an array of all option labels in the specified select drop-down
$sel->get_attribute($attribute_locator) — gets the value of an element attribute 🎀

And bestie, listen: the value of the attribute may differ across browsers — this is the case for the "style" attribute, for example. 😭

$attribute_locator is an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
Returns the value of the specified attribute

$sel->is_text_present($pattern) — verifies that the specified text pattern appears somewhere on the rendered page shown to the user 🔍
- $pattern is a pattern to match with the text of the page
- Returns true if the pattern matches the text, false otherwise
$sel->is_element_present($locator) — verifies that the specified element is somewhere on the page 🦋
- $locator is an element locator
- Returns true if the element is present, false otherwise
$sel->is_visible($locator) — determines if the specified element is visible 👀

An element can be rendered invisible by setting the CSS "visibility" property to "hidden", or the "display" property to "none", either for the element itself or one of its ancestors. This method will fail if the element is not present. 💀

$locator is an element locator
Returns true if the specified element is visible, false otherwise

$sel->is_editable($locator) — determines whether the specified input element is editable, i.e. hasn't been disabled ✏️

This method will fail if the specified element isn't an input element. 🙈

$locator is an element locator
Returns true if the input element is editable, false otherwise

$sel->get_all_buttons() — returns the IDs of all buttons on the page 🔘

If a given button has no ID, it will appear as "" in this array.

Returns the IDs of all buttons on the page

$sel->get_all_links() — returns the IDs of all links on the page 🔗

If a given link has no ID, it will appear as "" in this array.

Returns the IDs of all links on the page

$sel->get_all_fields() — returns the IDs of all input fields on the page 📝

If a given field has no ID, it will appear as "" in this array.

Returns the IDs of all field on the page

$sel->get_attribute_from_all_windows($attribute_name) — returns an array of JavaScript property values from all known windows that have one 🪟
- $attribute_name is name of an attribute on the windows
- Returns the set of values of this attribute from all known windows.
$sel->dragdrop($locator, $movements_string) — deprecated - use dragAndDrop instead ⚠️
$locator — an element locator
$movements_string — offset in pixels from the current location to which the element should be moved, like "+70,-300"

$sel->set_mouse_speed($pixels)

Okay so this one sets how many pixels of gap there are between "mousemove" events while dragAndDrop commands are running. Default is 10, bestie.

And listen — if you set this to 0? Then we send a "mousemove" event for every single pixel between the start location and the end location. That is so slow, and it may cause some browsers to force the JavaScript to time out. Not the vibe. 💀

Also, if the mouse speed ends up being greater than the distance between the two dragged objects, we'll just send one "mousemove" at the start location and then one final one at the end location. Efficiency, periodt.

$pixels — the number of pixels between "mousemove" events

$sel->get_mouse_speed()

Gives you back the number of pixels between "mousemove" events during dragAndDrop commands (default=10). 🖱️

Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).

$sel->drag_and_drop($locator, $movements_string)

Drags an element a certain distance and then drops it. Grab, yeet, release. ✨

$locator — an element locator
$movements_string — offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

$sel->drag_and_drop_to_object($locator_of_object_to_be_dragged, $locator_of_drag_destination_object)

Drags an element and drops it on another element. Element-to-element handoff, no cap. 🫶

$locator_of_object_to_be_dragged — an element to be dragged
$locator_of_drag_destination_object — an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped

$sel->window_focus()

Gives focus to the currently selected window. 👑

$sel->window_maximize()

Resize currently selected window to take up the entire screen. main character energy, truly.

$sel->get_all_window_ids()

Returns the IDs of all windows that the browser knows about in an array.

Returns Array of identifiers of all windows that the browser knows about.

$sel->get_all_window_names()

Returns the names of all windows that the browser knows about in an array.

Returns Array of names of all windows that the browser knows about.

$sel->get_all_window_titles()

Returns the titles of all windows that the browser knows about in an array.

Returns Array of titles of all windows that the browser knows about.

$sel->get_html_source()

Returns the entire HTML source between the opening and closing "html" tags.

Returns the entire HTML source.

$sel->set_cursor_position($locator, $position)

Moves the text cursor to the specified position in the given input element or textarea. Heads up: this method will fail if the element you pointed at isn't an input element or a textarea. 🙈

$locator — an element locator pointing to an input element or textarea
$position — the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.

$sel->get_element_index($locator)

Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored.

$locator — an element locator pointing to an element

Returns of relative index of the element to its parent (starting from 0).

$sel->is_ordered($locator1, $locator2)

Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will not be considered ordered.

$locator1 — an element locator pointing to the first element
$locator2 — an element locator pointing to the second element

Returns true if element1 is the previous sibling of element2, false otherwise.

$sel->get_element_position_left($locator)

Retrieves the horizontal position of an element.

$locator — an element locator pointing to an element OR an element itself

Returns of pixels from the edge of the frame.

$sel->get_element_position_top($locator)

Retrieves the vertical position of an element.

$locator — an element locator pointing to an element OR an element itself

Returns of pixels from the edge of the frame.

$sel->get_element_width($locator)

Retrieves the width of an element.

$locator — an element locator pointing to an element

Returns width of an element in pixels.

$sel->get_element_height($locator)

Retrieves the height of an element.

$locator — an element locator pointing to an element

Returns height of an element in pixels.

$sel->get_cursor_position($locator)

Retrieves the text cursor position in the given input element or textarea. Beware, bestie — this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as http://jira.openqa.org/browse/SEL-243 (SEL-243). And this method will fail if the specified element isn't an input element or textarea, or if there is no cursor in the element. 😭

$locator — an element locator pointing to an input element or textarea

Returns the numerical position of the cursor in the field.

$sel->get_expression($expression)

Returns the specified expression. This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression.

$expression — the value to return

Returns the value passed in.

$sel->get_xpath_count($xpath)

Returns the number of nodes that match the specified xpath, eg. "//table" would give the number of tables.

$xpath — the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.

Returns the number of nodes that match the specified xpath.

$sel->assign_id($locator, $identifier)

Temporarily sets the "id" attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath. This ID will disappear once the page is reloaded. ⏳

$locator — an element locator pointing to an element
$identifier — a string to be used as the ID of the specified element

$sel->allow_native_xpath($allow)

Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass "false" to this function, we will always use our pure-JavaScript xpath library. Using the pure-JS xpath library can improve the consistency of xpath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations. 🐌

$allow — boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath

$sel->ignore_attributes_without_value($ignore)

Specifies whether Selenium will ignore xpath attributes that have no value, i.e. are the empty string, when using the non-native xpath evaluation engine. You'd want to do this for performance reasons in IE. However, this could break certain xpaths, for example an xpath that looks for an attribute whose value is NOT the empty string. The hope is that such xpaths are relatively rare, but the user should have the option of using them. Note that this only influences xpath evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").

$ignore — boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.

$sel->wait_for_condition($script, $timeout)

Runs the specified JavaScript snippet repeatedly until it evaluates to "true". The snippet may have multiple lines, but only the result of the last line will be considered. Note that, by default, the snippet will be run in the runner's test window, not in the window of your application. To get the window of your application, you can use the JavaScript snippet "selenium.browserbot.getCurrentWindow()", and then run your JavaScript in there. 🪟

$script — the JavaScript snippet to run
$timeout — a timeout in milliseconds, after which this command will return with an error

$sel->set_timeout($timeout)

Specifies the amount of time that Selenium will wait for actions to complete. Actions that require waiting include "open" and the "waitFor*" actions. The default timeout is 30 seconds. ⏰

$timeout — a timeout in milliseconds, after which the action will return with an error

$sel->wait_for_page_to_load($timeout)

Waits for a new page to load. You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. (which are only available in the JS API).

Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded" flag when it first notices a page load. Running any other Selenium command after turns the flag to false. Hence, if you want to wait for a page to load, you must wait immediately after a Selenium command that caused a page-load. 👀

$timeout — a timeout in milliseconds, after which this command will return with an error

$sel->wait_for_frame_to_load($frame_address, $timeout)

Waits for a new frame to load. Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load. See waitForPageToLoad for more information.

$frame_address — FrameAddress from the server side
$timeout — a timeout in milliseconds, after which this command will return with an error

Return all cookies of the current page under test. 🍪

Returns all cookies of the current page under test.

Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.

$name — the name of the cookie

Returns the value of the cookie.

Returns true if a cookie with the specified name is present, or false otherwise.

$name is the name of the cookie — and this one returns true if a cookie with the specified name is present, or false otherwise. It’s giving simple, and we love that. 💖

Okay bestie, this creates a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly. 🍪✨

$name_value_pair — is name and value of the cookie in a format "name=value"
$options_string — is options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. The optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail. Lowkey important, highkey annoying. 💅

Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie. If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also note that specifying a domain that isn't a subset of the current domain will usually fail. Since there's no way to discover at runtime the original path and domain of a given cookie, we've added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. 😭

Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path. 💀

$name — is the name of the cookie to be deleted
$options_string — is options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.

`$sel->delete_all_visible_cookies()`

Calls deleteCookie with recurse=true on all cookies visible to the current page. As noted on the documentation for deleteCookie, recurse=true can be much slower than simply deleting the cookies using a known domain/path. So like, use it wisely, iykyk. 🍪💨

`$sel->set_browser_log_level($log_level)`

Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. Valid logLevel strings are: "debug", "info", "warn", "error" or "off". To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in Selenium RC. Periodt. 📝

$log_level — is one of the following: "debug", "info", "warn", "error" or "off"

`$sel->run_script($script)`

Creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using Selenium's "getEval" command.

Beware that JS exceptions thrown in these script tags aren't managed by Selenium, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception. 😬

$script — is the JavaScript snippet to run

`$sel->add_location_strategy($strategy_name)`

Defines a new function for Selenium to locate elements on the page. For example, if you define the strategy "foo", and someone runs click("foo=blah"), we'll run your function, passing you the string "blah", and click on the element that your function returns, or throw an "Element not found" error if your function returns null. We'll pass three arguments to your function:

locator: the string the user passed in
inWindow: the currently selected window
inDocument: the currently selected document

The function must return null if the element can't be found. No cap. 🔍

$strategy_name — is the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.

`$sel->capture_entire_page_screenshot($filename, $kwargs)`

Saves the entire contents of the current window canvas to a PNG file. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Currently this only works in Firefox when running in chrome mode, and in IE non-HTA using the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org and http://snapsie.sourceforge.net/ for details. It's giving screenshot but make it extra. 📸

$filename — is the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.
$kwargs — is a kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD". Currently valid options:
- background the background CSS for the HTML document. This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).

`$sel->rollup($rollup_name, $kwargs)`

Executes a command rollup, which is a series of commands with a unique name, and optionally arguments that control the generation of the set of commands. If any one of the rolled-up commands fails, the rollup is considered to have failed. Rollups may also contain nested rollups. Inception vibes. 🌀

$rollup_name — is the name of the rollup command
$kwargs — is keyword arguments string that influences how the rollup expands into commands

`$sel->add_script($script_content, $script_tag_id)`

Loads script content into a new script tag in the Selenium document. This differs from the runScript command in that runScript adds the script tag to the document of the AUT, not the Selenium document. The following entities in the script content are replaced by the characters they represent: < > & The corresponding remove command is removeScript. 📜

$script_content — is the Javascript content of the script to add
$script_tag_id — is (optional) the id of the new script tag. If specified, and an element with this id already exists, this operation will fail.

`$sel->remove_script($script_tag_id)`

Removes a script tag from the Selenium document identified by the given id. Does nothing if the referenced tag doesn't exist. It's giving ghosting. 🗑️

$script_tag_id — is the id of the script element to remove.

`$sel->use_xpath_library($library_name)`

Allows choice of one of the available libraries. Choose your fighter: 📚

$library_name — is name of the desired library Only the following three can be chosen:
- "ajaxslt" - Google's library
- "javascript-xpath" - Cybozu Labs' faster library
- "default" - The default library. Currently the default library is "ajaxslt" .

If libraryName isn't one of these three, then no change will be made. So like, don't try to be cute. 🤷‍♀️

`$sel->set_context($context)`

Writes a message to the status bar and adds a note to the browser-side log. Little vibe check for the browser. 📢

$context — is the message to be sent to the browser

`$sel->attach_file($field_locator, $file_locator)`

Sets a file input (upload) field to the file listed in fileLocator. 📎

$field_locator — is an element locator
$file_locator — is a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("*chrome") only.

`$sel->capture_screenshot($filename)`

Captures a PNG screenshot to the specified file. Say cheese. 📸

$filename — is the absolute path to the file to be written, e.g. "c:\blah\screenshot.png"

`$sel->capture_screenshot_to_string()`

Capture a PNG screenshot. It then returns the file as a base 64 encoded string. String theory but make it screenshots. 🔥

Returns — The base 64 encoded string of the screen shot (PNG file)

`$sel->capture_entire_page_screenshot_to_string($kwargs)`

Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file. The entire windows canvas is captured, including parts rendered outside of the current view port. Currently this only works in Mozilla and when running in chrome mode. 🦋

$kwargs — is A kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD". This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).
Returns — The base 64 encoded string of the page screenshot (PNG file)

`$sel->shut_down_selenium_server()`

Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send commands to the server; you can't remotely start the server once it has been stopped. Normally you should prefer to run the "stop" command, which terminates the current browser session, rather than shutting down the entire server. This is the nuclear option, bestie. 💀

`$sel->retrieve_last_remote_control_logs()`

Retrieve the last messages logged on a specific remote control. Useful for error reports, especially when running multiple remote controls in a distributed environment. The maximum number of log messages that can be retrieve is configured on remote control startup. Detective mode. 📋

Returns — The last N log messages as a multi-line string.

`$sel->key_down_native($keycode)`

Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command. Keyboard go brrr. ⌨️

$keycode is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes! 💅 Don't mix them up, bestie!

$sel->key_up_native($keycode) — Simulates a user releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command. So iconic.
- $keycode is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
$sel->key_press_native($keycode) — Simulates a user pressing and releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command. Press and release, periodt.
- $keycode is an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
$sel->wait_for_text_present($text, $timeout) — Waits until $text is present in the html source. Patience, queen.
$sel->wait_for_element_present($locator, $timeout) — Waits until $locator is present. Wait for it…
$sel->is_location($expected_location) — Verify the location of the current page ends with the expected location. If an URL querystring is provided, this is checked as well.
- $expected_location is the location to match.

Note: This function is deprecated, use get_location() instead. 💀 Don't use this, bestie!

$sel->get_checked($locator) — Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
- $locator is an element locator pointing to a checkbox or radio button.

Note: This function is deprecated, use is_checked() instead. 💀 Deprecated, no cap.

$sel->is_selected($locator, $option_locator) — Verifies that the selected option of a drop-down satisfies the optionSpecifier.
- See the select command for more information about option locators.
- $locator is an element locator.
- $option_locator is an option locator, typically just an option label (e.g. "John Smith").

Note: This function is deprecated, use the get_selected_*() methods instead. 💀 Old news, fr fr.

$sel->get_selected_options($locator) — Gets all option labels for selected options in the specified select or multi-select element.
- $locator is an element locator.

Note: This function is deprecated, use get_selected_labels() instead. 💀 Deprecated vibes.

$sel->get_absolute_location() — Gets the absolute URL of the current page.

Note: This function is deprecated, use get_location() instead. 💀 Don't even think about it.

✨ NAME ✨

WWW::Selenium - Perl Client for the Selenium Remote Control test tool

🌸 SEE ALSO 🌸

For more information about Selenium Remote Control, visit the website at <http://www.openqa.org/selenium-rc/>. Link in bio, bestie!

Selenium Remote Control maintained by Dan Fabulich <dfabulich@warpmail.net>

🐛 BUGS 🐛

The Selenium Remote Control JIRA issue tracking system is available online at <http://jira.openqa.org/browse/SRC>. Report those bugs, queen.

👑 AUTHORS 👑

Maintained by: Matt Phillips <mattp@cpan.org>, Luke Closs <lukec@cpan.org>
Originally by Mattia Barbon <mbarbon@cpan.org>

Legends only.

💖 COPYRIGHT AND LICENSE 💖

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

Free as in freedom, periodt.

That's the whole vibe, bestie! This page came from perl v5.34.0, dated 2022-06-28, for WWW::Selenium(3pm). Stay iconic! 💅✨

📦 where this page comes from

debian bookworm: libtest-www-selenium-perl 1.36-3 · Artistic-1.0-Perl OR GPL-1.0-or-later
debian trixie: libtest-www-selenium-perl 1.36-3 · Artistic-1.0-Perl OR GPL-1.0-or-later
ubuntu noble: libtest-www-selenium-perl 1.36-3 · Artistic-1.0-Perl OR GPL-1.0-or-later
ubuntu resolute: libtest-www-selenium-perl 1.36-3 · Artistic-1.0-Perl OR GPL-1.0-or-later
ubuntu stonking: libtest-www-selenium-perl 1.36-3 · Artistic-1.0-Perl OR GPL-1.0-or-later
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms