Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • SS

Hierarchy

Index

Properties

Private isHiddenScrollbar

isHiddenScrollbar: boolean = false

Private scroller

scroller: HTMLDivElement = null

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

componentDidUpdate

  • componentDidUpdate(): void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps>, prevState: Readonly<IState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

Private hideScroll

  • hideScroll(element: HTMLDivElement): void

Private onScroll

  • onScroll(__namedParameters: { currentTarget: EventTarget & HTMLDivElement }): void

Private onScrollerRef

  • onScrollerRef(ref: HTMLDivElement): void

Private onWheel

  • onWheel(event: WheelEvent<HTMLDivElement>): void

render

  • render(): Element

Private setShadow

  • setShadow(element: HTMLDivElement): void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<IProps>
    • nextState: Readonly<IState>
    • nextContext: any

    Returns boolean

Object literals

state

state: object

bottomShadow

bottomShadow: boolean = false

leftShadow

leftShadow: boolean = false

rightShadow

rightShadow: boolean = false

topShadow

topShadow: boolean = false

Static defaultProps

defaultProps: object

hideXScrollbar

hideXScrollbar: boolean = false

hideYScrollbar

hideYScrollbar: boolean = false

ignoreBottomShadow

ignoreBottomShadow: boolean = false

ignoreLeftShadow

ignoreLeftShadow: boolean = false

ignoreRightShadow

ignoreRightShadow: boolean = false

ignoreTopShadow

ignoreTopShadow: boolean = false

y2xScroll

y2xScroll: boolean = false

Static propTypes

propTypes: object

children

children: Requireable<string | number | false | true | {} | ReactElementLike | ReactNodeArray> = PropTypes.node

hideXScrollbar

hideXScrollbar: Requireable<boolean> = PropTypes.bool

hideYScrollbar

hideYScrollbar: Requireable<boolean> = PropTypes.bool

ignoreBottomShadow

ignoreBottomShadow: Requireable<boolean> = PropTypes.bool

ignoreLeftShadow

ignoreLeftShadow: Requireable<boolean> = PropTypes.bool

ignoreRightShadow

ignoreRightShadow: Requireable<boolean> = PropTypes.bool

ignoreTopShadow

ignoreTopShadow: Requireable<boolean> = PropTypes.bool

y2xScroll

y2xScroll: Requireable<boolean> = PropTypes.bool

Generated using TypeDoc