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 label to be put on the launch button of the event. The label
depends on whether the event has any parameters, on the triggerMode,
flags in the event itself or the verb field of the event if it is set.
The current trigger mode. Defaults to trigger
The label for the submit button
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 in response to the user clicking the submit button. Based
on the given triggerMode, a different URL is composed which is then used
to trigger the event with the given params. Invokes the onTriggered
callback with either the argument success or error after the request
has completed and updates the state accordingly.
The current trigger mode. Defaults to trigger
Renders the component
Renders a modal dialogue for the current event and attaches it to the
DOM element modal-root through a portal. Whether the modal is rendereed
or not, depends on the value of the showEventModal state variable.
A portal to the event modal or null
Renders the parameter count for an event and returns it as a formatted JSX
string. If zero is passed, the function returns null.
Number of parameters
A JSX string displaying the count or null
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
This component renders a given event as a box on screen. It displays title, description, number of parameters and, depending on trigger mode and number of parameters a button to either launch the event directly or to open a modal dialogue which allows the user to configure event parameters and then either launch or enqueue it.
The document ID for the current session
The event to be rendered
A callback invoked when the event has been triggered