|
13 | 13 |
|
14 | 14 | <p align="center">
|
15 | 15 | <strong>
|
16 |
| - <a href="https://brainhubeu.github.io/react-carousel/">Live code demo</a> | |
| 16 | + <a href="https://beghp.github.io/gh-pages-rc-v1">Live code demo</a> | |
17 | 17 | <a href="https://brainhub.eu/contact/">Hire us</a>
|
18 | 18 | </strong>
|
19 | 19 | </p>
|
@@ -108,7 +108,7 @@ export default class MyCarousel extends Component {
|
108 | 108 | }
|
109 | 109 | ```
|
110 | 110 |
|
111 |
| -[](https://brainhubeu.github.io/react-carousel/docs/examples/simpleUsage) |
| 111 | +[](https://beghp.github.io/gh-pages-rc-v1/docs/examples/simpleUsage) |
112 | 112 |
|
113 | 113 | ### Showing dots or thumbnails
|
114 | 114 | There is a separate Dots component that can be used to fully control navigation dots or add thumbnails.
|
@@ -152,51 +152,51 @@ render() {
|
152 | 152 | }
|
153 | 153 | ```
|
154 | 154 |
|
155 |
| -[](https://brainhubeu.github.io/react-carousel/docs/examples/thumbnails) |
| 155 | +[](https://beghp.github.io/gh-pages-rc-v1/docs/examples/thumbnails) |
156 | 156 |
|
157 | 157 | ## Props
|
158 |
| -You can access a clickable demo with many examples and a [live code editor](https://brainhubeu.github.io/react-carousel/) by clicking on a Prop name. |
| 158 | +You can access a clickable demo with many examples and a [live code editor](https://beghp.github.io/gh-pages-rc-v1/) by clicking on a Prop name. |
159 | 159 |
|
160 | 160 | ### Carousel props
|
161 | 161 |
|
162 | 162 | | Prop | Type | Default | Description |
|
163 | 163 | | --- | --- | --- | --- |
|
164 |
| -| [**addArrowClickHandler**](https://brainhubeu.github.io/react-carousel/docs/examples/customArrows) | *Boolean* | `undefined` | Has to be added for arrowLeft and arrowRight to work | |
165 |
| -| [**animationSpeed**](https://brainhubeu.github.io/react-carousel/docs/examples/animation) | *Number* | `500` | Determines transition duration in milliseconds | |
166 |
| -| [**arrowLeft**](https://brainhubeu.github.io/react-carousel/docs/examples/customArrows) | *React element* | `undefined` | To be used instead of the default left arrow (if you provide these custom arrows, you don't have to use arrows prop) | |
167 |
| -| [**arrowRight**](https://brainhubeu.github.io/react-carousel/docs/examples/customArrows) | *React element* | `undefined` | To be used instead of the default right arrow (if you provide these custom arrows, you don't have to use arrows prop) | |
168 |
| -| [**arrows**](https://brainhubeu.github.io/react-carousel/docs/examples/defaultArrows) | *Boolean* | `false` | Renders default arrows | |
169 |
| -| [**autoPlay**](https://brainhubeu.github.io/react-carousel/docs/examples/animation) | *Number* | `undefined` | Slide change interval in milliseconds | |
170 |
| -| [**breakpoints**](https://brainhubeu.github.io/react-carousel/docs/examples/responsive) | *Object* | `undefined` | All props (except of `value`, `onChange`, `responsive`, `children`) can be set to different values on different screen resolutions | |
171 |
| -| [**centered**](https://brainhubeu.github.io/react-carousel/docs/examples/centered) | *Boolean* | `undefined` | Aligned active slide to the center of the carousel | |
172 |
| -| [**clickToChange**](https://brainhubeu.github.io/react-carousel/docs/examples/clickToChange) | *Boolean* | `undefined` | Clicking on a slide changes current slide to the clicked one | |
173 |
| -| [**dots**](https://brainhubeu.github.io/react-carousel/docs/examples/simpleDots) | *Boolean* | `undefined` | Renders default dots under the carousel | |
174 |
| -| [**draggable**](https://brainhubeu.github.io/react-carousel/docs/examples/draggable) | *Boolean* | `true` | Makes it possible to drag to the next slide with mouse cursor | |
| 164 | +| [**addArrowClickHandler**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/customArrows) | *Boolean* | `undefined` | Has to be added for arrowLeft and arrowRight to work | |
| 165 | +| [**animationSpeed**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/animation) | *Number* | `500` | Determines transition duration in milliseconds | |
| 166 | +| [**arrowLeft**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/customArrows) | *React element* | `undefined` | To be used instead of the default left arrow (if you provide these custom arrows, you don't have to use arrows prop) | |
| 167 | +| [**arrowRight**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/customArrows) | *React element* | `undefined` | To be used instead of the default right arrow (if you provide these custom arrows, you don't have to use arrows prop) | |
| 168 | +| [**arrows**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/defaultArrows) | *Boolean* | `false` | Renders default arrows | |
| 169 | +| [**autoPlay**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/animation) | *Number* | `undefined` | Slide change interval in milliseconds | |
| 170 | +| [**breakpoints**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/responsive) | *Object* | `undefined` | All props (except of `value`, `onChange`, `responsive`, `children`) can be set to different values on different screen resolutions | |
| 171 | +| [**centered**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/centered) | *Boolean* | `undefined` | Aligned active slide to the center of the carousel | |
| 172 | +| [**clickToChange**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/clickToChange) | *Boolean* | `undefined` | Clicking on a slide changes current slide to the clicked one | |
| 173 | +| [**dots**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/simpleDots) | *Boolean* | `undefined` | Renders default dots under the carousel | |
| 174 | +| [**draggable**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/draggable) | *Boolean* | `true` | Makes it possible to drag to the next slide with mouse cursor | |
175 | 175 | | **onInit** | *Function* | `undefined` | Callback thrown after the carousel is loaded |
|
176 |
| -| [**infinite**](https://brainhubeu.github.io/react-carousel/docs/examples/infinite) | *Boolean* | `undefined` | Creates an infinite carousel width | |
| 176 | +| [**infinite**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/infinite) | *Boolean* | `undefined` | Creates an infinite carousel width | |
177 | 177 | | **itemWidth** | *Number* | `undefined` | Determines custom width for every slide in the carousel |
|
178 |
| -| [**keepDirectionWhenDragging**](https://brainhubeu.github.io/react-carousel/docs/examples/draggable) | *Boolean* | `undefined` | While dragging, it doesn't matter which slide is the nearest one, but in what direction you dragged | |
| 178 | +| [**keepDirectionWhenDragging**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/draggable) | *Boolean* | `undefined` | While dragging, it doesn't matter which slide is the nearest one, but in what direction you dragged | |
179 | 179 | | **minDraggableOffset** | *Number* | `10` | Defines the minimum offset to consider the drag gesture |
|
180 | 180 | | **offset** | *Number* | `0` | Padding between items |
|
181 |
| -| [**onChange**](https://brainhubeu.github.io/react-carousel/docs/examples/controlled) | *Function* | `undefined` | Handler triggered when current slide is about to change (e.g. on arrow click or on swipe) | |
182 |
| -| [**rtl**](https://brainhubeu.github.io/react-carousel/docs/examples/rtl) | *Boolean* | `false` | Indicating if the carousel should have direction from Right to Left (make sure to pass the `rtl` param to the `Dots` component as well) | |
| 181 | +| [**onChange**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/controlled) | *Function* | `undefined` | Handler triggered when current slide is about to change (e.g. on arrow click or on swipe) | |
| 182 | +| [**rtl**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/rtl) | *Boolean* | `false` | Indicating if the carousel should have direction from Right to Left (make sure to pass the `rtl` param to the `Dots` component as well) | |
183 | 183 | | **slides** | *Array* | `undefined` | Alternative way to pass slides. This prop expects an array of JSX <img> elements |
|
184 |
| -| [**slidesPerPage**](https://brainhubeu.github.io/react-carousel/docs/examples/multipleItems) | *Number* | `1` | Number of slides visible at once | |
185 |
| -| [**slidesPerScroll**](https://brainhubeu.github.io/react-carousel/docs/examples/slidesPerScroll) | *Number* | `1` | Number by which value will change on scroll (autoPlay, arrow click, drag)| |
186 |
| -| [**lazyLoad**](https://brainhubeu.github.io/react-carousel/docs/examples/lazyload) | *Boolean* | `false` | Initially, it loads only the closest next / previous slide to the current one based on the value of the slidesPerPage variable. Other slides are loaded as needed. | |
| 184 | +| [**slidesPerPage**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/multipleItems) | *Number* | `1` | Number of slides visible at once | |
| 185 | +| [**slidesPerScroll**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/slidesPerScroll) | *Number* | `1` | Number by which value will change on scroll (autoPlay, arrow click, drag)| |
| 186 | +| [**lazyLoad**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/lazyload) | *Boolean* | `false` | Initially, it loads only the closest next / previous slide to the current one based on the value of the slidesPerPage variable. Other slides are loaded as needed. | |
187 | 187 | | **lazyLoader** | *React node* | `undefined` | To be used instead of the default loader |
|
188 | 188 | | **stopAutoPlayOnHover** | *Boolean* | `undefined` | Determines if autoPlay should stop when mouse hover over carousel |
|
189 |
| -| [**value**](https://brainhubeu.github.io/react-carousel/docs/examples/controlled) | *Number* | `undefined` | Current slide's index (zero based, depends on the elements order) | |
| 189 | +| [**value**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/controlled) | *Number* | `undefined` | Current slide's index (zero based, depends on the elements order) | |
190 | 190 |
|
191 | 191 | ### Dots props
|
192 | 192 |
|
193 | 193 | | Prop | Type | Default | Description |
|
194 | 194 | | --- | --- | --- | --- |
|
195 |
| -| [**number**](https://brainhubeu.github.io/react-carousel/docs/examples/dots) | *Number* | Amount of slides | Number of slides in the carousel you want to control | |
196 |
| -| [**onChange**](https://brainhubeu.github.io/react-carousel/docs/examples/dots) | *Function* | `undefined` | `onChange` callback (works the same way as `onChange` in `Carousel` component) | |
| 195 | +| [**number**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/dots) | *Number* | Amount of slides | Number of slides in the carousel you want to control | |
| 196 | +| [**onChange**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/dots) | *Function* | `undefined` | `onChange` callback (works the same way as `onChange` in `Carousel` component) | |
197 | 197 | | **rtl** | *Boolean* | `false` | Indicating if the dots should have direction from Right to Left |
|
198 |
| -| [**thumbnails**](https://brainhubeu.github.io/react-carousel/docs/examples/thumbnails) | *Array of ReactElements* | `undefined` | Array of thumbnails to show. If not provided, default dots will be shown | |
199 |
| -| [**value**](https://brainhubeu.github.io/react-carousel/docs/examples/dots) | *Number* | slide position in the slides Array | Current `Carousel` value | |
| 198 | +| [**thumbnails**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/thumbnails) | *Array of ReactElements* | `undefined` | Array of thumbnails to show. If not provided, default dots will be shown | |
| 199 | +| [**value**](https://beghp.github.io/gh-pages-rc-v1/docs/examples/dots) | *Number* | slide position in the slides Array | Current `Carousel` value | |
200 | 200 |
|
201 | 201 | ## Contributing
|
202 | 202 | [The GitHub issues list](https://github.com/brainhubeu/react-carousel/issues) is our roadmap.
|
@@ -238,13 +238,13 @@ yarn test:e2e
|
238 | 238 | ```
|
239 | 239 |
|
240 | 240 | ### Workflow
|
241 |
| -See [the Workflow subsection in our docs](https://brainhubeu.github.io/react-carousel/docs/contributions-guide/workflow) |
| 241 | +See [the Workflow subsection in our docs](https://beghp.github.io/gh-pages-rc-v1/docs/contributions-guide/workflow) |
242 | 242 |
|
243 | 243 | ### Labels
|
244 |
| -See [the Labels subsection in our docs](https://brainhubeu.github.io/react-carousel/docs/contributions-guide/labels) |
| 244 | +See [the Labels subsection in our docs](https://beghp.github.io/gh-pages-rc-v1/docs/contributions-guide/labels) |
245 | 245 |
|
246 | 246 | ### Decision log
|
247 |
| -See [the Decision log subsection in our docs](https://brainhubeu.github.io/react-carousel/docs/contributions-guide/decision-log) |
| 247 | +See [the Decision log subsection in our docs](https://beghp.github.io/gh-pages-rc-v1/docs/contributions-guide/decision-log) |
248 | 248 |
|
249 | 249 | ## License
|
250 | 250 |
|
|
0 commit comments