1.0.0-alpha.2 • Published 3 years ago

@talixo/carousel v1.0.0-alpha.2

Weekly downloads
8
License
MIT
Repository
github
Last release
3 years ago

Talixo Carousel

UI Component which represents Carousel

How to install

Package is available as @talixo/carousel in NPM registry, so you can use it in your project using npm install @talixo/carousel --save or yarn add @talixo/carousel.

Requirements

Your package should additionally have some extra dependencies:

  • prop-types: ^15.6.1
  • react: ^16.2.0
  • react-dom: ^16.2.0
  • @talixo/shared: ^0.1.0
  • @talixo/icon: ^0.1.1

These packages are required by @talixo/carousel, but you have to install them manually, to avoid having different versions of these in your application.

Supported props

Carousel

It handles all props which can be passed to div. Also, handles some differently:

Property nameTypeDefaultDescription
arrowsbooln/aArrows to navigate between slides
childrennodesn/aElements in each slides
classNamestringn/aAdditional class name passed to wrapper
dotsbooln/aDots to navigate between slides
animationTimenumber500Duration of animation (in ms)
perPagenumber1Number of visible slides
renderDotsfunctionDotsFunction which render custom dots
renderArrowsfunctionArrowsFunction which render custom arrows
valuenumberself-controlledIndex of currently selected slide element
onChangefunctionn/aEvent handler for change of slide
defaultMovementstring"exact"Default behavior of movement (for controlled component), when neither dots nor arrows were clicked, one of: exact, forward, back

CarouselAutoplay

Property nameTypeDefaultDescription
intervalnumber3000Time in milliseconds to go to next slide
movementstring"forward"Movement behavior, one of: exact, forward, back
childrennoden/aCarousel element, which should have auto-play behavior
initialSlidenumberget from carousel' valueSlide where it should start on
stepnumberget from carousel' perPageNumbers of slides to move each interval

Changelog

  • 0.1.0 - initial version
1.0.0-alpha.35

3 years ago

1.0.0-alpha.31

3 years ago

1.0.0-alpha.30

3 years ago

1.0.0-alpha.27

3 years ago

1.0.0-alpha.24

3 years ago

1.0.0-alpha.21

4 years ago

1.0.0-alpha.20

4 years ago

1.0.0-alpha.19

4 years ago

1.0.0-alpha.18

4 years ago

1.0.0-alpha.16

4 years ago

1.0.0-alpha.12

4 years ago

1.0.0-alpha.9

4 years ago

1.0.0-alpha.8

4 years ago

1.0.0-alpha.7

4 years ago

1.0.0-alpha.6

4 years ago

1.0.0-alpha.5

4 years ago

1.0.0-alpha.4

4 years ago

1.0.0-alpha.3

4 years ago

1.0.0-alpha.2

4 years ago