Skip to content

Commit ac00ee0

Browse files
committed
docs(ui5-carousel): add documentation for hidden items behavior
JIRA:BGSOFUIRODOPI-3548 Related with #12498
1 parent 7f0faed commit ac00ee0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

packages/main/src/Carousel.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,12 @@ type ItemsInfo = {
8484
* - The items you want to display need to be visible at the same time.
8585
* - The items you want to display are uniform and very similar.
8686
*
87+
* ### Hidden Items
88+
*
89+
* Carousel items can be conditionally hidden by adding the `hidden` attribute to any child element.
90+
* Hidden items are automatically excluded from the carousel navigation and will not be displayed or counted in pagination.
91+
* This allows for dynamic showing/hiding of carousel items without affecting the overall carousel behavior.
92+
*
8793
* ### Keyboard Handling
8894
*
8995
* #### Basic Navigation
@@ -307,6 +313,9 @@ class Carousel extends UI5Element {
307313

308314
/**
309315
* Defines the content of the component.
316+
*
317+
* **Note:** Items with the `hidden` attribute will be automatically excluded from carousel navigation,
318+
* page calculations, and will not be displayed or accessible via keyboard navigation.
310319
* @public
311320
*/
312321
@slot({ "default": true, type: HTMLElement, individualSlots: true })

0 commit comments

Comments
 (0)