sdob / reactscrollarea Goto Github PK

Simple ScrollArea component built for React.

Demo: https://mishantrop.github.io/reactScrollareaDemo/

yarn add react-scrollarea

React Scrollarea requires React 0.15 or React 0.16

Features:

• built with and for React
• horizontal and vertical scrollbars
• touch support
• scrollbar dragging and clicking
• smooth scrolling
• universal app support
• customizable styles
• and more...

import ScrollArea from 'react-scrollarea/src/js/ScrollAreaWithoutCss';
...
<ScrollArea
  className={'scrollarea'}
  contentClassName={'scrollarea-content'}
  smoothScrolling
  speed={0.8}
  verticalContainerClassName={'scrollbar-container'}
  verticalContainerClassNameActive={'scrollbar-container--active'}
  verticalContainerClassNameHorizontal={'scrollbar-container--horizontal'}
  verticalContainerClassNameVertical={'scrollbar-container--vertical'}
  verticalScrollbarClassName={'scrollbar'}
>
  Hello
</ScrollArea>

If you prefer including scrollarea without css styles boundled inline to js file it's possible to import package without them. It's useful when you want to make custom css changes in scrollbars without using !important in each line.

import ScrollArea from 'react-scrollarea/src/js/ScrollAreaWithoutCss';

Then include css-file file into your project.

git clone https://github.com/mishantrop/reactScrollarea.git
cd reactScrollarea
yarn
gulp watch

then open http://localhost:8003.

ScrollArea component has now full universal app support. It's only one requirement: you have to use react-scrollbar in no-css version and then include css file into your project manually (see this). It's because of issue in webpack style-loader which is used to bundle css styles into main js file.

<ScrollArea
    className={String}
    contentClassName={String}
    contentStyle={Object}
    contentWindow={Object}
    focusableTabIndex={Number}
    horizontal={Boolean}
    horizontalContainerClassNameActive={String}
    horizontalContainerStyle={Object}
    horizontalSContainerClassName={String},
    horizontalScrollbarClassName={String},
    horizontalScrollbarStyle={Object}
    minScrollSize={Number}
    onScroll={(value) => {}}
    ownerDocument={Object}
    smoothScrolling={Boolean}
    speed={Number}
    stopScrollPropagation={Boolean}
    style={Object}
    swapWheelAxes={Boolean}
    vertical={Boolean}
    verticalContainerClassName={String}
    verticalContainerClassNameActive={String}
    verticalContainerStyle={Object}
    verticalScrollbarClassName={String}
    verticalScrollbarStyle={Object}
/>

Scroll speed applied to mouse wheel event. Default: 1

onScroll(value: Object) event which can notify the parent component when the container scrolls.

• value: Object - informations about current position
• value.leftPosition: Number - content left position (distance in pixels from the left side of container)
• value.topPosition: Number - content top position (distance in pixels from the top of container)
• value.containerHeight: Number - container height
• value.containerWidth: Number - container width
• value.realHeight: Number - real content height
• value.realWidth: Number - real content width

CSS class names added to main scroll area component.

Inline styles applied to the main scroll area component.

CSS class names added to element with scroll area content.

Inline styles applied to element with scroll area content.

When set to false, horizontal scrollbar will not be available. Default: true

Inline styles applied to horizontal scrollbar's container.

Inline styles applied to horizontal scrollbar.

When set to false, vertical scrollbar will not be available, regardless of the content height. Default: true

Inline styles applied to vertical scrollbar's container.

Inline styles applied to vertical scrollbar.

You can override window to make scrollarea works inside iframe. Default: window

You can override document to make scrollarea works inside iframe. Default: document

When set to true, smooth scrolling for both scrollbars is enabled. Default: false

Using this prop it's possible to set minimal size in px for both scrollbars.

After set to true, mouse wheel event has swapped directions. So normal scrolling moves horizontal scrollbar and scrolling with SHIFT key moves vertical scrollbar. It could be useful for applications with horizontal layout. Default: false

After set to true, mouse wheel event will not propagate. This option is specifically useful in preventing nested scroll areas from propagating scroll actions to parent scroll areas. Default: false

After set to a number, scrollarea-content is rendered with a tabindex value set to the passed in. This option is specifically useful in allowing the scroll area to be focusable. Default: undefined

It allows to scroll to the top of ScrollArea component.

It allows to scroll to the bottom of ScrollArea component.

It moves vertical scrollbar. topPosition is a distance between the top of scrollArea container and the top of scrollArea content.

It allows to scroll to the left of ScrollArea component.

It allows to scroll to the right of ScrollArea component.

It moves horizontal scrollbar. leftPosition is a distance between left edge of scrollArea container and left edge of scrollArea content.