NAME

Firefox::Marionette::Element - Represents a Firefox element retrieved using the Marionette protocol

VERSION

Version 1.17

SYNOPSIS

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $element = $firefox->find('//input[@id="search-input"]');

    $element->type('Test::More');

DESCRIPTION

This module handles the implementation of a Firefox Element using the Marionette protocol

SUBROUTINES/METHODS

attribute

accepts a scalar name a parameter. It returns the initial value of the attribute with the supplied name. Compare with the current value returned by property method.

browser

returns the browser connected with the element.

clear

clears any user supplied input from the element

sends a 'click' to the element. The browser will wait for any page load to complete or the session's page_load duration to elapse before returning, which, by default is 5 minutes. The click method is also used to choose an option in a select dropdown.

    use Firefox::Marionette();

    my $firefox = Firefox::Marionette->new(visible => 1)->go('https://ebay.com');
    my $select = $firefox->find_tag('select');
    foreach my $option ($select->find_tag('option')) {
        if ($option->property('value') == 58058) { # Computers/Tablets & Networking
            $option->click();
        }
    }

css

accepts a scalar CSS property name as a parameter. It returns the value of the computed style for that property.

find

accepts an xpath expression <https://en.wikipedia.org/wiki/XPath> expression> as the first parameter and returns the first element that matches this expression.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('main-content');
    $div->find('//input[@id="search-input"]')->type('Test::More');

    # OR in list context

    my $div = $firefox->find_class('main-content');
    foreach my $element ($div->find('//input[@id="search-input"]')) {
        $element->type('Test::More');
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has method.

find_id

accepts an id <https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id> as the first parameter and returns the first element with a matching 'id' property.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('main-content');
    $div->find_id('search-input')->type('Test::More');

    # OR in list context

    my $div = $firefox->find_class('main-content');
    foreach my $element ($div->find_id('search-input')) {
        $element->type('Test::More');
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_id method.

find_name

This method returns the first element with a matching 'name' property.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('main-content');
    $div->find_name('q')->type('Test::More');

    # OR in list context

    my $div = $firefox->find_class('main-content');
    foreach my $element ($div->find_name('q')) {
        $element->type('Test::More');
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_name method.

find_class

accepts a class name <https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/class> as the first parameter and returns the first element with a matching 'class' property.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('main-content');
    $div->find_class('form-control home-search-input')->type('Test::More');

    # OR in list context

    my $div = $firefox->find_class('main-content');
    foreach my $element ($div->find_class('form-control home-search-input')) {
        $element->type('Test::More');
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_class method.

find_selector

accepts a CSS Selector <https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors> as the first parameter and returns the first element that matches that selector.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('main-content');
    $div->find_selector('input.home-search-input')->type('Test::More');

    # OR in list context

    my $div = $firefox->find_class('main-content');
    foreach my $element ($div->find_selector('input.home-search-input')) {
        $element->type('Test::More');
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_selector method.

find_tag

accepts a tag name <https://developer.mozilla.org/en-US/docs/Web/API/Element/tagName> as the first parameter and returns the first element with this tag name.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('main-content');
    my $input = $div->find_tag('input');

    # OR in list context

    my $div = $firefox->find_class('main-content');
    foreach my $element ($div->find_tag('input')) {
        # do something
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_tag method.

find_link

accepts a text string as the first parameter and returns the first link element that has a matching link text.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('container-fluid');
    $div->find_link('API')->click();

    # OR in list context

    my $div = $firefox->find_class('container-fluid');
    foreach my $element ($div->find_link('API')) {
        $element->click();
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_link method.

find_partial

accepts a text string as the first parameter and returns the first link element that has a partially matching link text.

This method is subject to the implicit timeout.

    use Firefox::Marionette();
    use v5.10;

    my $firefox = Firefox::Marionette->new()->go('https://metacpan.org/');

    my $div = $firefox->find_class('container-fluid');
    $div->find_partial('AP')->click();

    # OR in list context

    my $div = $firefox->find_class('container-fluid');
    foreach my $element ($div->find_partial('AP')) {
        $element->click();
    }

If no elements are found, a not found exception will be thrown. For the same functionality that returns undef if no elements are found, see the has_partial method.

has

accepts an xpath expression <https://en.wikipedia.org/wiki/XPath> as the first parameter and returns the first element that matches this expression.