Shows a list of configuration services of a particular type and allows creating a new service or editing or deleting an existing services. Used for many of the tabs on the system configuration page.

GenericEditableConfigList allows subclasses to define additional props. Subclasses of EditableConfigList cannot change the props and do not have to specify a type for them.

Type Parameters

Hierarchy

Constructors

Properties

AdditionalContent?: (new (props: AdditionalContentProps<T, U>) => Component<AdditionalContentProps<T, U>, any, any>)

Type declaration

EditForm: (new (props: EditFormProps<T, U>) => Component<EditFormProps<T, U>, any, any>)

Type declaration

ExtraFormSection?: (new (props: ExtraFormSectionProps<T, U>) => Component<ExtraFormSectionProps<T, U>, any, any>)

Type declaration

adminLevel?: number
context: {
    admin: default;
}

Type declaration

editFormRef: RefObject<any> = ...
extraFormKey?: string
identifierKey: string
itemTypeName: string
labelKey: string
limitOne: boolean = false
links?: {
    [key: string]: JSX.Element;
}

Type declaration

  • [key: string]: JSX.Element
listDataKey: string
props: Readonly<V> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
urlBase: string
contextType?: Context<any>

If 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}</>;
}
}

See

https://react.dev/reference/react/Component#static-contexttype

contextTypes: {
    admin: Validator<object>;
} = ...

Type declaration

  • admin: Validator<object>

Methods

  • canCreate 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.

    Returns boolean

  • 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.

    Returns boolean

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<V>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • 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.

    Returns void

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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.

    Parameters

    • prevProps: Readonly<V>
    • prevState: Readonly<{}>

    Returns any

  • Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState: Readonly<{}>, props: Readonly<V>) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • 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.

    Parameters

    • nextProps: Readonly<V>
    • nextState: Readonly<{}>
    • nextContext: any

    Returns boolean

Generated using TypeDoc