CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

AutosaveConfig (autosave)

@ckeditor/ckeditor5-autosave/src/autosave

interface
See source

The configuration of the autosave feature.

ClassicEditor
    .create( editorElement, {
        autosave: {
            save( editor ) {
                // The saveData() function must return a promise
                // which should be resolved when the data is successfully saved.
                return saveData( editor.getData() );
            }
        }
    } );
    .then( ... )
    .catch( ... );

See all editor configuration options.

See also the demo of the autosave feature.

Filtering

Properties

  • waitingTime : Number

    The minimum amount of time that needs to pass after the last action to call the provided callback. By default it is 1000 ms.

    See source
    ClassicEditor
    .create( editorElement, {
        autosave: {
            save( editor ) {
                return saveData( editor.getData() );
            },
            waitingTime: 2000
        }
    } );
    .then( ... )
    .catch( ... );

Methods

  • save( editor ) → Promise.<*>

    The callback to be executed when the data needs to be saved.

    See source

    This function must return a promise which should be resolved when the data is successfully saved.

    ClassicEditor
    .create( editorElement, {
        autosave: {
            save( editor ) {
                return saveData( editor.getData() );
            }
        }
    } );
    .then( ... )
    .catch( ... );

    Parameters

    editor : Editor

    The editor instance.

    Returns

    Promise.<*>