PuppeteerSharp.Contrib.PageObjects 6.0.0

dotnet add package PuppeteerSharp.Contrib.PageObjects --version 6.0.0
NuGet\Install-Package PuppeteerSharp.Contrib.PageObjects -Version 6.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PuppeteerSharp.Contrib.PageObjects" Version="6.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PuppeteerSharp.Contrib.PageObjects --version 6.0.0
#r "nuget: PuppeteerSharp.Contrib.PageObjects, 6.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PuppeteerSharp.Contrib.PageObjects as a Cake Addin
#addin nuget:?package=PuppeteerSharp.Contrib.PageObjects&version=6.0.0

// Install PuppeteerSharp.Contrib.PageObjects as a Cake Tool
#tool nuget:?package=PuppeteerSharp.Contrib.PageObjects&version=6.0.0

PuppeteerSharp.Contrib.PageObjects

build CodeFactor

PuppeteerSharp.Contrib.PageObjects is a library for writing browser tests using the page object pattern with the Puppeteer Sharp API.

Content

Page Objects

A page object wraps an PuppeteerSharp.IPage and should encapsulate the way tests interact with a web page.

Create page objects by inheriting PageObject and declare properties decorated with [Selector] attributes.

public class GitHubStartPage : PageObject
{
    [Selector("main h1")]
    public virtual Task<IElementHandle> Heading { get; }

    [Selector("header")]
    public virtual Task<GitHubHeader> Header { get; }

    public async Task<GitHubSearchPage> SearchAsync(string text)
    {
        var task = Page.WaitForNavigationAsync<GitHubSearchPage>();
        await (await Header).SearchAsync(text);
        return await task;
    }
}

Element Objects

An element object wraps an PuppeteerSharp.IElementHandle and should encapsulate the way tests interact with an element of a web page.

Create element objects by inheriting ElementObject and declare properties decorated with [Selector] attributes.

public class GitHubHeader : ElementObject
{
    [Selector("#query-builder-test")]
    public virtual Task<IElementHandle> SearchInput { get; }

    public async Task SearchAsync(string text)
    {
        var input = await SearchInput;
        if (await input.IsHiddenAsync())
        {
            await Page.ClickAsync("[aria-label=\"Toggle navigation\"][data-view-component=\"true\"]");
            await Page.ClickAsync("[data-target=\"qbsearch-input.inputButtonText\"]");
        }
        await input.TypeAsync(text);
        await input.PressAsync(Key.Enter);
        await Page.WaitForSelectorAsync("[data-testid=\"results-list\"]");
    }
}

Selector Attributes

[Selector] attributes can be applied to properties on a PageObject or ElementObject.

Properties decorated with a [Selector] attribute must be a:

  • public
  • virtual
  • asynchronous
  • getter

that returns:

  • Task<IElementHandle>
  • Task<IElementHandle[]>
  • Task<ElementObject> or
  • Task<ElementObject[]>

Example:

[Selector("#foo")]
public virtual Task<IElementHandle> SelectorForElementHandle { get; }

[Selector(".bar")]
public virtual Task<IElementHandle[]> SelectorForElementHandleArray { get; }

[Selector("#foo")]
public virtual Task<FooElementObject> SelectorForElementObject { get; }

[Selector(".bar")]
public virtual Task<BarElementObject[]> SelectorForElementObjectArray { get; }

Extensions for IPage

Where T is a PageObject:

  • GoBackAsync<T>
  • GoForwardAsync<T>
  • GoToAsync<T>
  • ReloadAsync<T>
  • To<T>
  • WaitForNavigationAsync<T>
  • WaitForResponseAsync<T>

Where T is an ElementObject:

  • QuerySelectorAllAsync<T>
  • QuerySelectorAsync<T>
  • WaitForSelectorAsync<T>
  • WaitForXPathAsync<T>
  • XPathAsync<T>

Extensions for IElementHandle

Where T is an ElementObject:

  • QuerySelectorAllAsync<T>
  • QuerySelectorAsync<T>
  • To<T>
  • WaitForSelectorAsync<T>
  • XPathAsync<T>

Samples

A sample project with NUnit is located in the samples folder:

Further Reading

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.0.0 350 11/18/2023
5.0.0 1,173 8/9/2022
2.0.0 1,211 4/17/2021
1.0.0 3,524 5/2/2020

⬆️ Bump PuppeteerSharp to 12.0.0
👽️ Use PuppeteerSharp interfaces; IPage and IElementHandle

New extensions for IPage:
◼️ To<T>

New extensions for IElementHandle:
◼️ To<T>

🗑️ XPath is now obsolete:
◼️ XPathAttribute
◼️ IPage.XPathAsync
◼️ IPage.WaitForXPathAsync
◼️ IElementHandle.XPathAsync