Class Scroller

Hierarchy

BaseComponent<ScrollerProps>
- Scroller

Implements

ScrollerLike

Constructors

constructor

new Scroller(props?: ScrollerProps, context?: any): Scroller

Inherited from BaseComponent.constructor
Parameters
- Optional props: ScrollerProps
- Optional context: any
Returns Scroller

Properties

Optional base

base?: Element | Text

context

context: ViewContext

debug

debug: boolean

Private el

el: any

handleEl

handleEl: ((el: HTMLElement) => void)

Type declaration

- (el: HTMLElement): void
- Parameters
  - el: HTMLElement
  Returns void

propEquality

propEquality: EqualityFuncs<ScrollerProps>

props

props: RenderableProps<ScrollerProps, any>

state

state: Readonly<Dictionary>

stateEquality

stateEquality: EqualityFuncs<Dictionary>

Static addPropsEquality

addPropsEquality: ((this: { prototype: { propEquality: any } }, propEquality: any) => void)

Type declaration

- (this: { prototype: { propEquality: any } }, propEquality: any): void
- Parameters
  - this: { prototype: { propEquality: any } }
    - prototype: { propEquality: any }
      - propEquality: any
  - propEquality: any
  Returns void

Static addStateEquality

addStateEquality: ((this: { prototype: { stateEquality: any } }, stateEquality: any) => void)

Type declaration

- (this: { prototype: { stateEquality: any } }, stateEquality: any): void
- Parameters
  - this: { prototype: { stateEquality: any } }
    - prototype: { stateEquality: any }
      - stateEquality: any
  - stateEquality: any
  Returns void

Static contextType

contextType: any

Static Optional defaultProps

defaultProps?: any

Static Optional displayName

displayName?: string

Methods

Optional componentDidCatch

componentDidCatch(error: any, errorInfo: ErrorInfo): void

Inherited from BaseComponent.componentDidCatch
Parameters
- error: any
- errorInfo: ErrorInfo
Returns void

Optional componentDidMount

componentDidMount(): void

Inherited from BaseComponent.componentDidMount
Returns void

Optional componentDidUpdate

componentDidUpdate(previousProps: Readonly<ScrollerProps>, previousState: Readonly<Dictionary>, snapshot: any): void

Inherited from BaseComponent.componentDidUpdate
Parameters
- previousProps: Readonly<ScrollerProps>
- previousState: Readonly<Dictionary>
- snapshot: any
Returns void

Optional componentWillMount

componentWillMount(): void

Inherited from BaseComponent.componentWillMount
Returns void

Optional componentWillReceiveProps

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

Inherited from BaseComponent.componentWillReceiveProps
Parameters
- nextProps: Readonly<ScrollerProps>
- nextContext: any
Returns void

Optional componentWillUnmount

componentWillUnmount(): void

Inherited from BaseComponent.componentWillUnmount
Returns void

Optional componentWillUpdate

componentWillUpdate(nextProps: Readonly<ScrollerProps>, nextState: Readonly<Dictionary>, nextContext: any): void

Inherited from BaseComponent.componentWillUpdate
Parameters
- nextProps: Readonly<ScrollerProps>
- nextState: Readonly<Dictionary>
- nextContext: any
Returns void

forceUpdate

forceUpdate(callback?: (() => void)): void

Inherited from BaseComponent.forceUpdate
Parameters
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns void

Optional getChildContext

getChildContext(): object

Inherited from BaseComponent.getChildContext
Returns object

Optional getSnapshotBeforeUpdate

getSnapshotBeforeUpdate(oldProps: Readonly<ScrollerProps>, oldState: Readonly<Dictionary>): any

Inherited from BaseComponent.getSnapshotBeforeUpdate
Parameters
- oldProps: Readonly<ScrollerProps>
- oldState: Readonly<Dictionary>
Returns any

getXScrollbarWidth

getXScrollbarWidth(): number

Returns number

getYScrollbarWidth

getYScrollbarWidth(): number

Returns number

needsXScrolling

needsXScrolling(): boolean

Implementation of ScrollerLike.needsXScrolling
Returns boolean

needsYScrolling

needsYScrolling(): boolean

Implementation of ScrollerLike.needsYScrolling
Returns boolean

render

render(): Element

Overrides BaseComponent.render
Returns Element

safeSetState

safeSetState(newState: Partial<Dictionary>): void

Inherited from BaseComponent.safeSetState
Parameters
- newState: Partial<Dictionary>
Returns void

setState

setState<K>(state: null | Partial<Dictionary> | ((prevState: Readonly<Dictionary>, props: Readonly<ScrollerProps>) => null | Partial<Dictionary> | Pick<Dictionary, K>) | Pick<Dictionary, K>, callback?: (() => void)): void

Inherited from BaseComponent.setState
Type Parameters
- K extends string
Parameters
- state: null | Partial<Dictionary> | ((prevState: Readonly<Dictionary>, props: Readonly<ScrollerProps>) => null | Partial<Dictionary> | Pick<Dictionary, K>) | Pick<Dictionary, K>
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns void

shouldComponentUpdate

shouldComponentUpdate(nextProps: ScrollerProps, nextState: Dictionary): boolean

Inherited from BaseComponent.shouldComponentUpdate
Parameters
- nextProps: ScrollerProps
- nextState: Dictionary
Returns boolean

Static Optional getDerivedStateFromError

getDerivedStateFromError(error: any): null | object

Inherited from BaseComponent.getDerivedStateFromError
Parameters
- error: any
Returns null | object

Static Optional getDerivedStateFromProps

getDerivedStateFromProps(props: object, state: object): null | object

Inherited from BaseComponent.getDerivedStateFromProps
Parameters
- props: object
- state: object
Returns null | object

Generated using TypeDoc