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.

Sign up for GitHub

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

Jump to bottom

Carousel indicators position #681

Merged
merged 2 commits into from
Oct 6, 2020
Merged

Carousel indicators position #681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c098b9
Ability to display Carousel indicators in a separate block
AJIXuMuK Oct 5, 2020
c79a19b
indicatorsContainerStyles
AJIXuMuK Oct 6, 2020
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
12 changes: 11 additions & 1 deletion docs/documentation/docs/controls/Carousel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,10 @@ The Carousel component can be configured with the following properties:
| indicatorShape | CarouselIndicatorShape | no | Specifies indicators' shape. If onRenderIndicator is provided - this property is ignored |
| indicatorClassName | string | no | Specifies additional class applied to slide position indicators |
| indicatorStyle | React.CSSProperties | no | Specifies additional styles applied to slide position indicators |
| onRenderIndicator | (index: number, onClick: (e: React.MouseEvent<HTMLElement> | React.TouchEvent<HTMLElement>, selectedIndex: number) => void) => JSX.Element | no | Function to render indicator element |
| onRenderIndicator | (index: number, onClick: (e: React.MouseEvent<HTMLElement> \| React.TouchEvent<HTMLElement>, selectedIndex: number) => void) => JSX.Element | no | Function to render indicator element |
| indicatorsDisplay | CarouselIndicatorsDisplay | no | Specifies display mode of the indicators. Default value `overlap`. |
| rootStyles | ICssInput | no | Allows to specify own styles for root element |
| indicatorsContainerStyles | ICssInput | no | Allows to specify own styles for indicators container when indicatorsDisplay is set to "block" |

enum `CarouselButtonsLocation`

Expand Down Expand Up @@ -160,6 +163,13 @@ Provides options for carousel indicators' shape.
| square | Indicators displayed as squares |
| rectangle | Indicators displayed as rectangles |

enum `CarouselIndicatorsDisplay`

Provides options for carousel indicators display mode.
| Value | Description |
| overlap | Indicators are displayed on top of the carousel content |
| block | Reserves space for indicators |

Interface `ICarouselImageProps`

Allows to easily render a set of `CarouselImage` components in the carousel
Expand Down
Loading