Skip to content

docs(cypress-commands): improve clickUi5SelectOption commands description #5349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 15, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions packages/cypress-commands/src/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,18 +68,21 @@ declare global {

/**
* Click on an `ui5-option` of the `ui5-select` component by text.
*
* __Note:__ The select popover must be visible, otherwise it can lead to unwanted side effects.
*
* @param text text of the ui5-option that should be clicked
* @example cy.get('[ui5-select]').clickUi5SelectOptionByText('Option2');
*
* __Note:__ The select popover must be visible, otherwise the `change` event is not fired.
*/
clickUi5SelectOptionByText(text: string, options?: Partial<ClickOptions>): Chainable<Element>;

/**
* Click on chained `ui5-option`.
* @example cy.get('[ui5-option]').clickUi5SelectOption();
*
* __Note:__ The select popover must be visible, otherwise the `change` event is not fired.
* __Note:__ The select popover must be visible, otherwise it can lead to unwanted side effects.
*
* @example cy.get('[ui5-option]').clickUi5SelectOption();
*/
clickUi5SelectOption(options?: Partial<ClickOptions>): Chainable<Element>;
}
Expand Down