The state of the custom list editor.

Hierarchy

  • CustomListEditorState

Properties

autoUpdateStatus: string

The update status of the list, if it is auto updating.

The entries in the list.

error: string

An error message, if an error has occurred.

id: number

The id of the list being edited. This can be null, if this is a new list.

isAutoUpdateEnabled: boolean

Flag indicating if the auto updating lists feature is enabled.

isLoaded: boolean

The loading state of the list; true if the list data has been loaded (not including the list entries), false otherwise.

isModified: boolean

The modified state of the list; true if the list has been changed since the last save, false otherwise. This is derived from properties and entries. It is stored here as a convenience, so that view components won't need to make the determination when rendering.

isOwner: boolean

A flag indicating that the current library owns this list; true if the current library is the owner, false if the list is shared with this library, but owned by another.

isSearchModified: boolean

The modified state of the search parameters; true if the search has been changed since the last save, false otherwise.

isSharePending: boolean

A flag indicating that a share operation on the list is in progress.

isShared: boolean

A flag indicating that the list is shared to multiple libraries.

isValid: boolean

The validity of the list; true if the list is valid, false otherwise. This is derived from properties and entries. It is stored here as a convenience, so that view components won't need to compute the validity when rendering.

The properties of the list.

The parameters to use when searching on the custom list editor.

Generated using TypeDoc