cypress-cucumber-steps/src/queries/input.ts

Cypress Cucumber step definitions

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

import { Element } from '../constants';
import { getByLabelText, setCypressElement } from '../utils';

/**
 * When I find input by label text:
 *
 * ```gherkin
 * When I find input by label text {string}
 * ```
 *
 * Finds the first input element that matches the label text.
 *
 * @example
 *
 * ```gherkin
 * When I find input by label text "Email"
 * ```
 *
 * With [options](https://docs.cypress.io/api/commands/get#Arguments):
 *
 * ```gherkin
 * When I find input by label text "Email"
 *   | log | true |
 *   | timeout | 4000 |
 *   | withinSubject | null |
 *   | includeShadowDom | false |
 *   | pseudoSelector | visible |
 * ```
 *
 * @remarks
 *
 * This precedes steps like {@link Then_I_see_value | "Then I see value"}. For example:
 *
 * ```gherkin
 * When I find input by label text "Email"
 * Then I see value "user@example.com"
 * ```
 *
 * Inspired by Testing Library's [ByLabelText](https://testing-library.com/docs/queries/bylabeltext).
 *
 * @see
 *
 * - {@link When_I_find_element_by_label_text | When I find element by label text }
 */
export function When_I_find_input_by_label_text(
  text: string,
  options?: DataTable,
) {
  setCypressElement(getByLabelText(Element.input, text, options));
}

When('I find input by label text {string}', When_I_find_input_by_label_text);