OverflowScroll

A set of React components that encapsulates the logic from useOverflowScroll for building carousel-like UI components:

  • OverflowScroll
  • OverflowScroll.Items

Sample Usage

The following example demonstrates how to use OverflowScroll and OverflowScroll.Items to build carousel-like UI components.

Theme Variables (SCSS)#

$overflow-scroll-opacity-mask-transparent: var(--pgn-overflow-scroll-opacity-mask-transparent) !default;
OverflowScroll Props API
  • ariaLabel string Required
  • children node Required
  • childQuerySelector string
  • hasInteractiveChildren bool
    Defaultfalse
  • disableScroll bool
    Defaultfalse
  • disableOpacityMasks bool
    Defaultfalse
  • onScrollPrevious func
  • onScrollNext func