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.
Callback invoked when the user wants to update the description of the current session. The updated value is obtained from a ref.
Callback invoked when the user wants to update the enableControls
setting. The value is converted from string to boolean before is it passed
to the server.
The original change event
Callback invoked when the user wants to update the playerMode setting.
The original change event
Callback invoked when the user wants to update the previewFromWebcam
setting. The value is converted from string to boolean before is it passed
to the server.
The original change event
Callback invoked when the user wants to update the startPaused setting.
The value is converted from string to boolean before is it passed to the
server.
The original change event
Callback invoked when the user wants to update the viewerExtraOffset
setting. The updated value is retrieved from a ref.
Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Invoked after the component first mounts. Requests the settings values from the server and stores the values in the component's internal state.
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.
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.
Renders the component
Renders a list of links given as key-value pairs as JSX elements. Where the key is the name of the link and the value is the link itself.
Links to render as a list
The links wrapped in JSX elements
Renders a notification badge indicating either success or failure of a
request to update a settings key. If the saveSuccessful state variable
is undefined, nothing is rendered. The notification is cleared and
disappears after one second.
The rendered notification
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.
Generic function for updating settings values. The function takes the settings key to be updated and the updated value, creates a HTTP request and if successful, updates the state accordingly. In case the request fails, the error condition is set.
The key to update
The new value for the given key
Generated using TypeDoc
This component allows the user to configure various aspects of the preview player by changing a series of settings. This component also offers access to various debug links.
The document ID for the current session