Skip to content

Commit

Permalink
Merge pull request #681 from pnp/carousel-indicators-position
Browse files Browse the repository at this point in the history
Carousel indicators position
  • Loading branch information
AJIXuMuK authored Oct 6, 2020
2 parents 759c6c3 + c79a19b commit 25e2a0f
Show file tree
Hide file tree
Showing 5 changed files with 365 additions and 283 deletions.
12 changes: 11 additions & 1 deletion docs/documentation/docs/controls/Carousel.md
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

0 comments on commit 25e2a0f

Please sign in to comment.