@@ -41,10 +41,10 @@ There are many tools that are available to help you understand the layout of you
Here are helpful links to each platform where you can find more information on the right tooling for the app's you're testing.
-- [Windows](features/windows.md)
-- [Android](features/android.md)
-- [iOS](features/ios.md)
-- [Web](features/web.md)
+- [Windows](xref:quick_starts_windows)
+- [Android](xref:quick_starts_android)
+- [iOS](xref:quick_starts_ios)
+- [Web](xref:quick_starts_web)
### How do you keep Legerity going?
diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml
index 54c677a0..e5278ee8 100644
--- a/docs/articles/toc.yml
+++ b/docs/articles/toc.yml
@@ -1,40 +1,40 @@
-- name: Overview
- topicHref: intro.md
-- name: Get started
+- name: Introduction
+ href: intro.md
+- name: Getting started
+ href: getting-started.md
+ expanded: true
items:
- - name: Installing Legerity packages
- href: available-packages.md
-- name: Building UI tests with Legerity
- href: building-with-legerity.md
-- name: Best practices for UI tests
- href: best-practices.md
-- name: Building platform element wrappers
- href: building-platform-wrappers.md
-- name: Available element wrappers
- items:
- - name: For Windows apps
- items:
- - name: Overview
- href: features/windows.md
- - name: WinUI
- href: features/windows-ui.md
- - name: Windows Community Toolkit
- href: features/windows-community-toolkit.md
- - name: MADE.NET
- href: features/made-windows.md
- - name: Telerik for UWP
- href: features/telerik-for-uwp.md
- - name: For Android apps
- items:
- - name: Overview
- href: features/android.md
- - name: For iOS apps
+ - name: Quick starts
+ href: getting-started/quick-starts.md
+ expanded: true
items:
- - name: Overview
- href: features/ios.md
- - name: For Web apps
- items:
- - name: Overview
- href: features/web.md
- - name: Authentication Helpers
- href: features/web-authentication.md
+ - name: Windows
+ href: getting-started/quick-starts/windows.md
+ - name: Android
+ href: getting-started/quick-starts/android.md
+ - name: iOS
+ href: getting-started/quick-starts/ios.md
+ - name: Web
+ href: getting-started/quick-starts/web.md
+ - name: Cross platform
+ href: getting-started/quick-starts/cross-platform.md
+- name: Using Legerity
+ href: using-legerity.md
+ expanded: true
+ items:
+ - name: Installation
+ href: using-legerity/installation.md
+ - name: Test Frameworks
+ href: using-legerity/test-frameworks.md
+ - name: Test Classes
+ href: using-legerity/test-classes.md
+ - name: App Manager
+ href: using-legerity/app-manager.md
+ - name: Element Wrappers
+ href: using-legerity/element-wrappers.md
+ - name: Page Objects
+ href: using-legerity/page-objects.md
+ - name: By Locators
+ href: using-legerity/by-locators.md
+ - name: Wait Conditions
+ href: using-legerity/wait-conditions.md
diff --git a/docs/articles/using-legerity.md b/docs/articles/using-legerity.md
new file mode 100644
index 00000000..5d88a5bc
--- /dev/null
+++ b/docs/articles/using-legerity.md
@@ -0,0 +1,20 @@
+---
+uid: using_legerity
+title: Using Legerity
+---
+
+# Using Legerity
+
+To use and understand Legerity, this documentation has been organized to start with the basics and then build up to more advanced topics.
+
+> [!NOTE]
+> To get started quickly, you can explore our [quick starts](xref:getting_started_quick_starts) to use our UI test project templates to get up and running with Legerity.
+
+- [Installation](xref:using_legerity_installation)
+- [Test Frameworks](xref:using_legerity_test_frameworks)
+- [Test Classes](xref:using_legerity_test_classes)
+- [App Manager](xref:using_legerity_app_manager)
+- [Element Wrappers](xref:using_legerity_element_wrappers)
+- [Page Objects](xref:using_legerity_page_objects)
+- [By Locators](xref:using_legerity_by_locators)
+- [Wait Conditions](xref:using_legerity_wait_conditions)
diff --git a/docs/articles/using-legerity/app-manager.md b/docs/articles/using-legerity/app-manager.md
new file mode 100644
index 00000000..c5018e61
--- /dev/null
+++ b/docs/articles/using-legerity/app-manager.md
@@ -0,0 +1,153 @@
+---
+uid: using_legerity_app_manager
+title: App Manager
+---
+
+# App manager
+
+The [`AppManager`](xref:Legerity.AppManager) is a lightweight wrapper for a Selenium application driver that allows you to start your applications using a Legerity [`AppManagerOptions`](xref:Legerity.AppManagerOptions) configuration object.
+
+## Understanding the app manager options
+
+Each platform has its own `AppManagerOptions` implementation that each include custom properties specific to them. For example, the [`AndroidAppManagerOptions`](xref:Legerity.Android.AndroidAppManagerOptions) class includes the `AppActivity` property that is specific to Android.
+
+Here's a complete list of the `AppManagerOptions` implementations:
+
+- [`AndroidAppManagerOptions`](xref:Legerity.Android.AndroidAppManagerOptions)
+- [`IOSAppManagerOptions`](xref:Legerity.IOS.IOSAppManagerOptions)
+- [`WindowsAppManagerOptions`](xref:Legerity.Windows.WindowsAppManagerOptions)
+- [`WebAppManagerOptions`](xref:Legerity.Web.WebAppManagerOptions)
+
+`AppManagerOptions` and [`AppiumManagerOptions`](xref:AppiumManagerOptions) are also available for use if you want to use the base implementations to create your own custom implementations for other platforms, as well as customising for your own needs.
+
+## Configuring the app manager to start your app
+
+The `AppManager` is straightforward to configure and use. You simply construct your `AppManagerOptions` object and pass it through to the `AppManager.StartApp` method. This will return your application driver that you can use to interact with your application.
+
+```csharp
+public class MyTests
+{
+ [Test]
+ public void MyTest()
+ {
+ AppManagerOptions options = new AndroidAppManagerOptions
+ {
+ AppId = AndroidApplication,
+ AppActivity = AndroidApplicationActivity,
+ DriverUri = "http://localhost:4723/wd/hub",
+ LaunchAppiumServer = false,
+ ImplicitWait = ImplicitWait,
+ };
+
+ var app = AppManager.StartApp(options);
+ }
+}
+```
+
+> [!NOTE]
+> When not running parallel tests, the `AppManager` also exposes an `App` property that will return the current application driver. This is useful when you want to interact with the application driver directly.
+
+### Running parallel app tests
+
+When running parallel tests, you will need to ensure that each test is using its own application driver. The `AppManager` handles this for you under the hood by creating new instances of an application driver for each call of the `StartApp` method.
+
+The multiple launched application drivers are managed under the `StartedApps` collection on the `AppManager` class.
+
+> [!NOTE]
+> In your tests, you shouldn't need to interact with the `StartedApps` collection directly, as the `AppManager` will handle this for you. However, it is exposed if there is a custom scenario that you need to handle.
+
+### Waiting until the app is ready
+
+When starting your application, you may want to wait until the application is ready before interacting with it. A good use case for this scenario is when you want to wait until a loading screen in your app has finished before interacting with it.
+
+To do this, when you start your application, you can pass through a `Func
+
-
-
-
Why Legerity?
--Do you struggle to get started with UI tests? Think it takes too long to develop and maintain them? -
--That's why I built Legerity. From the frustrations of building maintainable UI test suites, Legerity is a framework built on Selenium that makes UI testing easy for you by abstracting common UI interactions. -
- +
+
-+ Build maintainable UI tests quickly for Windows, Android, iOS, and Web apps +
-[Learn more](articles/intro.md) +
+ Legerity is an automated UI testing framework for building maintainable tests quickly for native and web applications using .NET.
+
-
-
-
+
+Available packages
--Take advantage of what is available for Legerity in your UI test projects. -
--You'll discover what packages are available for you from NuGet.org, plus how you can use them. -
-
+
+ Info
+
+
-
+
+
+
+
+
+
+
+
+ Build with
+
+
+
+
+ .NET Standard 2.0
+
+
+
+
+
+
+
+
+
+
+ App support
+
+
+
+
+ Windows, Android, iOS, Web
+
+
+
+
+
+
+
+
+
+
+ Browser support
+
+
+
+
+ Chrome, Firefox, Opera, Safari, Edge, Internet Explorer
+
+
+
-
-
diff --git a/samples/MADESampleApp/MADESampleApp.csproj b/samples/MADESampleApp/MADESampleApp.csproj
index 10273e10..42cfed9a 100644
--- a/samples/MADESampleApp/MADESampleApp.csproj
+++ b/samples/MADESampleApp/MADESampleApp.csproj
@@ -8,9 +8,9 @@
diff --git a/samples/TelerikUwpSdkSample/TelerikUwpSdkSample.csproj b/samples/TelerikUwpSdkSample/TelerikUwpSdkSample.csproj
index c6d01575..376d9e27 100644
--- a/samples/TelerikUwpSdkSample/TelerikUwpSdkSample.csproj
+++ b/samples/TelerikUwpSdkSample/TelerikUwpSdkSample.csproj
@@ -8,9 +8,9 @@
diff --git a/samples/W3SchoolsWebTests/W3SchoolsWebTests.csproj b/samples/W3SchoolsWebTests/W3SchoolsWebTests.csproj
index 2787312c..bb9df575 100644
--- a/samples/W3SchoolsWebTests/W3SchoolsWebTests.csproj
+++ b/samples/W3SchoolsWebTests/W3SchoolsWebTests.csproj
@@ -8,10 +8,10 @@
diff --git a/samples/WebTests/WebTests.csproj b/samples/WebTests/WebTests.csproj
index ba246dd0..f1662e10 100644
--- a/samples/WebTests/WebTests.csproj
+++ b/samples/WebTests/WebTests.csproj
@@ -8,10 +8,10 @@
diff --git a/samples/WindowsAlarmsAndClock/WindowsAlarmsAndClock.csproj b/samples/WindowsAlarmsAndClock/WindowsAlarmsAndClock.csproj
index da59250c..4ed18c2b 100644
--- a/samples/WindowsAlarmsAndClock/WindowsAlarmsAndClock.csproj
+++ b/samples/WindowsAlarmsAndClock/WindowsAlarmsAndClock.csproj
@@ -8,9 +8,9 @@
diff --git a/samples/WindowsCommunityToolkitSampleApp/WindowsCommunityToolkitSampleApp.csproj b/samples/WindowsCommunityToolkitSampleApp/WindowsCommunityToolkitSampleApp.csproj
index 29f9e689..d61c86fa 100644
--- a/samples/WindowsCommunityToolkitSampleApp/WindowsCommunityToolkitSampleApp.csproj
+++ b/samples/WindowsCommunityToolkitSampleApp/WindowsCommunityToolkitSampleApp.csproj
@@ -8,9 +8,9 @@
diff --git a/samples/XamlControlsGallery/XamlControlsGallery.csproj b/samples/XamlControlsGallery/XamlControlsGallery.csproj
index abfc575a..3667eafa 100644
--- a/samples/XamlControlsGallery/XamlControlsGallery.csproj
+++ b/samples/XamlControlsGallery/XamlControlsGallery.csproj
@@ -8,9 +8,9 @@
Contributing
--Do you have a suite of controls you want support for? -
--Legerity is available as an open-source project on GitHub! Dive into the codebase and bring your improvements. -
- +--- + +
+
-
+
+
+ 
+
+
+ + Create tests with page objects +
+
+ Legerity provides a pattern for creating lightweight, extensible page objects representing your application pages
+
+
+
+
+
+ 
+
+
+ + Simplify interaction with element wrappers +
+
+ Easy-to-use element wrappers for common platform controls make it easier to find and interact with your app
+
+
+
+
+
+
+ 
+
+
+ + Test framework agnostic +
+
+ Legerity is agnostic of .NET testing frameworks (e.g. NUnit, xUnit, MSTest, etc.) so you can work with what you know
+
+
+
+
+
+ 
+
+
+ + Extensible by design +
+
+ Build custom element wrappers using the existing Legerity components for your own UI controls across platforms
+
+
+
+
+
-
diff --git a/docs/templates/material/partials/head.tmpl.partial b/docs/templates/material/partials/head.tmpl.partial
index c05e8c1b..15f07cdc 100644
--- a/docs/templates/material/partials/head.tmpl.partial
+++ b/docs/templates/material/partials/head.tmpl.partial
@@ -11,8 +11,10 @@
+
+
-
+
{{#_noindex}}{{/_noindex}}
diff --git a/docs/templates/material/styles/main.css b/docs/templates/material/styles/main.css
index 6a985f77..ac09a0bf 100644
--- a/docs/templates/material/styles/main.css
+++ b/docs/templates/material/styles/main.css
@@ -2,13 +2,15 @@
:root {
--header-bg-color: #fff;
--header-ft-color: #0d4ff7a1;
- --highlight-light: #5e92f3;
- --highlight-dark: #002171;
+ --highlight-light: #98BAE1;
+ --highlight-dark: #3673BA;
--accent-dim: #e0e0e0;
--accent-super-dim: #f3f3f3;
--font-color: #34393e;
- --card-box-shadow: 0 1px 2px 0 rgba(61, 65, 68, 0.06), 0 1px 3px 1px rgba(61, 65, 68, 0.16);
- --search-box-shadow: 0 1px 2px 0 rgba(41, 45, 48, 0.36), 0 1px 3px 1px rgba(41, 45, 48, 0.46);
+ --card-box-shadow: 0 1px 2px 0 rgba(61, 65, 68, 0.06),
+ 0 1px 3px 1px rgba(61, 65, 68, 0.16);
+ --search-box-shadow: 0 1px 2px 0 rgba(41, 45, 48, 0.36),
+ 0 1px 3px 1px rgba(41, 45, 48, 0.46);
--transition: 350ms;
}
@@ -152,7 +154,7 @@ article h4 {
border: 0;
border-radius: 4px;
box-shadow: var(--search-box-shadow);
- transition:var(--transition);
+ transition: var(--transition);
}
.navbar-form .form-control:hover {
@@ -161,7 +163,8 @@ article h4 {
/* NAVBAR TOGGLED (small screens) */
-.navbar-inverse .navbar-collapse, .navbar-inverse .navbar-form {
+.navbar-inverse .navbar-collapse,
+.navbar-inverse .navbar-form {
border: none;
}
.navbar-inverse .navbar-toggle {
@@ -200,7 +203,7 @@ article h4 {
padding: 5px;
margin: 0;
box-shadow: var(--card-box-shadow);
- transition:var(--transition);
+ transition: var(--transition);
}
.toc-filter:hover {
@@ -306,30 +309,186 @@ pre {
max-width: 700px;
}
+/* STYLE FOR BUTTONS */
+
.button {
display: inline-block;
}
.button a {
- display: inline-block;
- padding: 8px 16px;
- box-shadow: 0 2px 4px 0 rgba(31, 31, 31, 0.25);
- border-radius: 8px;
- transition: color 0.2s ease-in-out,
- background-color 0.2s ease-in-out;
+ display: inline-block;
+ padding: 12px 20px;
+ box-shadow: 0 2px 4px 0 rgba(31, 31, 31, 0.25);
+ border-radius: 3em;
+ transition: color 0.2s ease-in-out, background-color 0.2s ease-in-out;
+}
+
+.accent-button a {
+ background-color: var(--header-bg-color);
+ color: var(--header-ft-color);
}
.sponsor-button .octicon {
vertical-align: text-top;
- overflow: visible;
- transition: transform .15s cubic-bezier(.2,0,.13,2);
+ overflow: visible;
+ transition: transform 0.15s cubic-bezier(0.2, 0, 0.13, 2);
}
.text-pink {
- color: #ea4aaa;
+ color: #ea4aaa;
}
.octicon {
- display: inline-block;
- fill: currentcolor;
+ display: inline-block;
+ fill: currentcolor;
+}
+
+/* SITE STYLES */
+
+hr {
+ margin-top: 0;
+ margin-bottom: 7rem;
+}
+
+.article {
+ margin-top: 120px !important;
+}
+
+.highlight-section {
+ max-width: 640px;
+ margin: 0 auto 8px;
+ display: block;
+}
+
+.hero-layout {
+ text-align: center;
+}
+
+.hero-image {
+ width: 100%;
+}
+
+.hero-title {
+ font-size: 48px;
+ line-height: 52px;
+ margin-bottom: 1rem;
+}
+
+.hero-subtitle {
+ font-size: 20px;
+ line-height: 32px;
+ margin-bottom: 1.5rem;
+}
+
+.small-heading {
+ font-weight: 900;
+ letter-spacing: 0.35rem;
+ text-transform: uppercase;
+ font-size: 12px;
+ margin-bottom: 1rem;
+ display: block;
+}
+
+.stat {
+ color: var(--font-color);
+ text-decoration: none;
+ padding: 0;
+ display: block;
+ margin-right: 8px;
+}
+
+a.stat {
+ color: var(--header-bg-color);
+}
+
+.stats-container > * {
+ flex: 1 1 0;
+ margin-bottom: 1.25rem;
+}
+
+.stat-container {
+ text-align: left;
+ vertical-align: top;
+ border-radius: 4px;
+ padding: 0;
+}
+
+.stat-header {
+ font-weight: 700;
+ font-size: 14px;
+ line-height: 16px;
+ margin-bottom: 2px;
+}
+
+.stat-content {
+ color: var(--font-color);
+ font-size: 12px;
+ line-height: 14px;
+ clear: both;
+}
+
+.md-header {
+ font-size: 32px;
+ line-height: 40px;
+ margin-bottom: 0.75rem;
+ font-weight: 800;
+}
+
+.md-content {
+ font-size: 20px;
+ line-height: 32px;
+ color: var(--font-color);
+}
+
+.sm-header {
+ font-size: 20px;
+ line-height: 24px;
+ margin-bottom: 0.5rem;
+}
+
+.highlight-section .sm-header {
+ margin-top: 0;
+}
+
+.sm-content {
+ font-size: 16px;
+ line-height: 1.5;
+ color: var(--font-color);
+}
+
+.grid-item {
+ flex: 0 1 50%;
+ padding: 4rem 70px 4rem;
+}
+
+.grid-item img {
+ max-height: 120px;
+ max-width: 120px;
+}
+
+.grid-col {
+ margin: 0;
+ padding: 0;
+}
+
+.home-row {
+ margin-bottom: 7rem;
+}
+
+.home-row-centered-sm {
+ text-align: center;
+}
+
+@media (min-width: 992px) {
+ .grid-border-bottom {
+ border-bottom: var(--light-border);
+ }
+
+ .grid-border-right {
+ border-right: var(--light-border);
+ }
+
+ .home-row-centered-sm {
+ text-align: unset;
+ }
}
diff --git a/samples/AndroidCoreSamples/AndroidCoreSamples.csproj b/samples/AndroidCoreSamples/AndroidCoreSamples.csproj
index 288c0fc6..11816779 100644
--- a/samples/AndroidCoreSamples/AndroidCoreSamples.csproj
+++ b/samples/AndroidCoreSamples/AndroidCoreSamples.csproj
@@ -8,9 +8,9 @@
Supporting Legerity
--If you'd like to support Legerity's current and future endeavors, considering sponsoring the work we do! -
-