If using the new style context, re-declare this in your class to be the
React.ContextType of your static contextType.
Should be used with type annotation or static contextType.
static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
ReadonlypropsStatic OptionalcontextIf set, this.context will be set at runtime to the current value of the given Context.
Usage:
type MyContext = number
const Ctx = React.createContext<MyContext>(0)
class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}
Optionalprops: anyOptionalcomponentCatches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
OptionalcomponentCalled immediately after a component is mounted. Setting state here will trigger re-rendering.
OptionalcomponentCalled immediately after updating occurs. Not called for the initial render.
The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.
Optionalsnapshot: anyOptionalcomponentCalled 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.
OptionalcomponentCalled 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.
OptionalcomponentCalled 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.
OptionalcomponentCalled 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.
Optionalcallback: () => voidOptionalgetRuns 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.
Hook for subclasses to additionally disable the Add Library button. Return true to keep the button disabled even when the form is otherwise enabled.
Controls whether library associations may be removed via UI interaction. Subclasses may override this method to control removal.
Hook for subclasses to additionally disable the per-library Save button. Return true to keep the button disabled even when the form is otherwise enabled.
Returns true when this protocol has any editable per-library settings, either from the protocol definition or injected by a subclass. Subclasses should override this when they add extra library-level fields.
Removes the association with the given library from a service's state.
NB: This method is used indirectly via onRemove by sharedFunctions.clearForm
to clean up form state; therefore, care should be taken to avoid any side
effects not needed for updating the state. Anything done by this method
can happen whenever user interaction or clearForm triggers onRemove.
Update or override isLibraryRemovalPermitted to control library removal
via UI interaction.
Hook for subclasses to inject additional panels into the form content, rendered after the libraries panel but before the submit button.
Hook for subclasses to inject extra fields into the expanded per-library settings panel. Rendered after protocol library_settings fields and before the Save button.
Hook for subclasses to inject extra fields into the add-new-library panel. Rendered after protocol library_settings fields and before the Add Library button.
Optionalcallback: () => voidOptionalshouldCalled 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.
OptionalUNSAFE_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.
OptionalUNSAFE_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.
Extends ServiceEditForm with patron-blocking-rules support for protocols that support it. The editor is injected via the hook methods added to ServiceEditForm; editLibrary and addLibrary are overridden to collect the rules from the editor ref and persist them in library state.