Right panel for sitewide announcements on the system configuration page.

Hierarchy

Constructors

Properties

EditForm: any = null
adminLevel?: number
announcementsRef: RefObject<default> = ...
context: {
    admin: default;
}

Type declaration

extraFormKey?: string
identifierKey: string = "id"
itemTypeName: string = "sitewide announcement"
labelKey: string = "content"
limitOne: boolean = false
links?: {
    [key: string]: JSX.Element;
}

Type declaration

  • [key: string]: JSX.Element
listDataKey: string = "announcements"
props: Readonly<EditableConfigListProps<SitewideAnnouncementsData>> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
urlBase: string = "/admin/web/config/sitewideAnnouncements/"
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 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

  • 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

    Returns boolean

Generated using TypeDoc