playwright-cucumber-ts-steps 1.1.13 → 1.2.0

package/README.md

@@ -17,7 +17,6 @@
 
 > **Note:** This package is designed for advanced Cucumber+Playwright+TypeScript setups. For basic Playwright usage, see the [official Playwright docs](https://playwright.dev/).
 
-
 **The "Low-Code" BDD Framework for Playwright.**
 
 Write powerful end-to-end tests in plain English using Gherkin syntax, without managing complex glue code. `playwright-cucumber-ts-steps` provides a pre-built library of robust steps for UI, API, and Authentication testing, running natively inside Playwright.
@@ -40,16 +39,17 @@ Write powerful end-to-end tests in plain English using Gherkin syntax, without m
 ```bash
 npm install playwright-cucumber-ts-steps @playwright/test
 ```
+
 or
 
 ```bash
 yarn add playwright-cucumber-ts-steps @playwright/test
 ```
+
 ```bash
 npx playwright install
 ```
 
-
 ## 📘 Step Definition Documentation
 
 👉 [View Steps Documentation](https://qapaschale.github.io/playwright-cucumber-ts-steps/) and [examples](https://github.com/qaPaschalE/playwright-cucumber-ts-steps/tree/main/examples).
@@ -392,6 +392,1701 @@ Scenario: Scroll Test
 
 ---
 
+## 📘 Step Definition Documentation
+
+
+### **When** I click
+
+
+
+```gherkin
+When I click
+```
+
+---
+
+### **When** I click on element {string}
+
+
+
+```gherkin
+When I click on element {string}
+```
+
+---
+
+### **When** I click on button {string}
+
+
+
+```gherkin
+When I click on button {string}
+```
+
+---
+
+### **When** I click on link {string}
+
+
+
+```gherkin
+When I click on link {string}
+```
+
+---
+
+### **When** I click on label {string}
+
+
+
+```gherkin
+When I click on label {string}
+```
+
+---
+
+### **When** I click on text {string}
+
+
+
+```gherkin
+When I click on text {string}
+```
+
+---
+
+### **When** I click on exact text {string}
+
+
+
+```gherkin
+When I click on exact text {string}
+```
+
+---
+
+### **When** I click on selector ([^]+)
+
+
+
+```gherkin
+When I click on selector ([^]+)
+```
+
+---
+
+### **When** I click all
+
+
+
+```gherkin
+When I click all
+```
+
+---
+
+### **When** I double click
+
+
+
+```gherkin
+When I double click
+```
+
+---
+
+### **When** I double click on text {string}
+
+
+
+```gherkin
+When I double click on text {string}
+```
+
+---
+
+### **When** I double click position {int} {int}
+
+
+
+```gherkin
+When I double click position {int} {int}
+```
+
+---
+
+### **When** I right click
+
+
+
+```gherkin
+When I right click
+```
+
+---
+
+### **When** I right click on text {string}
+
+
+
+```gherkin
+When I right click on text {string}
+```
+
+---
+
+### **When** I right click position {int} {int}
+
+
+
+```gherkin
+When I right click position {int} {int}
+```
+
+---
+
+### **When** I click on ({int})(?:st|nd|rd|th) element ([^]+)
+
+
+
+```gherkin
+When I click on ({int})(?:st|nd|rd|th) element ([^]+)
+```
+
+---
+
+### **When** I click on ({int})(?:st|nd|rd|th) selector ([^]+)
+
+
+
+```gherkin
+When I click on ({int})(?:st|nd|rd|th) selector ([^]+)
+```
+
+---
+
+### **When** I find element by selector {string}
+
+
+
+```gherkin
+When I find element by selector {string}
+```
+
+---
+
+### **When** I find element by text {string}
+
+
+
+```gherkin
+When I find element by text {string}
+```
+
+---
+
+### **When** I find element by title {string}
+
+
+
+```gherkin
+When I find element by title {string}
+```
+
+---
+
+### **When** I find element by testid {string}
+
+
+
+```gherkin
+When I find element by testid {string}
+```
+
+---
+
+### **When** I find element by role {string}
+
+
+
+```gherkin
+When I find element by role {string}
+```
+
+---
+
+### **When** I find element by placeholder text {string}
+
+
+
+```gherkin
+When I find element by placeholder text {string}
+```
+
+---
+
+### **When** I find element by label text {string}
+
+
+
+```gherkin
+When I find element by label text {string}
+```
+
+---
+
+### **When** I find element by alt text {string}
+
+
+
+```gherkin
+When I find element by alt text {string}
+```
+
+---
+
+### **When** I find link by text {string}
+
+
+
+```gherkin
+When I find link by text {string}
+```
+
+---
+
+### **When** I find heading by text {string}
+
+
+
+```gherkin
+When I find heading by text {string}
+```
+
+---
+
+### **When** I find element by name {string}
+
+
+
+```gherkin
+When I find element by name {string}
+```
+
+---
+
+### **When** I find elements by selector {string}
+
+
+
+```gherkin
+When I find elements by selector {string}
+```
+
+---
+
+### **When** I find headings by text {string}
+
+
+
+```gherkin
+When I find headings by text {string}
+```
+
+---
+
+### **When** I find buttons by text {string}
+
+
+
+```gherkin
+When I find buttons by text {string}
+```
+
+---
+
+### **When** I get first element
+
+
+
+```gherkin
+When I get first element
+```
+
+---
+
+### **When** I get last element
+
+
+
+```gherkin
+When I get last element
+```
+
+---
+
+### **When** I get ({int})(?:st|nd|rd|th) element
+
+
+
+```gherkin
+When I get ({int})(?:st|nd|rd|th) element
+```
+
+---
+
+### **When** I get focused element
+
+
+
+```gherkin
+When I get focused element
+```
+
+---
+
+### **When** I find input by ID {string}
+
+
+
+```gherkin
+When I find input by ID {string}
+```
+
+---
+
+### **When** I find input by name {string}
+
+
+
+```gherkin
+When I find input by name {string}
+```
+
+---
+
+### **When** I find input by placeholder text {string}
+
+
+
+```gherkin
+When I find input by placeholder text {string}
+```
+
+---
+
+### **When** I find input by display value {string}
+
+
+
+```gherkin
+When I find input by display value {string}
+```
+
+---
+
+### **When** I find textarea by label text {string}
+
+
+
+```gherkin
+When I find textarea by label text {string}
+```
+
+---
+
+### **When** I store element text as {string}
+
+
+
+```gherkin
+When I store element text as {string}
+```
+
+---
+
+### **When** I fill the following {string} form data
+
+
+
+```gherkin
+When I fill the following {string} form data
+```
+
+---
+
+### **When** I fill the following {string} test form data
+
+
+
+```gherkin
+When I fill the following {string} test form data
+```
+
+---
+
+### **When** I switch to frame {string}
+
+
+
+```gherkin
+When I switch to frame {string}
+```
+
+---
+
+### **When** I find element {string} in frame {string}
+
+
+
+```gherkin
+When I find element {string} in frame {string}
+```
+
+---
+
+### **When** I switch to new tab
+
+
+
+```gherkin
+When I switch to new tab
+```
+
+---
+
+### **When** I type {string}
+
+
+
+```gherkin
+When I type {string}
+```
+
+---
+
+### **When** I type stored {string}
+
+
+
+```gherkin
+When I type stored {string}
+```
+
+---
+
+### **When** I slowly type {string}
+
+
+
+```gherkin
+When I slowly type {string}
+```
+
+---
+
+### **When** I set value {string}
+
+
+
+```gherkin
+When I set value {string}
+```
+
+---
+
+### **When** I clear
+
+
+
+```gherkin
+When I clear
+```
+
+---
+
+### **When** I press {string}
+
+
+
+```gherkin
+When I press {string}
+```
+
+---
+
+### **When** I check
+
+
+
+```gherkin
+When I check
+```
+
+---
+
+### **When** I uncheck
+
+
+
+```gherkin
+When I uncheck
+```
+
+---
+
+### **When** I check input
+
+
+
+```gherkin
+When I check input
+```
+
+---
+
+### **When** I uncheck input
+
+
+
+```gherkin
+When I uncheck input
+```
+
+---
+
+### **When** I (check|uncheck) ({int})(?:st|nd|rd|th) selector ([^]+)
+
+
+
+```gherkin
+When I (check|uncheck) ({int})(?:st|nd|rd|th) selector ([^]+)
+```
+
+---
+
+### **When** I select option {string}
+
+
+
+```gherkin
+When I select option {string}
+```
+
+---
+
+### **When** I submit
+
+
+
+```gherkin
+When I submit
+```
+
+---
+
+### **When** I select file {string}
+
+
+
+```gherkin
+When I select file {string}
+```
+
+---
+
+### **When** I upload file {string}
+
+
+
+```gherkin
+When I upload file {string}
+```
+
+---
+
+### **When** I click {string}
+
+
+
+```gherkin
+When I click {string}
+```
+
+---
+
+### **When** I force click {string}
+
+
+
+```gherkin
+When I force click {string}
+```
+
+---
+
+### **When** I fill {string} with {string}
+
+
+
+```gherkin
+When I fill {string} with {string}
+```
+
+---
+
+### **When** I press {string}
+
+
+
+```gherkin
+When I press {string}
+```
+
+---
+
+### **When** I wait for {int} milliseconds
+
+
+
+```gherkin
+When I wait for {int} milliseconds
+```
+
+---
+
+### **When** I press key {string}
+
+
+
+```gherkin
+When I press key {string}
+```
+
+---
+
+### **When** I press key {string} on element
+
+
+
+```gherkin
+When I press key {string} on element
+```
+
+---
+
+### **When** I press keys {string}
+
+
+
+```gherkin
+When I press keys {string}
+```
+
+---
+
+### **When** I press shortcut {string}
+
+
+
+```gherkin
+When I press shortcut {string}
+```
+
+---
+
+### **When** I hold down key {string}
+
+
+
+```gherkin
+When I hold down key {string}
+```
+
+---
+
+### **When** I release key {string}
+
+
+
+```gherkin
+When I release key {string}
+```
+
+---
+
+### **When** I wait for {int} milliseconds
+
+
+
+```gherkin
+When I wait for {int} milliseconds
+```
+
+---
+
+### **When** I wait for {int} seconds
+
+
+
+```gherkin
+When I wait for {int} seconds
+```
+
+---
+
+### **When** I pause
+
+
+
+```gherkin
+When I pause
+```
+
+---
+
+### **When** I debug
+
+
+
+```gherkin
+When I debug
+```
+
+---
+
+### **When** I log {string}
+
+
+
+```gherkin
+When I log {string}
+```
+
+---
+
+### **When** I focus
+
+
+
+```gherkin
+When I focus
+```
+
+---
+
+### **When** I blur
+
+
+
+```gherkin
+When I blur
+```
+
+---
+
+### **When** I set cookie {string} to {string}
+
+
+
+```gherkin
+When I set cookie {string} to {string}
+```
+
+---
+
+### **When** I clear all cookies
+
+
+
+```gherkin
+When I clear all cookies
+```
+
+---
+
+### **When** I set local storage item {string} to {string}
+
+
+
+```gherkin
+When I set local storage item {string} to {string}
+```
+
+---
+
+### **When** I get local storage item {string}
+
+
+
+```gherkin
+When I get local storage item {string}
+```
+
+---
+
+### **When** I clear local storage
+
+
+
+```gherkin
+When I clear local storage
+```
+
+---
+
+### **When** I set session storage item {string} to {string}
+
+
+
+```gherkin
+When I set session storage item {string} to {string}
+```
+
+---
+
+### **When** I clear session storage
+
+
+
+```gherkin
+When I clear session storage
+```
+
+---
+
+### **When** I tap
+
+
+
+```gherkin
+When I tap
+```
+
+---
+
+### **When** I tap element {string}
+
+
+
+```gherkin
+When I tap element {string}
+```
+
+---
+
+### **When** I tap coordinates x:{int} y:{int}
+
+
+
+```gherkin
+When I tap coordinates x:{int} y:{int}
+```
+
+---
+
+### **When** I resize window to width {int} and height {int}
+
+
+
+```gherkin
+When I resize window to width {int} and height {int}
+```
+
+---
+
+### **When** I simulate device {string}
+
+
+
+```gherkin
+When I simulate device {string}
+```
+
+---
+
+### **When** I set geolocation to lat: {float} long: {float}
+
+
+
+```gherkin
+When I set geolocation to lat: {float} long: {float}
+```
+
+---
+
+### **When** I grant permission {string}
+
+
+
+```gherkin
+When I grant permission {string}
+```
+
+---
+
+### **When** I scroll {string} into view
+
+
+
+```gherkin
+When I scroll {string} into view
+```
+
+---
+
+### **When** I scroll {string} to position x:{int} y:{int}
+
+
+
+```gherkin
+When I scroll {string} to position x:{int} y:{int}
+```
+
+---
+
+### **When** I scroll to coordinates x:{int} y:{int}
+
+
+
+```gherkin
+When I scroll to coordinates x:{int} y:{int}
+```
+
+---
+
+### **When** I scroll mouse window to position top:{int} left:{int}
+
+
+
+```gherkin
+When I scroll mouse window to position top:{int} left:{int}
+```
+
+---
+
+### **When** I scroll to {string}
+
+
+
+```gherkin
+When I scroll to {string}
+```
+
+---
+
+### **When** I hover over the element {string}
+
+
+
+```gherkin
+When I hover over the element {string}
+```
+
+---
+
+### **When** I move mouse to coordinates {int}, {int}
+
+
+
+```gherkin
+When I move mouse to coordinates {int}, {int}
+```
+
+---
+
+### **When** I hover on ({int})(?:st|nd|rd|th) element ([^]+)
+
+
+
+```gherkin
+When I hover on ({int})(?:st|nd|rd|th) element ([^]+)
+```
+
+---
+
+### **When** I hover on ({int})(?:st|nd|rd|th) selector ([^]+)
+
+
+
+```gherkin
+When I hover on ({int})(?:st|nd|rd|th) selector ([^]+)
+```
+
+---
+
+### **When** I visit {string}
+
+
+
+```gherkin
+When I visit {string}
+```
+
+---
+
+### **When** I reload the page
+
+
+
+```gherkin
+When I reload the page
+```
+
+---
+
+### **When** I go back
+
+
+
+```gherkin
+When I go back
+```
+
+---
+
+### **When** I go forward
+
+
+
+```gherkin
+When I go forward
+```
+
+---
+
+### **When** I navigate to {string}
+
+
+
+```gherkin
+When I navigate to {string}
+```
+
+---
+
+### **When** I wait for network idle
+
+
+
+```gherkin
+When I wait for network idle
+```
+
+---
+
+### **When** I wait for load state {string}
+
+
+
+```gherkin
+When I wait for load state {string}
+```
+
+---
+
+### **When** I wait for element to be visible
+
+
+
+```gherkin
+When I wait for element to be visible
+```
+
+---
+
+### **When** I wait for element to be hidden
+
+
+
+```gherkin
+When I wait for element to be hidden
+```
+
+---
+
+### **When** I wait for URL to contain {string}
+
+
+
+```gherkin
+When I wait for URL to contain {string}
+```
+
+---
+
+### **When** I expect the response status to be {int}
+
+
+
+```gherkin
+When I expect the response status to be {int}
+```
+
+---
+
+### **When** I expect the response body to contain {string}
+
+
+
+```gherkin
+When I expect the response body to contain {string}
+```
+
+---
+
+### **When** I expect the response property {string} to be {string}
+
+
+
+```gherkin
+When I expect the response property {string} to be {string}
+```
+
+---
+
+### **When** I mock the API endpoint {string} with body {string}
+
+
+
+```gherkin
+When I mock the API endpoint {string} with body {string}
+```
+
+---
+
+### **When** I mock the API endpoint {string} with response from {string}
+
+
+
+```gherkin
+When I mock the API endpoint {string} with response from {string}
+```
+
+---
+
+### **When** I mock the API endpoint {string} with status {int}
+
+
+
+```gherkin
+When I mock the API endpoint {string} with status {int}
+```
+
+---
+
+### **When** I intercept URL ([^]+) and stub body:?
+
+
+
+```gherkin
+When I intercept URL ([^]+) and stub body:?
+```
+
+---
+
+### **When** I intercept URL {string} and stub body {string}
+
+
+
+```gherkin
+When I intercept URL {string} and stub body {string}
+```
+
+---
+
+### **When** I intercept URL {string}
+
+
+
+```gherkin
+When I intercept URL {string}
+```
+
+---
+
+### **When** I make request to {string}
+
+
+
+```gherkin
+When I make request to {string}
+```
+
+---
+
+### **When** I make a POST request to ([^]+) with JSON body:?
+
+
+
+```gherkin
+When I make a POST request to ([^]+) with JSON body:?
+```
+
+---
+
+### **When** I make a {word} request to {string}
+
+
+
+```gherkin
+When I make a {word} request to {string}
+```
+
+---
+
+### **When** I make a GET request to {string}
+
+
+
+```gherkin
+When I make a GET request to {string}
+```
+
+---
+
+### **When** I make a DELETE request to {string}
+
+
+
+```gherkin
+When I make a DELETE request to {string}
+```
+
+---
+
+### **When** I make a POST request to {string} with data
+
+
+
+```gherkin
+When I make a POST request to {string} with data
+```
+
+---
+
+### **When** I make a POST request to {string} with payload from {string}
+
+
+
+```gherkin
+When I make a POST request to {string} with payload from {string}
+```
+
+---
+
+### **When** I expect the url to contain {string}
+
+
+
+```gherkin
+When I expect the url to contain {string}
+```
+
+---
+
+### **When** I expect the url to be {string}
+
+
+
+```gherkin
+When I expect the url to be {string}
+```
+
+---
+
+### **When** I expect the title to contain {string}
+
+
+
+```gherkin
+When I expect the title to contain {string}
+```
+
+---
+
+### **When** I expect the title to be {string}
+
+
+
+```gherkin
+When I expect the title to be {string}
+```
+
+---
+
+### **When** I expect {string} to have text {string}
+
+
+
+```gherkin
+When I expect {string} to have text {string}
+```
+
+---
+
+### **When** I expect {string} to contain text {string}
+
+
+
+```gherkin
+When I expect {string} to contain text {string}
+```
+
+---
+
+### **When** I expect {string} to have value {string}
+
+
+
+```gherkin
+When I expect {string} to have value {string}
+```
+
+---
+
+### **When** I expect {string} to have attribute {string} with value {string}
+
+
+
+```gherkin
+When I expect {string} to have attribute {string} with value {string}
+```
+
+---
+
+### **When** I expect element to be visible
+
+
+
+```gherkin
+When I expect element to be visible
+```
+
+---
+
+### **When** I expect {string} to be visible
+
+
+
+```gherkin
+When I expect {string} to be visible
+```
+
+---
+
+### **When** I expect element to be hidden
+
+
+
+```gherkin
+When I expect element to be hidden
+```
+
+---
+
+### **When** I expect element to be enabled
+
+
+
+```gherkin
+When I expect element to be enabled
+```
+
+---
+
+### **When** I expect element to be disabled
+
+
+
+```gherkin
+When I expect element to be disabled
+```
+
+---
+
+### **When** I expect element to have text {string}
+
+
+
+```gherkin
+When I expect element to have text {string}
+```
+
+---
+
+### **When** I expect element to contain text {string}
+
+
+
+```gherkin
+When I expect element to contain text {string}
+```
+
+---
+
+### **When** I expect element to have value {string}
+
+
+
+```gherkin
+When I expect element to have value {string}
+```
+
+---
+
+### **When** I expect element to have attribute {string}
+
+
+
+```gherkin
+When I expect element to have attribute {string}
+```
+
+---
+
+### **When** I expect element to have attribute {string} with value {string}
+
+
+
+```gherkin
+When I expect element to have attribute {string} with value {string}
+```
+
+---
+
+### **When** I expect the page screenshot to match {string}
+
+
+
+```gherkin
+When I expect the page screenshot to match {string}
+```
+
+---
+
+### **When** I expect the element screenshot to match {string}
+
+
+
+```gherkin
+When I expect the element screenshot to match {string}
+```
+
+---
+
+### **When** I save the browser state to {string}
+
+
+
+```gherkin
+When I save the browser state to {string}
+```
+
+---
+
+### **When** I load the browser state from {string}
+
+
+
+```gherkin
+When I load the browser state from {string}
+```
+
+---
+
+### **When** I run the database query {string}
+
+
+
+```gherkin
+When I run the database query {string}
+```
+
+---
+
+### **When** I expect the database to return {int} record(s)
+
+
+
+```gherkin
+When I expect the database to return {int} record(s)
+```
+
+---
+
+### **When** I expect the database to return no records
+
+
+
+```gherkin
+When I expect the database to return no records
+```
+
+---
+
+### **When** I expect the first database record to contain
+
+
+
+```gherkin
+When I expect the first database record to contain
+```
+
+---
+
+### **When** I expect database row {int} to contain
+
+
+
+```gherkin
+When I expect database row {int} to contain
+```
+
+---
+
+### **When** I expect all database records to contain
+
+
+
+```gherkin
+When I expect all database records to contain
+```
+
+---
+
+### **When** I expect database column {string} to exist
+
+
+
+```gherkin
+When I expect database column {string} to exist
+```
+
+---
+
+### **When** I expect database column {string} to contain {string}
+
+
+
+```gherkin
+When I expect database column {string} to contain {string}
+```
+
+---
+
+### **When** I expect database column {string} to be of type {string}
+
+
+
+```gherkin
+When I expect database column {string} to be of type {string}
+```
+
+---
+
+### **When** I accept the next dialog
+
+
+
+```gherkin
+When I accept the next dialog
+```
+
+---
+
+### **When** I dismiss the next dialog
+
+
+
+```gherkin
+When I dismiss the next dialog
+```
+
+---
+
+### **When** I type {string} into the next prompt and accept
+
+
+
+```gherkin
+When I type {string} into the next prompt and accept
+```
+
+---
+
+### **When** I select option {string} from {string}
+
+
+
+```gherkin
+When I select option {string} from {string}
+```
+
+---
+
+### **When** I check {string}
+
+
+
+```gherkin
+When I check {string}
+```
+
+---
+
+### **When** I uncheck {string}
+
+
+
+```gherkin
+When I uncheck {string}
+```
+
+---
+
+### **When** I upload file {string} to {string}
+
+
+
+```gherkin
+When I upload file {string} to {string}
+```
+
+---
+
+### **When** I click {string} inside frame {string}
+
+
+
+```gherkin
+When I click {string} inside frame {string}
+```
+
+---
+
+### **When** I fill {string} inside frame {string} with {string}
+
+
+
+```gherkin
+When I fill {string} inside frame {string} with {string}
+```
+
+---
+
+### **When** I expect {string} inside frame {string} to have text {string}
+
+
+
+```gherkin
+When I expect {string} inside frame {string} to have text {string}
+```
+
+---
+
+
+
 ## 📄 License
 
 MIT © 2024