Documentation for DOMView
noinheritdoc
Hierarchy#
Component<DOMViewProps>
↳ DOMView
Constructors#
constructor#
+ new DOMView(props: DOMViewProps): DOMView
Parameters:#
| Name | Type |
|---|---|
props | DOMViewProps |
Returns: DOMView
Overrides: Component<DOMViewProps/, DOMViewState/>.constructor
Defined in: libs/core/src/components/DOMView.tsx:34
Properties#
context#
• context: Entity
Overrides: Component.context
Defined in: libs/core/src/components/DOMView.tsx:33
props#
• Readonly props: Readonly<DOMViewProps> & Readonly<{ children?: ReactNode }>
Inherited from: Component.props
Defined in: node_modules/@types/react/index.d.ts:494
ref#
• Readonly ref: RefObject<HTMLElement>
Defined in: libs/core/src/components/DOMView.tsx:34
refs#
• refs: object
deprecated
https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs
Type declaration:#
Inherited from: Component.refs
Defined in: node_modules/@types/react/index.d.ts:500
state#
• state: Readonly<{}>
Inherited from: Component.state
Defined in: node_modules/@types/react/index.d.ts:495
contextType#
â–ª Static contextType: Context<Entity>
Overrides: Component.contextType
Defined in: libs/core/src/components/DOMView.tsx:32
Accessors#
element#
• get element(): HTMLElement
Returns: HTMLElement
Defined in: libs/core/src/components/DOMView.tsx:41
Methods#
UNSAFE_componentWillMount#
â–¸ OptionalUNSAFE_componentWillMount(): void
Called immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use componentDidMount or the constructor instead
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns: void
Inherited from: Component.UNSAFE_componentWillMount
Defined in: node_modules/@types/react/index.d.ts:707
UNSAFE_componentWillReceiveProps#
â–¸ OptionalUNSAFE_componentWillReceiveProps(nextProps: Readonly<DOMViewProps>, nextContext: any): void
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.
deprecated 16.3, use static getDerivedStateFromProps instead
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:#
| Name | Type |
|---|---|
nextProps | Readonly<DOMViewProps> |
nextContext | any |
Returns: void
Inherited from: Component.UNSAFE_componentWillReceiveProps
Defined in: node_modules/@types/react/index.d.ts:739
UNSAFE_componentWillUpdate#
â–¸ OptionalUNSAFE_componentWillUpdate(nextProps: Readonly<DOMViewProps>, nextState: Readonly<{}>, nextContext: any): void
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
This method will not stop working in React 17.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use getSnapshotBeforeUpdate instead
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:#
| Name | Type |
|---|---|
nextProps | Readonly<DOMViewProps> |
nextState | Readonly<{}> |
nextContext | any |
Returns: void
Inherited from: Component.UNSAFE_componentWillUpdate
Defined in: node_modules/@types/react/index.d.ts:767
componentDidCatch#
â–¸ OptionalcomponentDidCatch(error: Error, errorInfo: ErrorInfo): void
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Parameters:#
| Name | Type |
|---|---|
error | Error |
errorInfo | ErrorInfo |
Returns: void
Inherited from: Component.componentDidCatch
Defined in: node_modules/@types/react/index.d.ts:636
componentDidMount#
â–¸ componentDidMount(): void
Returns: void
Overrides: Component.componentDidMount
Defined in: libs/core/src/components/DOMView.tsx:45
componentDidUpdate#
â–¸ OptionalcomponentDidUpdate(prevProps: Readonly<DOMViewProps>, prevState: Readonly<{}>, snapshot?: any): 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:#
| Name | Type |
|---|---|
prevProps | Readonly<DOMViewProps> |
prevState | Readonly<{}> |
snapshot? | any |
Returns: void
Inherited from: Component.componentDidUpdate
Defined in: node_modules/@types/react/index.d.ts:678
componentWillMount#
â–¸ OptionalcomponentWillMount(): void
Called immediately before mounting occurs, and before Component#render.
Avoid introducing any side-effects or subscriptions in this method.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Returns: void
Inherited from: Component.componentWillMount
Defined in: node_modules/@types/react/index.d.ts:693
componentWillReceiveProps#
â–¸ OptionalcomponentWillReceiveProps(nextProps: Readonly<DOMViewProps>, nextContext: any): void
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.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:#
| Name | Type |
|---|---|
nextProps | Readonly<DOMViewProps> |
nextContext | any |
Returns: void
Inherited from: Component.componentWillReceiveProps
Defined in: node_modules/@types/react/index.d.ts:722
componentWillUnmount#
â–¸ OptionalcomponentWillUnmount(): 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
Inherited from: Component.componentWillUnmount
Defined in: node_modules/@types/react/index.d.ts:631
componentWillUpdate#
â–¸ OptionalcomponentWillUpdate(nextProps: Readonly<DOMViewProps>, nextState: Readonly<{}>, nextContext: any): void
Called immediately before rendering when new props or state is received. Not called for the initial render.
Note: You cannot call Component#setState here.
Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.
deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17
see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
Parameters:#
| Name | Type |
|---|---|
nextProps | Readonly<DOMViewProps> |
nextState | Readonly<{}> |
nextContext | any |
Returns: void
Inherited from: Component.componentWillUpdate
Defined in: node_modules/@types/react/index.d.ts:752
forceUpdate#
â–¸ forceUpdate(callback?: () => void): void
Parameters:#
| Name | Type |
|---|---|
callback? | () => void |
Returns: void
Inherited from: Component.forceUpdate
Defined in: node_modules/@types/react/index.d.ts:486
getSnapshotBeforeUpdate#
â–¸ OptionalgetSnapshotBeforeUpdate(prevProps: Readonly<DOMViewProps>, prevState: Readonly<{}>): any
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:#
| Name | Type |
|---|---|
prevProps | Readonly<DOMViewProps> |
prevState | Readonly<{}> |
Returns: any
Inherited from: Component.getSnapshotBeforeUpdate
Defined in: node_modules/@types/react/index.d.ts:672
render#
â–¸ render(): Element
Returns: Element
Overrides: Component.render
Defined in: libs/core/src/components/DOMView.tsx:50
setState#
â–¸ setState<K>(state: {} | (prevState: Readonly<{}>, props: Readonly<DOMViewProps>) => {} | Pick<{}, K> | Pick<{}, K>, callback?: () => void): void
Type parameters:#
| Name | Type |
|---|---|
K | never |
Parameters:#
| Name | Type |
|---|---|
state | {} | (prevState: Readonly<{}>, props: Readonly<DOMViewProps>) => {} | Pick<{}, K> | Pick<{}, K> |
callback? | () => void |
Returns: void
Inherited from: Component.setState
Defined in: node_modules/@types/react/index.d.ts:481
shouldComponentUpdate#
â–¸ OptionalshouldComponentUpdate(nextProps: Readonly<DOMViewProps>, nextState: Readonly<{}>, 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:#
| Name | Type |
|---|---|
nextProps | Readonly<DOMViewProps> |
nextState | Readonly<{}> |
nextContext | any |
Returns: boolean
Inherited from: Component.shouldComponentUpdate
Defined in: node_modules/@types/react/index.d.ts:626