Wagtail client-side components
    Preparing search index...

    Class AutosaveController

    Sends a form's data to the server for autosaving.

    Can also be used for an indicator component to show the current autosave state.

    Dispatches the following events.

    w-autosave:save - before saving, cancelable.

    w-autosave:hydrate - to hydrate a create view into an edit view.

    w-autosave:success - on successful save and any UI updates.

    w-autosave:error - on save error, e.g. due to validation errors.

    w-autosave:deactivated - when autosave is deactivated due to an unrecoverable error.

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    activeValue context hasPartialsTarget intervalValue lastTriggerEvent? partialsTarget retryTimeout retryTimes revisionIdValue stateValue submit submitPromise blessings maxRetries outlets targets values

    Accessors

    application classes data element identifier outlets scope targets shouldLoad

    Methods

    clearRetries connect disconnect dispatch hydrate initialize intervalValueChanged save updateIndicator afterLoad

    Constructors

    • Parameters

      • context: Context

      Returns AutosaveController

    Properties

    activeValue: boolean

    Whether autosave is active.

    Autosave may be deactivated when there is an unrecoverable error, e.g. a newer revision is detected.

    context: Context
    hasPartialsTarget: boolean
    intervalValue: number

    The debounce interval between autosave calls, in milliseconds.

    lastTriggerEvent?: Event

    The last event that triggered a save, used to ensure that if multiple saves are triggered while a save is still in progress, only one additional save will be triggered after the first one finishes, and it will use the latest event's data.

    This is necessary to prevent multiple saves from being triggered in quick succession and overwhelming the server, while still ensuring that the latest data is saved.

    It is reset after each save finishes, and if it has changed during the save, another save will be immediately triggered with the latest event.

    partialsTarget: HTMLDivElement

    The target element for partial HTML updates.

    retryTimeout: Timeout | null = null

    The timer before retrying a save request that failed due to a network error. Increases 2 seconds exponentially to the power of AutosaveController.retryTimes.

    retryTimes: number = 0

    The number of times the current save request has been retried. Limited to AutosaveController.maxRetries.

    revisionIdValue: number

    The current revision ID of the form being edited.

    stateValue: AutosaveState

    The current state of the autosave process.

    This is only set when the controller is used as an indicator component, not when controlling a form.

    submit: DebouncibleFunction<
        (event: CustomEvent<AutosaveSaveDetail>) => Promise<void>,
    > = ...

    Handles the submission of the autosave form. Debouncible based on the interval value.

    The save event containing the form data to submit. If the event's default is prevented, no action is taken.

    submitPromise: Promise<void> | null = null

    The promise of the currently running save request, if any. Used to prevent multiple concurrent save requests, which can cause race conditions and other unintended consequences.

    blessings: (<T>(constructor: Constructor<T>) => any)[]
    maxRetries: number = 5

    Maximum number of attempts to retry a save request that failed due to a network error. See AutosaveController.retryTimes.

    outlets: string[]
    targets: string[] = ...
    values: {
        active: { default: boolean; type: BooleanConstructor };
        interval: { default: number; type: NumberConstructor };
        revisionId: { default: number; type: NumberConstructor };
        state: { default: AutosaveState; type: StringConstructor };
    } = ...

    Accessors

    • get application(): Application

      Returns Application

    • get classes(): ClassMap

      Returns ClassMap

    • get data(): DataMap

      Returns DataMap

    • get element(): ElementType

      Returns ElementType

    • get identifier(): string

      Returns string

    • get outlets(): OutletSet

      Returns OutletSet

    • get scope(): Scope

      Returns Scope

    • get targets(): TargetSet

      Returns TargetSet

    • get shouldLoad(): boolean

      Returns boolean

    Methods

    • Returns void

    • Returns void

    • Parameters

      • eventName: string
      • Optional__namedParameters: Partial<
            {
                bubbles: boolean;
                cancelable: boolean;
                detail: Object;
                prefix: string;
                target: Element
                | Window
                | Document;
            },
        >

      Returns CustomEvent<Object>

    • Applies the new debounce interval to the submit function.

      Parameters

      • newInterval: number

      Returns void

    • Prepares a save request by gathering the form data, adding additional data (e.g. revision ID to overwrite), and dispatching a save event.

      Does not do anything if autosave is not active or the element is not a form.

      Parameters

      Returns Promise<void>

    • Parameters

      • _identifier: string
      • _application: Application

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods