Body of the custom lists page, with all a library's lists shown in a left sidebar and a list editor on the right.

Hierarchy

Constructors

Properties

context: {
    admin: default;
}

Type declaration

props: Readonly<CustomListsProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<CustomListsState>
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

  • Parameters

    • nextProps: any

    Returns void

  • 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

    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

  • deletedLaneNames Display text that lists what lanes will be deleted. Currently used to warn users when a list is deleted that those lanes will be deleted.

    Parameters

    • lanes: LaneData[]

      Array of lanes that will be deleted.

    Returns string

  • Parameters

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

    Returns void

  • getDeletedLanes For any list id, fetch all the lanes where this list is the only custom list in that lane. The server will deal with deleting those lanes. Only fetch the lanes data here since they are not needed for the page until a list is going to be deleted.

    Parameters

    • listId: string | number

      The id of the list to get associated lanes.

    Returns Promise<LaneData[]>

  • 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

    Returns any

  • 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