cypress-cucumber-steps/src/actions/type.ts

Cypress Cucumber step definitions

import { DataTable, When } from '@badeball/cypress-cucumber-preprocessor';

import { getCypressElement, getOptions } from '../utils';

/**
 * When I type:
 *
 * ```gherkin
 * When I type {string}
 * ```
 *
 * @example
 *
 * ```gherkin
 * When I type "Hello, world!"
 * ```
 *
 * With [options](https://docs.cypress.io/api/commands/type#Arguments):
 *
 * ```gherkin
 * When I type "Hello, world!"
 *   | animationDistanceThreshold | 5 |
 *   | delay | 10 |
 *   | force | false |
 *   | log | true |
 *   | parseSpecialCharSequences | true |
 *   | release | true |
 *   | scrollBehavior | top |
 *   | timeout | 4000 |
 *   | waitForAnimations | true |
 * ```
 *
 * @remarks
 *
 * A preceding step like {@link When_I_find_element_by_label_text | "When I find element by label text"} is required. For example:
 *
 * ```gherkin
 * When I find element by label text "Email"
 *   And I type "user@example.com"
 * ```
 *
 * Text may include [special character sequences](https://docs.cypress.io/api/commands/type#Syntax). For example:
 *
 * ```gherkin
 * # types the Enter key
 * When I type "{enter}"
 * ```
 */
export function When_I_type(text: string, options?: DataTable) {
  getCypressElement().type(text, getOptions(options));
}

When('I type {string}', When_I_type);