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.
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.
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.
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Called immediately after a compoment is mounted. Setting state here will trigger re-rendering.
Called immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
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.
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.
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.
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.
Returns the topmost screen region which contains the coordinates given by
x and y, or undefined if the coordinates are outside screen bounds.
X coordinate of the click event
Y coordinate of the click event
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.
Callback invoked when the user clicks on a screen region. Receives the original mouse event that was fired as well as the coordinates the user clicked at relative to the top-left corner of the canvas.
Original mouse event object
X coordinate relative to the top-left corner of the canvas
Y coordinate relative to the top-left corner of the canvas
Renders the component
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.
Splits the current region either horizontally or vertically, thus creating
two new sub-regions. The old region will be destroyed in the process. The
split position is determined by the [x, y] coordinates found in state.
Orientation of the split. Either horizontal or vertical
Generated using TypeDoc
SplittableScreen represents a preview screen and renders all regions contained within that screen. This type of screen is intended to be used inside the LayoutDesigner component and allows the user to segment the screen into regions by splitting existing regions. For this purpose, it has callbacks for splitting an existing region or undoing the most recent split for whenever such an event is triggered. The screen information is passed in through the
screenInfoprop. The screen can render at an different sizes, determined by the propwidth. Height is then calculated corresponding to that.An object containing data associated with a preview screen
The width of the rendered screen
Callback triggered when the user selects the option to remove the screen
Callback triggered when the user splits a region
Callback triggered when the user undoes the last split