Skip to content

Commit 554a738

Browse files
Pieter Bogaertsfritz-c
andauthored
docs: update ref documentation (#1013)
* docs: update ref documentation * Update docs/api.mdx Co-authored-by: Fritz <4413963+fritz-c@users.noreply.github.com> --------- Co-authored-by: Fritz <4413963+fritz-c@users.noreply.github.com>
1 parent 22fbc4d commit 554a738

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

docs/api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,6 @@ ___
9696
### `frameAriaLabel`
9797
A `string` for the aria-label of the frame container of the carousel. This is useful when you have more than one carousel on the page. The default value is an empty string.
9898

99-
___
100-
101-
### `innerRef`
102-
A React ref object `MutableRefObject<HTMLDivElement>` for carousel element.
103-
10499
---
105100

106101
### `keyCodeConfig`
@@ -136,6 +131,11 @@ ___
136131
### `onUserNavigation`
137132
A function `(props: Pick<CarouselState, 'currentSlide' | 'count'>) => string` to render the message in the ARIA live region that is announcing the current slide on slide change.
138133

134+
___
135+
136+
### `ref`
137+
A React ref object `MutableRefObject<HTMLDivElement | null>` for carousel element.
138+
139139
---
140140

141141
### `renderTopLeftControls`

0 commit comments

Comments
 (0)