OptionalAdditionalOptionaladminIf 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>
OptionalextraOptionalExtraOptionallinksReadonlypropsStaticchildStatic 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}</>;
}
}
StaticcontextcanCreate Does this service have the ability to create a new item? The default is true but the logic can be overridden by other classes that inherit GenericEditableConfigList. For example, a class would only want to create a new item if the admin is a system admin.
canDelete Does this service have the ability to delete an item? The default is true, as long as the user is a system admin, but the logic can be overridden by other classes that inherit GenericEditableConfigList.
OptionalcomponentCatches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.
Called 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: () => voidProtectedformatReturns a human-readable summary of the association count shown next to the item label (e.g. "3 libraries", "no libraries"). Override in subclasses that use different terminology (e.g. "registered libraries", "roles").
ProtectedgetReturns the full list of libraries known to the server, used to resolve short names to display names and UUIDs for the associated-items panel.
The base implementation accesses data.allLibraries via an any cast
because the generic T is not constrained to include that field (e.g.
LibrariesData does not have it). Subclasses whose data type declares
allLibraries (e.g. Collections, IndividualAdmins) should override
this method with a type-safe accessor to avoid the cast.
ProtectedgetReturns the list of display entries to show in the associated-items panel
for a given item, or undefined if the panel does not apply to this item.
Return semantics (used by renderLi to drive toggle visibility):
undefined → the feature does not apply; no toggle is rendered.[] → the feature applies but there are no associations;
a disabled toggle is rendered.[…entries] → associations exist; an enabled toggle is rendered.The base implementation reads the item's libraries field (an array of
{ short_name } objects) and resolves each entry against getAllLibraries.
Subclasses may override to supply different data sources or terminology
(see DiscoveryServices.getAssociatedEntries,
IndividualAdmins.getAssociatedEntries).
Subclasses that do not support the feature should not override this
method; simply ensure that the item type has no libraries field so the
base implementation returns undefined for every item (see Libraries).
ProtectedgetReturns the raw list of items from the current data, or [] when data
has not yet loaded. Centralizes the any cast required because T is
not constrained to include listDataKey.
OptionalgetRuns 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.
ProtectedrenderRenders the expanded associated-items <ul>. Pinned entries (e.g.
sitewide roles) are sorted before per-item entries; within each group
entries are sorted alphabetically by label.
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.
OptionalUNSAFE_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.
Right panel for discovery services on the system configuration page. Shows a list of current discovery services and allows creating a new service or editing or deleting an existing service.