Class RenderHook<HookProps>

Type parameters

HookProps

Hierarchy

BaseComponent<RenderHookProps<HookProps>>
- RenderHook

Constructors

constructor

new RenderHook<HookProps>(props?: RenderHookProps<HookProps>, context?: any): RenderHook<HookProps>

Inherited from BaseComponent.constructor
Type parameters
- HookProps
Parameters
- Optional props: RenderHookProps<HookProps>
- Optional context: any
Returns RenderHook<HookProps>

Properties

Optional base

base?: Element | Text

context

context: ViewContext

debug

debug: boolean

handleRootEl

handleRootEl: (el: null | HTMLElement) => void

Type declaration

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

propEquality

propEquality: EqualityFuncs<RenderHookProps<HookProps>>

props

props: RenderableProps<RenderHookProps<HookProps>, any>

Private rootElRef

rootElRef: any

state

state: Readonly<Dictionary>

stateEquality

stateEquality: EqualityFuncs<Dictionary>

Static addPropsEquality

addPropsEquality: (propEquality: any) => void

Type declaration

- (propEquality: any): void
- Parameters
  - propEquality: any
  Returns void

Static addStateEquality

addStateEquality: (stateEquality: any) => void

Type declaration

- (stateEquality: any): void
- Parameters
  - 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: any): void

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

Optional componentDidMount

componentDidMount(): void

Inherited from BaseComponent.componentDidMount
Returns void

Optional componentDidUpdate

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

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

Optional componentWillMount

componentWillMount(): void

Inherited from BaseComponent.componentWillMount
Returns void

Optional componentWillReceiveProps

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

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

Optional componentWillUnmount

componentWillUnmount(): void

Inherited from BaseComponent.componentWillUnmount
Returns void

Optional componentWillUpdate

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

Inherited from BaseComponent.componentWillUpdate
Parameters
- nextProps: Readonly<RenderHookProps<HookProps>>
- 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<RenderHookProps<HookProps>>, oldState: Readonly<Dictionary>): any

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

render

render(): Element

Overrides BaseComponent.render
Returns Element

setState

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

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

shouldComponentUpdate

shouldComponentUpdate(nextProps: RenderHookProps<HookProps>, nextState: Dictionary): boolean

Inherited from BaseComponent.shouldComponentUpdate
Parameters
- nextProps: RenderHookProps<HookProps>
- 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