Skip to content

Commit 9f6840c

Browse files
authored
docs(cypress-commands): improve clickUi5SelectOption commands description (#5349)
1 parent 05297a7 commit 9f6840c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

packages/cypress-commands/src/commands.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,21 @@ declare global {
6868

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

7880
/**
7981
* Click on chained `ui5-option`.
80-
* @example cy.get('[ui5-option]').clickUi5SelectOption();
8182
*
82-
* __Note:__ The select popover must be visible, otherwise the `change` event is not fired.
83+
* __Note:__ The select popover must be visible, otherwise it can lead to unwanted side effects.
84+
*
85+
* @example cy.get('[ui5-option]').clickUi5SelectOption();
8386
*/
8487
clickUi5SelectOption(options?: Partial<ClickOptions>): Chainable<Element>;
8588
}

0 commit comments

Comments
 (0)