From 293798c8c3a548be76c6e0c2e0a1306cf2fc85b0 Mon Sep 17 00:00:00 2001 From: Vadim Date: Sat, 3 Jul 2021 23:04:10 +0300 Subject: [PATCH] #31 : Extend docs --- README.md | 25 +++++++++++++------------ src/docs/Carousel.svx | 25 +++++++++++++------------ 2 files changed, 26 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 5715a3b..85d3a01 100644 --- a/README.md +++ b/README.md @@ -34,18 +34,19 @@ Import component ``` ## Props -| Prop | Type | Default | Description | -|----------------------|------------|-----------------|-----------------------------------------------| -| `arrows` | `boolean` | `true` | Enable Next/Prev arrows | -| `infinite` | `boolean` | `true` | Infinite looping | -| `initialPageIndex` | `number` | `0` | Page to start on | -| `duration` | `number` | `500` | Transition duration (ms) | -| `autoplay` | `boolean` | `false` | Enables auto play of pages | -| `autoplayDuration` | `number` | `3000` | Autoplay change interval (ms) | -| `autoplayDirection` | `string` | `'next'` | Autoplay change direction (`next` or `prev`) | -| `pauseOnFocus` | `boolean` | `false` | Pause autoplay on focus | -| `dots` | `boolean` | `true` | Current page indicator dots | -| `timingFunction` | `string` | `'ease-in-out'` | CSS animation timing function | +| Prop | Type | Default | Description | +|---------------------------|------------|-----------------|-----------------------------------------------| +| `arrows` | `boolean` | `true` | Enable Next/Prev arrows | +| `infinite` | `boolean` | `true` | Infinite looping | +| `initialPageIndex` | `number` | `0` | Page to start on | +| `duration` | `number` | `500` | Transition duration (ms) | +| `autoplay` | `boolean` | `false` | Enables auto play of pages | +| `autoplayDuration` | `number` | `3000` | Autoplay change interval (ms) | +| `autoplayDirection` | `string` | `'next'` | Autoplay change direction (`next` or `prev`) | +| `pauseOnFocus` | `boolean` | `false` | Pause autoplay on focus | +| `autoplayProgressVisible` | `boolean` | `false` | Show autoplay duration progress indicator | +| `dots` | `boolean` | `true` | Current page indicator dots | +| `timingFunction` | `string` | `'ease-in-out'` | CSS animation timing function | ## Events diff --git a/src/docs/Carousel.svx b/src/docs/Carousel.svx index 2d0294f..93e9699 100644 --- a/src/docs/Carousel.svx +++ b/src/docs/Carousel.svx @@ -262,18 +262,19 @@ Import component
-| Prop | Type | Default | Description | -|----------------------|------------|-----------------|-----------------------------------------------| -| `arrows` | `boolean` | `true` | Enable Next/Prev arrows | -| `infinite` | `boolean` | `true` | Infinite looping | -| `initialPageIndex` | `number` | `0` | Page to start on | -| `duration` | `number` | `500` | Transition duration (ms) | -| `autoplay` | `boolean` | `false` | Enables auto play of pages | -| `autoplayDuration` | `number` | `3000` | Autoplay change interval (ms) | -| `autoplayDirection` | `string` | `'next'` | Autoplay change direction (`next` or `prev`) | -| `pauseOnFocus` | `boolean` | `false` | Pause autoplay on focus | -| `dots` | `boolean` | `true` | Current page indicator dots | -| `timingFunction` | `string` | `'ease-in-out'` | CSS animation timing function | +| Prop | Type | Default | Description | +|---------------------------|------------|-----------------|-----------------------------------------------| +| `arrows` | `boolean` | `true` | Enable Next/Prev arrows | +| `infinite` | `boolean` | `true` | Infinite looping | +| `initialPageIndex` | `number` | `0` | Page to start on | +| `duration` | `number` | `500` | Transition duration (ms) | +| `autoplay` | `boolean` | `false` | Enables auto play of pages | +| `autoplayDuration` | `number` | `3000` | Autoplay change interval (ms) | +| `autoplayDirection` | `string` | `'next'` | Autoplay change direction (`next` or `prev`) | +| `pauseOnFocus` | `boolean` | `false` | Pause autoplay on focus | +| `autoplayProgressVisible` | `boolean` | `false` | Show autoplay duration progress indicator | +| `dots` | `boolean` | `true` | Current page indicator dots | +| `timingFunction` | `string` | `'ease-in-out'` | CSS animation timing function |