← Toda a documentação

editor.commitBookmark()

Finaliza a entrada de desfazer atual do editor. Normalmente, edições consecutivas feitas em sequência rápida são agrupadas em uma única etapa de desfazer; o commit marca a etapa atual como concluída, e a próxima alteração começa uma nova entrada, que pode ser desfeita separadamente. Use-o para traçar um limite claro no histórico de desfazer em volta de uma alteração feita por código.

Sintaxe

editor.commitBookmark()

Parâmetros

Nenhum.

Retorno

Nada (undefined).

Observações de comportamento

  • Controla a granularidade do desfazer, não o conteúdo. O commit não altera o documento; ele só decide se a próxima edição se junta à etapa de desfazer atual ou começa uma nova.
  • Por padrão, as edições são agrupadas. Sem um commit, as alterações feitas dentro de um intervalo curto (o tempo limite de adição ao desfazer do editor) se juntam em uma única entrada de desfazer — o commit força o limite na hora.
  • O desfazer faz o commit automaticamente. O editor faz o commit do bookmark pendente antes de executar um desfazer, por isso você raramente precisa disso na digitação normal — é mais útil em volta de edições feitas por script.

Exemplo de uso

Delimite uma alteração feita por código para que ela vire uma única etapa de desfazer própria:

var editor1 = new RichTextEditor("#div_editor1");
editor1.commitBookmark();               // close whatever came before
editor1.setHTMLCode("<b>hello world</b>");
editor1.commitBookmark();               // this insert is now its own undo step

Insira vários fragmentos como etapas de desfazer separadas, em vez de uma etapa única:

fragments.forEach(function (html) {
    editor1.insertHTML(html);
    editor1.commitBookmark();   // each fragment undoes independently
});

Relacionados