Skip to content
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

Add option to toggle aria-hidden attribute for every item within the carousel. #442

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
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
Binary file added .DS_Store
Binary file not shown.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,7 @@ For example if you give to your carousel item padding left and padding right 20p
| rewind | `boolean` |`false` | if infinite is not enabled and autoPlay explicitly is, this option rewinds the carousel when the end is reached (Lightweight infinite mode alternative without cloning).
| rewindWithAnimation | `boolean` |`false` | when rewinding the carousel back to the beginning, this decides if the rewind process should be instant or with transition. |
| rtl | `boolean` |`false` | Sets the carousel direction to be right to left |
| setItemAriaHidden | `boolean` | `true` | Sets the aria-hidden attribute on every item within the carousel. |

## Author

Expand Down
3 changes: 2 additions & 1 deletion src/Carousel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ class Carousel extends React.Component<CarouselProps, CarouselInternalState> {
shouldResetAutoplay: true,
rewind: false,
rtl: false,
rewindWithAnimation: false
rewindWithAnimation: false,
setItemAriaHidden: true
};
private readonly containerRef: React.RefObject<HTMLDivElement>;
private readonly listRef: React.RefObject<HTMLUListElement>;
Expand Down
4 changes: 3 additions & 1 deletion src/CarouselItems.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ const CarouselItems = ({
goToSlide(index);
}
}}
aria-hidden={getIfSlideIsVisbile(index, state) ? "false" : "true"}
{...(props.setItemAriaHidden && {
"aria-hidden": !getIfSlideIsVisbile(index, state)
})}
aria-label={
itemAriaLabel
? itemAriaLabel
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export interface CarouselProps {
rewind?: boolean;
rewindWithAnimation?: boolean;
rtl?: boolean;
setItemAriaHidden: boolean; // set the aria-hidden attribute on every item within the carousel.
}

export type StateCallBack = CarouselInternalState;
Expand Down