ViewportComponent<SS> Class

A viewport React component that creates a ScreenViewport.

Extends

Methods

Name Description
constructor(props: ViewportProps): ViewportComponent    
componentDidMount(): Promise<void>    
componentDidUpdate(prevProps: ViewportProps): Promise<void>    
componentWillUnmount(): void    
render(): Element    

Inherited methods

Name Inherited from Description
UNSAFE_componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
UNSAFE_componentWillReceiveProps(nextProps: Readonly<ViewportProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
UNSAFE_componentWillUpdate(nextProps: Readonly<ViewportProps>, nextState: Readonly<ViewportState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
componentDidCatch(error: Error, errorInfo: ErrorInfo): void Optional ComponentLifecycle Catches exceptions generated in descendant components.
componentWillMount(): void Optional DeprecatedLifecycle Called immediately before mounting occurs, and before Component#render.
componentWillReceiveProps(nextProps: Readonly<ViewportProps>, nextContext: any): void Optional DeprecatedLifecycle Called when the component may be receiving new props.
componentWillUpdate(nextProps: Readonly<ViewportProps>, nextState: Readonly<ViewportState>, nextContext: any): void Optional DeprecatedLifecycle Called immediately before rendering when new props or state is received.
forceUpdate(callback?: () => void): void Component<ViewportProps, ViewportState>  
getSnapshotBeforeUpdate(prevProps: Readonly<ViewportProps>, prevState: Readonly<ViewportState>): SS | null Optional NewLifecycle Runs before React applies the result of render to the document, and
setState<K extends undefined>(state: (prevState: Readonly<ViewportState>, props: Readonly<ViewportProps>) => null | S | { T } | null | S | { T }, callback?: () => void): void Component<ViewportProps, ViewportState>  
shouldComponentUpdate(nextProps: Readonly<ViewportProps>, nextState: Readonly<ViewportState>, nextContext: any): boolean Optional ComponentLifecycle Called to determine whether the change in props and state should trigger a re-render.

Inherited properties

Name Type Inherited from Description
context any Component<ViewportProps, ViewportState> If using the new style context, re-declare this in your class to be the
contextType Static undefined | Context<any> Component<ViewportProps, ViewportState> If set, this.context will be set at runtime to the current value of the given Context.
props Readonly<ViewportProps> & Readonly<{ children?: ReactNode }> Component<ViewportProps, ViewportState>  
refs [key: string]: ReactInstance Component<ViewportProps, ViewportState>  
state Readonly<ViewportState> Component<ViewportProps, ViewportState>  

Defined in

Last Updated: 13 June, 2024