Represents a portal view component.

Hierarchy

  • Component<IPortalViewProps>
    • PortalView

Constructors

  • Parameters

    • props: IPortalViewProps | Readonly<IPortalViewProps>

    Returns PortalView

  • Parameters

    • props: IPortalViewProps
    • context: any

    Returns PortalView

Properties

context: unknown

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
element: null | HTMLDivElement = null
props: Readonly<IPortalViewProps>
refs: {
    [key: string]: ReactInstance;
}
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Methods

  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    Parameters

    • nextProps: Readonly<IPortalViewProps>
    • nextContext: any

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<IPortalViewProps>
    • prevState: Readonly<{}>
    • Optionalsnapshot: any

    Returns void

  • Method componentWillUnmount

    This method is called when the component is about to be unmounted (removed) from the DOM. It performs clean-up tasks, if any, to avoid memory leaks or unwanted effects after the component is removed.

    This method checks if 'this.element' (assumed to be a DOM element) exists, and if so, removes it from the document body using 'document.body.removeChild()'. Finally, it sets 'this.element' to null to release any references to the removed element.

    Returns void

  • Parameters

    • Optionalcallback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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

    • prevProps: Readonly<IPortalViewProps>
    • prevState: Readonly<{}>

    Returns any

  • Renders the provided children into a portal, within a dynamically created div element appended to the document body.

    Returns ReactPortal

    • The resulting React element after rendering the children into the portal.
  • Type Parameters

    • K extends never

    Parameters

    • state:
          | null
          | {}
          | ((prevState: Readonly<{}>, props: Readonly<IPortalViewProps>) => null | {} | Pick<{}, K>)
          | Pick<{}, K>
    • Optionalcallback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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<IPortalViewProps>
    • nextState: Readonly<{}>
    • nextContext: any

    Returns boolean