Skip to content

Latest commit

 

History

History
54 lines (44 loc) · 2.75 KB

v8-upgrade-guide.mdx

File metadata and controls

54 lines (44 loc) · 2.75 KB
Raw
sidebar_position
3

import Link from '@docusaurus/Link';

v8 Upgrade Guide

Nuka v8 was rewritten with simplicity and native support in mind. Many props have been removed or renamed to make the API easier to understand and use. This guide will help you upgrade your v7 carousel to v8.

Changed Props

  • afterSlide - API signature changed from v7. See the callbacks for more information.
  • beforeSlide - API signature changed from v7. See the callbacks for more information.
  • carouselId - Use the id prop instead.
  • disableAnimation - See the navigation docs for the autoPlay property.
  • dragging - Enabled by default, see the swiping docs for the swiping property.
  • enableKeyboardControls - Enabled by default, see the accessibility docs for the keyboard property.
  • frameAriaLabel - Replaced by the title prop. See the accessibility docs.
  • slidesToScroll - Renamed to scrollDistance. See the scrolling docs for more information.

Removed Props

The following props were removed becuase they are no longer valid or replaced by built in functionality. If there is any functionality lost, we may consider adding some of these back in the future.

  • adaptiveHeight - The carousel will adapt automatically to the height of the items in the carousel without the need of this prop.
  • adaptiveHeightAnimation - The carousel will adapt automatically to the height of the items in the carousel without the need of this prop.
  • cellAlign - Controlled through CSS. See the style guide.
  • cellSpacing - Controlled through CSS. See the style guide.
  • defaultControlsConfig- Replaced by various properties like showArrows, showDots, arrows, dots.
  • disableEdgeSwiping
  • dragThreshold - this defaults to the OS/browser settings.
  • easing
  • edgeEasing
  • keyCodeConfig
  • landmark
  • onDragStart
  • onDrag
  • onDragEnd
  • onUserNavigation
  • pauseOnHover - Enabled by default. See the autoplay docs.
  • renderTop{direction}Controls
  • scrollMode - Defaults to remainder.
  • slideIndex
  • slidesToShow - Now based on media queries and how large the slides are.
  • speed - Controlled by native browser settings.
  • style - See the style guide.
  • tabbed - Enabled by default, see the accessibility docs
  • withoutControls- Replaced by various properties like showArrows, showDots, arrows, dots.
  • zoomScale