Инструменты пользователя

Инструменты сайта


software:development:web:docs:web:wysiwyg:sceditor_plugins_autosave

Плагин автосохранения

Автоматически сохраняет содержимое редактора (по умолчанию на 1 день) в локальное хранилище (localStorage).
Это удалит автоматически сохраненное содержимое при отправке формы, содержащей редактор, или при sceditor.plugins.autosave.clear() ручном вызове метода. При использовании пользовательского метода storageKeyего необходимо передать в качестве первого аргумента, clear()если требуется ручная очистка автоматически сохраненных данных.

:!: Предупреждение!
При использовании нескольких экземпляров редактора на странице всегда указывайте параметр storageKey или переопределяйте обработчики загрузки и сохранения.

Инициализация

Чтобы включить плагин для работы с обычным текстом, добавьте autosave в plugins опцию, например:

script.js
<script>
sceditor.create(textarea, {
	plugins: 'autosave',
    style: 'minified/themes/content/default.min.css'
});
</script>


Вот и всё! Теперь содержимое редактора будет сохраняться в localStorage в течение 1 дня.

Параметры

Чтобы указать параметры автосохранения, добавьте autosave в объект options свойство с желаемыми параметрами, например:


script.js
<script>
sceditor.create(textarea, {
	plugins: 'dragdrop',
    style: 'minified/themes/content/default.min.css',
    autosave: {
        storageKey: ...,
        saveHandler: function (data) {
            ...
        }
    }
});
</script>


Плагин autosave поддерживает следующие параметры:

script.js
autosave: {
    // The storage key to use for storing the draft in local storage.
    // Key should start with "sce-autodraft-" for the autosave plugin to
    // remove it if it is passed the expires.
    // Defaults to "sce-autodraft-" plus the path and query string:
    storageKey: 'sce-autodraft-' + location.pathname + location.search;,
    // Save handler function, see below for data object
    saveHandler: function (data) {
        ...
    },
    // Load handler function, see below for data object
    loadHandler: function () {
        ...
        return data;
    },
    // Number of milliseconds to keep drafts before clearing when using the
    // default load and save handlers.
    // Defaults to 24 hrs
    expires: 86400000
}


Обработчик сохранения будет вызван с определенным значением, а обработчик загрузки должен вернуть следующий объект:

script.js
{
    // Object - contains the source mode caret position
    caret: {
        // Number - source editor caret start position
        start: Number
        // Number - source editor caret end position
        end: Number
    },
    // Boolean - if in source mode
    sourceMode: Boolean,
    // String - editors contents
    value: String,
    // Number - current timestamp
    time: Number
}

Дополнения и Файлы

Только авторизованные участники могут оставлять комментарии.
software/development/web/docs/web/wysiwyg/sceditor_plugins_autosave.txt · Последнее изменение: VladPolskiy

Если не указано иное, содержимое этой вики предоставляется на условиях следующей лицензии: Public Domain
Public Domain Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki