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.
Adjust the base width of chapter node boxes based on tree size and available canvas width.
Adjust the height of the drawing canvas based on the number of tree levels and available screen real estate.
Chapter tree which will be drawn
The calculated canvas height
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.
Draws the chapter tree starting from the level passed in as first argument. Visits all children in the data structure and draws them recursively as well and configures callbacks for interaction with the chapter nodes.
Tree level from which to start drawing
Position to start drawing at.
Access path of the current chapter. Optional, only used for recursion.
A series of components ready to be rendered inside a Stage component
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 one of the three handles of a chapter node is clicked. These handles are intended to be used to add new chapters either before, after or as children of the clicked chapter.
The access path of the chapter node that was clicked
Callback invoked when a chapter node is clicked. This is intended to be used to navigate to the timeline editor for the chapter that was clicked.
The access path of the chapter node that was clicked
Callback invoked when the name label of a chapter node is clicked. This is intended to be used to change the name of a chapter.
The access path of the chapter node that was clicked
The current name of the chapter node
Callback invoked when the close icon on a chapter node is clicked.
The access path of the chapter node that was clicked
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.
Generated using TypeDoc
ProgramAuthor is a Redux-connected component responsible for rendering and manipulating the chapter structure in the shape of a tree. It receives all its props via the Redux state tree.