← Toda a documentação

Referência de configuração

Esta página lista as opções de configuração disponíveis no editor. Consulte Configuração para ver padrões de configuração e orientações de uso.

Em telas menores, role a tabela na horizontal para ver todas as colunas. Usuários de teclado podem dar foco à área da tabela e usar as teclas de seta.

NomePadrãoDescrição
skindefaultA aparência da interface do editor. O valor vira uma classe no contêiner (rte-skin-<value>); o tema já inclui dark, gray, blue e rounded-corner, e qualquer nome que você mesmo estilizar também funciona. Deixe sem definir para a interface clara padrão. Consulte skin.
toolbardefaultDefault, basic ou full. Auto configura a barra de ferramentas com um conjunto de botões no desktop.
toolbarMobilemobileO conjunto da barra de ferramentas em dispositivos móveis.
maxWidthForMobile992Quando a tela (janela do navegador) fica menor que 992, o editor deve usar a barra de ferramentas móvel.
timeoutAddToUndo900Quando o usuário digita rápido, espera 900ms para adicionar um item de desfazer.
enableDragDroptrueAtiva ou desativa o suporte a arrastar e soltar no editor.
enableObjectResizingtrueDefine se os usuários podem ou não redimensionar um objeto dentro do RichTextEditor.
readOnlyfalseObtém ou define um valor que indica se o RichTextEditor deve ser um editor HTML ativo ou um visualizador de documentos somente leitura.
focusOnLoadfalseDefine se o editor recebe o foco quando a página carrega. Se esta propriedade for true, o editor recebe o foco; se for false, não recebe.
allowScriptCodefalseDefine se todos os elementos script e o conteúdo de scripts devem ser removidos do HTML para evitar injeção de JavaScript. Quando esta propriedade é false (o padrão), o Rich Text Editor remove do HTML todos os elementos script e o conteúdo de scripts.
tagWhiteList[]A lista de permissões contém as tags que podem ser usadas no editor.
tagBlackList[]A lista de bloqueio contém as tags que não podem ser usadas no editor.
maxHTMLLength0Obtém ou define o número máximo de caracteres, incluindo as tags HTML, permitido no RichTextEditor. O padrão, 0, significa sem máximo. Acima do limite, o editor volta ao último estado válido e dispara o hook de customdialog reachmaxlength.
maxTextLength0Obtém ou define o número máximo de caracteres, sem contar as tags HTML, permitido no RichTextEditor. O padrão, 0, significa sem máximo. Acima do limite, o editor volta ao último estado válido e dispara o hook de customdialog reachmaxlength.
styleWithCSSfalseComo negrito, itálico e sublinhado são salvos. O padrão grava tags — <b>, <i>, <u> —, que boldTag e italicTag renomeiam e que um leitor de tela anuncia como ênfase. Defina true para salvar estilos inline (<span style="font-weight: bold">) em vez disso. Core 2.6.8 e posterior; antes disso, o resultado dependia de o bundle de plugins terminar de carregar primeiro ou não, de modo que o mesmo conteúdo podia ser salvo de qualquer uma das formas.
pasteStripThemeStylestrueAo colar, descarta estilos inline que só repetem o próprio tema do editor. Os navegadores gravam estilos computados no HTML copiado; por isso, um texto copiado dentro do editor chegava com a margem, o tamanho de fonte e a cor do tema, e isso era salvo com o conteúdo. Estilos definidos pelo autor que diferem do tema são mantidos. Defina false para manter todos os estilos colados. Core 2.6.8 e posterior.
smartTypographytrueSubstitui o que o autor digita por caracteres tipográficos: aspas retas viram aspas curvas, dois hifens viram um travessão, três pontos viram reticências, e (c), (r) e (tm) viram ©, ® e ™. Nada é alterado dentro de code, pre ou kbd. Isso faz parte do core do editor e é separado do plugin de autocorreção; portanto, autocorrectEnabled: false não desativa este recurso. Defina false para manter exatamente o que é digitado; as quatro opções abaixo ativam cada substituição separadamente.
smartTypographyQuotestrueAspas duplas e simples retas viram aspas curvas (“ ” ‘ ’), e um apóstrofo dentro de uma palavra vira ’ (don’t).
smartTypographyDashestrueDois hifens viram um travessão (—). Um único hífen não é alterado.
smartTypographyEllipsistrueTrês pontos viram um único caractere de reticências (…).
smartTypographyTrademarkstrue(c), (r) e (tm) viram ©, ® e ™.
sanitizerAllowIframestrueMantém os elementos <iframe> no conteúdo. Vale enquanto o sanitizador de conteúdo estiver ativo (contentSanitizer, parte do bundle de plugins). Só sobrevivem frames cujo src é http ou https; srcdoc, handlers de eventos e URLs javascript: nunca sobrevivem. Sem uma lista sanitizerAllowedIframeHosts, todo frame mantido recebe o sandbox allow-scripts allow-same-origin allow-presentation: navegação de nível superior, pop-ups, modais e formulários ficam bloqueados, e um frame da mesma origem da página também perde allow-same-origin. Defina false para descartar todos os iframes.
sanitizerAllowedIframeHosts[]Mantém apenas frames destes hosts e dos subdomínios deles, por exemplo ["www.youtube.com", "player.vimeo.com"]. É o controle mais forte: defina-o sempre que souber quais embeds você espera.
maxUploadFileSize0Maior arquivo que o editor vai inserir ou enviar, em bytes. O padrão, 0, significa sem limite. Vale para as caixas de diálogo de imagem e de documento, para colar e para arrastar e soltar: acima do limite, o arquivo é recusado antes de ser lido, de modo que nada é incorporado ao documento e nada é enviado ao handler de upload. A mensagem vem de text_uploadtoobig; trate o hook de customdialog uploadtoobig para exibir a sua própria caixa de diálogo.
allowBase64ImagestrueSem um handler de upload ou file_upload_url, uma imagem inserida é incorporada ao HTML como uma URL data: em base64. Defina false para nunca incorporar: a imagem é recusada com a mensagem text_base64disabled (hook de customdialog base64disabled), e um handler de upload passa a ser obrigatório. Core 2.6.5 e posterior.
base64ImageMaxSize204800Maior imagem em base64, em bytes, depois da redução (200 KB). Uma imagem maior é recusada com a mensagem text_base64toobig (hook de customdialog base64toobig). 0 significa sem limite, que é o comportamento anterior ao core 2.6.5.
base64ImageShrinktrueRedimensiona e recodifica imagens JPEG, PNG, WebP e BMP no navegador antes de incorporá-las em base64. GIF e SVG nunca são recodificados. Defina false para incorporar os bytes originais quando eles couberem em base64ImageMaxSize. Core 2.6.5 e posterior.
base64ImageMaxDimension1600Lado maior, em pixels, de uma imagem reduzida para incorporação em base64. Core 2.6.5 e posterior.
file_upload_urlnullURL para a qual o editor faz POST dos arquivos inseridos, colados e soltos, como multipart/form-data. Defina esta opção em vez de escrever um file_upload_handler. A resposta pode ser o {"location": "..."} do TinyMCE, o {"url": "..."} ou {"urls": {"default": "..."}} do CKEditor, ou READY:<url>; {"error": {"message": "..."}} e ERROR:<message> são falhas, assim como qualquer outro corpo. Um file_upload_handler tem prioridade quando os dois estão definidos.
file_upload_fieldfileNome do campo de formulário com que o arquivo é enviado. Endpoints no estilo do CKEditor esperam upload.
file_upload_base_pathnullPrefixado a uma URL relativa retornada pelo endpoint, para servir os uploads a partir de uma CDN.
file_upload_credentialsfalseEnvia cookies e autenticação HTTP com o upload, para um endpoint em outra origem.
file_upload_reuse_filenamefalseEnvia o arquivo com o nome original. Por padrão, um nome único é gerado, para que dois usuários que enviam image.png não sobrescrevam um ao outro.
file_upload_headersnullCabeçalhos de requisição extras para o upload, por exemplo um token CSRF.
automaticUploadsfalseQuando true, o editor envia, sem que ninguém peça, as imagens incorporadas ao conteúdo como URLs data: em base64: depois de setHTMLCode e depois de HTML inserido ou colado. Ele executa uploadEmbeddedImages() por você, com debounce de automaticUploadsDelay (300 ms), e não faz nada quando nenhum file_upload_handler está configurado.
automaticUploadsDelay300Milissegundos de espera antes de a varredura automática ser executada, para que uma colagem de várias imagens gere um único envio.
uploadRetryCount0Tentativas extras após um upload com falha, antes que o erro chegue ao callback do seu handler e ao usuário. Cada tentativa dispara um evento uploadretry. Um upload cancelado, ou um cuja imagem foi excluída, nunca é tentado de novo.
uploadRetryDelay1000Milissegundos antes da primeira nova tentativa. A espera dobra a cada tentativa seguinte.
autoSavenullSalva o conteúdo no seu próprio servidor enquanto o usuário digita: { onSave: function (html) { return promise; }, interval: 2000, indicator: true, retryCount: 3, retryDelay: 5000 }. onSave é obrigatório; retornar uma promise permite que o editor mostre se o salvamento funcionou. Um salvamento com falha é tentado de novo com um intervalo que dobra a cada vez, e de novo assim que o navegador volta a ficar online. Consulte os métodos editor.autoSave para controle manual.
editorResizeModebothboth, height ou none. Obtém ou define o modo de redimensionamento.
toggleBordertrueDefine o estado de ToggleBorder. ToggleBorder é uma função prática que permite ver as bordas sem definir border = 1 ou algo parecido no código.
showSelectedBlocktrueDefine se o bloco selecionado deve ou não ser destacado dentro do RichTextEditor.
showFloatTextToolBarfalseDefine se a FloatTextToolBar, definida por config.controltoolbar_TEXT, deve ser exibida.
showFloatLinkToolBarfalseDefine se a FloatLinkToolBar, definida por config.controltoolbar_A, deve ser exibida.
showFloatImageToolBbarfalseDefine se a FloatImageToolBbar, definida por config.controltoolbar_IMG, deve ser exibida.
showFloatTableToolBarfalseDefine se a FloatTableToolBar, definida por config.controltoolbar_TD, deve ser exibida.
showFloatParagraphtrueDefine se o FloatParagraph deve ser exibido no lado esquerdo.
floatParagraphPosleftLeft ou right. Obtém ou define a posição do FloatParagraph.
floatParagraphPosX0Um número que representa a coordenada horizontal do FloatParagraph, em pixels.
floatParagraphPosY0Um número que representa a coordenada vertical do FloatParagraph, em pixels.
showPlusButtontrueDefine se o botão de mais (+) do editor deve ser exibido.
showTagListtrueDefine se o seletor de tags deve ser exibido na barra inferior do editor.
showStatisticstrueDefine se as estatísticas do conteúdo devem ser exibidas na barra inferior do editor.
tabSpaces4Obtém ou define o número de espaços inseridos quando o usuário pressiona a tecla "tab".
enterKeyTagpDetermina o que acontece quando a tecla "enter" é pressionada no editor. div, p ou br.
htmlcode_forcehexformatfalseGrava as cores como #993300 em vez de rgb(153, 51, 0) no HTML salvo. O editor repassa a cor escolhida sem alteração; é o navegador que a normaliza para rgb() quando o estilo é lido de volta, por isso esta opção faz a conversão na saída. Vale para as cores já presentes em conteúdo carregado ou colado e também para as aplicadas pelo usuário, e cobre tanto a cor do texto quanto a do fundo. rgba() não é alterado, porque um hexadecimal de 6 dígitos não comporta o canal alfa.
paragraphClassparagraphO nome de classe especificado é adicionado automaticamente ao parágrafo quando um novo parágrafo é criado.
insertTableTag<table></table>Atributos padrão da tabela ao inserir uma tabela.
insertRowTag<tr></tr>Atributos padrão da linha ao criar uma linha de tabela.
insertCellTag<td><br/></td>Atributos padrão da célula ao inserir uma célula.
url_base/richtexteditorA pasta de onde o editor carrega os próprios arquivos: as folhas de estilo do conteúdo e da pré-visualização, o script da pré-visualização, a página de ajuda e a página More do seletor de cores. A partir do core 2.6.10, quando você não a define, ela acompanha a pasta de onde o rte.js foi carregado, então uma instalação via CDN ou em uma subpasta não precisa de configuração; antes disso, era sempre /richtexteditor. Defina-a para servir esses arquivos de outro lugar.
onready(none)A partir do core 2.6.10: uma função chamada uma vez quando o editor é montado e o conteúdo inicial é carregado (o evento ready). Equivale a editor.attachEvent("ready", fn).
pasteMode"Auto"Como o conteúdo colado é tratado: "Auto" mantém a formatação e a limpa, "PasteText" sempre cola texto simples, "PasteWord" sempre aplica a limpeza do Word e "Disabled" recusa a colagem. Ctrl+Shift+V cola texto simples em todos os modos, exceto Disabled.
smartLinkPastetrueColar uma URL com texto selecionado transforma o texto selecionado em um link, em vez de substituí-lo.
autoLinkPastetrueA partir do core 2.6.10: um endereço web em texto simples colado (https://… ou www.…) vira um link; a pontuação no final fica fora dele. Não se aplica com Ctrl+Shift+V nem dentro de um link ou de código. Defina como false para colar endereços como texto simples.
linkDefaultProtocol"http://"A partir do core 2.6.10: o protocolo colocado na frente de um endereço que não tem nenhum, como example.com digitado na caixa de diálogo de link ou um endereço www. colado. Defina como "https://" para usar links seguros por padrão.
pasteMarkdownfalseA partir do core 2.6.10: quando true, Markdown colado como texto simples (um README, um chat, uma resposta de IA) é convertido em conteúdo formatado: títulos, negrito, itálico, links, listas, citações e blocos de código. Texto que não parece Markdown, Ctrl+Shift+V e colagens dentro de código continuam como texto simples. O resultado é sanitizado como qualquer colagem.
markdownShortcutsEnabledtrueAtalhos de bloco do Markdown digitados no início de um parágrafo vazio: títulos de # a ######, marcadores - / *, listas numeradas 1. / 1) (um número diferente de 1 define o início), citação >, item de tarefa [ ] (com o plugin de tarefas), bloco de código ``` e --- + Enter para uma linha horizontal. Um Ctrl+Z devolve os caracteres digitados.
markdownInlineEnabledtrueFormatação automática de Markdown inline quando o delimitador de fechamento é digitado: **bold**, *italic*, `code`, ~~strike~~. O texto digitado em seguida continua sem formatação.
contentCssUrl%url_base%/runtime/
richtexteditor_content.css
Define o local da folha de estilo usada pela área editável.
previewCssUrl%url_base%/runtime/
richtexteditor_preview.css
Define o local da folha de estilo usada pela janela de pré-visualização.
previewScriptUrl%url_base%/runtime/
richtexteditor_preview.js
Define o local do arquivo JavaScript usado pela janela de pré-visualização.
contentCssText""Obtém ou define o texto CSS inline usado pela área editável. Por exemplo, "body{background-color:#eee}".
previewCssText""Obtém ou define o texto CSS inline usado pela janela de pré-visualização. Por exemplo, "body{background-color:#eee}".
editorBodyCssClass""Obtém ou define a classe da área de edição, para trocar de estilos.
editorBodyCssText""Obtém ou define o texto CSS inline usado pelo body editável.
editablePaddingTop2Define o espaçamento interno (padding) superior da área editável.
editablePaddingBottom2Define o espaçamento interno (padding) inferior da área editável.
editablePaddingLeft2Define o espaçamento interno (padding) esquerdo da área editável.
editablePaddingRight2Define o espaçamento interno (padding) direito da área editável.
zIndexFullPage9999Define o z-index do editor quando ele abre em modo de tela cheia.
zIndexFloat99999Define o z-index da barra de ferramentas flutuante do editor.
zIndexDialog999999Define o z-index da caixa de diálogo do editor.
zIndexDropDown9999999Define o z-index do menu suspenso do editor.
fontNameDropDownMinWidth90pxDefine a largura mínima (min-width) do menu suspenso de fontes.
fontNameDropDownMaxWidth110pxDefine a largura máxima (max-width) do menu suspenso de fontes.
tooltipAttributerte-tooltipDefine o atributo da dica de ferramenta do editor.
showKeyboardShortcutsInTooltipstrueMostra o atalho de teclado de cada botão da barra de ferramentas na dica de ferramenta dele ("Bold (Ctrl+B)", ⌘ em um Mac). O atalho aparece apenas na dica: os títulos das caixas de diálogo e o nome acessível do botão continuam sendo o rótulo simples, e o botão leva aria-keyshortcuts.
keyboardShortcutHints{ bold: "Ctrl+B", italic: "Ctrl+I", ... }O atalho exibido para cada comando, indexado pelo nome do comando. Adicione ou substitua entradas para refletir os atalhos que você mesmo associar. Não coloque atalhos nos rótulos text_*: um rótulo também é um título de caixa de diálogo e um nome acessível, e um pacote de idioma o substitui.
commentMentions[]As pessoas que um comentário pode mencionar, como um array de { id, name }. Digitar @ no campo de redação do comentário lista essas pessoas; escolher uma insere "@Name" e registra a menção no comentário. Vazio significa nenhuma lista de menções (plugin de comentários).
text_uilocaledefinido por cada pacote de idiomaA localidade do pacote de idioma carregado (por exemplo zh-Hans, de). O editor a usa para nomear os idiomas no menu de idioma de trechos de texto e na lista Translate do Ask AI, e para escrever chips de data, por meio da API Intl do navegador. Sem nenhum pacote carregado, é usado o inglês.
controlSelectionClassrte-control-selectedDefine a classe da seleção de controle do editor.
controlSelectionMargin7Define a margem da seleção de controle do editor.
altTextHinttrueImagens sem texto alternativo, ou com um texto alternativo vazio, recebem um contorno tracejado âmbar na área de edição, para que os autores vejam o que ainda precisa de descrição. Somente no editor; nada é adicionado ao HTML salvo. Defina false para ocultar o contorno.
autoHeadingAnchorstrueDá a cada título um id criado a partir do texto dele ("Hello World" vira hello-world) logo após cada alteração, para que links e um sumário possam apontar para ele; um id duplicado recebe -2, -3. Defina false para que o core pare de atribuir ids. Com o bundle de plugins carregado, o plugin de estrutura do documento passa a manter os ids dos títulos únicos por conta própria.
autoLinkOnTypetrueUma URL ou endereço de e-mail digitado no texto vira um link quando o espaço depois dele é digitado. Defina false para deixar os endereços digitados como texto simples.
backspaceOutdenttrueBackspace bem no início de um item de lista tira esse item da lista como parágrafo, em vez de juntá-lo ao item de cima. Defina false para juntar.
blockDragHandlestruePassar o mouse sobre um bloco (parágrafo, título, lista, tabela...) mostra uma alça de arrastar ao lado dele; arraste a alça para mover o bloco. Defina false para ocultar as alças.
collabEnabledtruePermite que o plugin de colaboração (yjscollab) configure editor.collab. Defina false e o plugin não faz nada: não existe editor.collab. A colaboração só começa quando você chama editor.collab.attach(...); este padrão, sozinho, não abre nenhuma conexão. Consulte colaboração.
collabShowPresencetrueQuando uma sessão de colaboração está conectada, mostra o painel que lista as outras pessoas no documento. Defina false para ocultá-lo.
collabShowRemoteCursorstrueQuando uma sessão de colaboração está conectada, mostra os cursores e as seleções das outras pessoas sobre o texto. Defina false para ocultá-los.
collabTextSyncfalseO que uma sessão de colaboração sincroniza além da presença e do registro de revisão (plugin yjscollab): false - nenhum texto do documento; true - snapshots do documento inteiro em um texto Yjs compartilhado; "crdt" - mesclagem caractere a caractere pelo engine CRDT (crdt-engine.min.js), que volta para snapshots quando o engine não está carregado.
collabRequireCrdtfalseCom collabTextSync: "crdt", se o engine CRDT estiver ausente, desativa a sincronização de texto em vez de voltar para snapshots (a presença e o registro de revisão continuam ativos); o console informa o motivo.
collabTextNamerichtextbox.bodyO nome do texto Yjs compartilhado usado pela sincronização por snapshots. Dê a cada editor em um mesmo documento Yjs o seu próprio nome.
aiToolkitEnabledtrueO plugin AI Toolkit. Defina false para desativá-lo: nenhum botão, menu ou caixa de diálogo de IA. Consulte AI Toolkit.
aiToolkitResolvernullA função que o AI Toolkit chama para acessar o seu serviço de IA (sua própria chave ou endpoint); editor.aiToolkit.setResolver(fn) a define em tempo de execução. Sem ela, o toolkit roda em modo de demonstração. A página do AI Toolkit descreve a requisição e a resposta.
aiToolkitAgentnullA função que editor.aiToolkit.runAgent(prompt) usa para planejar e aplicar edições em várias etapas; setAgent(fn) a define em tempo de execução. Sem nenhuma, runAgent é rejeitado com uma mensagem que informa isso.
aiToolkitAutoToolbarButtonstrueAdiciona os botões de IA às barras de ferramentas automaticamente. Defina false para posicionar os comandos de IA na sua própria string de barra de ferramentas.
aiToolkitActions(lista incluída)As ações do menu de IA: um array de { id, section, icon, title, description }. Substitua-o para mostrar o seu próprio conjunto.
aiToolkitDialogModes(lista incluída)Os modos da caixa de diálogo Ask AI (Proofread, Rewrite, Translate...): um array de { id, title, description }.
aiToolkitChatPrompts(lista incluída)Os prompts iniciais que o AI Chat oferece: um array de { id, label, prompt }.
aiToolkitTranslateLanguages(espanhol, francês, alemão, italiano...)Os idiomas que o Translate oferece: um array de { value, label }.
aiToolkitOperationHandlersHandlers para os tipos de operação que uma resposta de IA pode conter, por tipo: { myType: function (operation, context) { ... } }; retorne true quando o handler tiver aplicado a operação. editor.aiToolkit.registerOperationHandler() adiciona um em tempo de execução.
aiToolkitPersistenceKey(vazio)Uma chave para este documento. Defina-a e o estado da revisão de IA (sugestões e decisões) é mantido no localStorage do navegador em RTE.AIToolkit.<key>, sobrevivendo a um recarregamento; ela também identifica o documento para aiToolkitSuggestionLedgerUrl. Vazia, nada é armazenado.
aiToolkitReviewLogUrl(vazio)Uma URL no seu servidor que recebe cada decisão da revisão de IA como um POST em JSON, para um log de auditoria. Vazia, nada é enviado.
aiToolkitSuggestionLedgerUrl(vazio)Uma URL no seu servidor que recebe as sugestões de IA do documento e os estados delas como um POST em JSON, para que possam ser compartilhadas ou restauradas; requer aiToolkitPersistenceKey. Vazia, nada é enviado.
aiToolkitReviewSyncInterval15000Com que frequência o estado da revisão é sincronizado com o seu servidor, em milissegundos (no mínimo 5000).
collabLedgerMapNamereviewLedgerO nome do mapa Yjs compartilhado que leva comentários, sugestões e decisões de revisão de IA entre os participantes.
onCollabStatusnullChamado com { attached, textSyncMode, requestedTextSync, fallbackReason, yjsBridge, peerCount } quando uma sessão começa, para que você possa mostrar qual modo está em vigor (por exemplo, uma volta de CRDT para snapshots). O mesmo objeto é retornado por editor.collab.getStatus().
imageHoverQuickBartruePassar o mouse sobre uma imagem no editor mostra uma pequena barra de ações de imagem sobre ela. Defina false para ocultá-la.
imageLazyLoadtrueAs imagens que o editor insere (a partir de uma URL, de um upload ou de um arrastar e soltar) recebem loading="lazy" e decoding="async", para que um documento longo não carregue todas as imagens de uma vez. Defina false para inserir imagens sem esses atributos.
indentUseMargintrueAumentar e diminuir o recuo em um parágrafo ou título altera a margem dele, como faz o Word (margin-left em texto da esquerda para a direita). Defina false para alterar o padding em vez disso. O passo é indentation.
inlineMathtruePermite que editor.applyMathMarkup() envolva trechos $...$ em <span class="rte-math-inline" data-tex="...">, para que um renderizador de matemática como KaTeX ou MathJax os desenhe. Nada acontece até você chamar o método. Defina false e a chamada não altera nada.
placeholderShowOnlyWhenEditabletrueOculta o placeholder enquanto o editor está somente leitura (readOnly ou setReadOnly(true)) ou no modo só de comentários, e o mostra de novo quando a edição é permitida. Defina false para mostrá-lo também em um editor somente leitura. (Na 2.6.11 e anteriores, um editor somente leitura ainda o mostrava.)
showFloatLinkUrlPreviewtrueQuando o cursor está em um link, a barra de ferramentas flutuante de link começa com o endereço do link, que abre em uma nova aba ao ser clicado. Defina false para mostrar apenas os botões da barra.
smartPasteToasttrueDepois que um conteúdo colado do Word ou do Google Docs é limpo, um aviso curto informa isso. Defina false para limpar sem avisar.
tableColumnResizetrueApontar para a borda entre duas colunas de uma tabela mostra uma indicação de redimensionamento; arraste-a para mudar a largura da coluna. Defina false para desativar o redimensionamento de colunas por arraste.
tableRowResizetrueApontar para a borda inferior de uma linha de tabela mostra uma indicação de redimensionamento; arraste-a para mudar a altura da linha. Defina false para desativar o redimensionamento de linhas por arraste.
aiContextMenutrueCom o AI Toolkit carregado, clicar com o botão direito em um texto selecionado (três caracteres ou mais) abre um menu de ações de IA para esse texto. Defina false para manter o menu do próprio navegador.
wordExportFileName(none)Nome-base do arquivo para editor.exportToWord() (um .doc compatível com o Word) quando nenhum nome é passado. Sem definição, é usado o texto do primeiro título h1-h3, ou "document".
wordExportFontFamilyCalibri, 'Segoe UI', Arial, sans-serifFonte do corpo na exportação .doc. Uma opção passada para exportToWord() tem prioridade.
wordExportFontSize11ptTamanho da fonte do corpo na exportação .doc.
wordExportPageSize8.5in 11inTamanho da página na exportação .doc, como um tamanho CSS de @page (US Letter por padrão; "21cm 29.7cm" para A4). Uma configuração de página que o documento já tenha (visualização de página) tem prioridade.
wordExportMargin1inMargens da página na exportação .doc, como um comprimento CSS ou uma forma abreviada. Uma configuração de página que o documento tenha tem prioridade.
wordExportLandscapefalsePáginas em paisagem na exportação .doc. Uma configuração de página que o documento tenha tem prioridade.
docxExportFileName(none)Nome-base do arquivo da exportação .docx quando nenhum nome é passado. Sem definição, é Export- seguido da data e da hora (YYMMDD-HHMMSS, por exemplo Export-261026-153045.docx).
docxExportTitle(none)O título armazenado nas propriedades do arquivo .docx. Sem definição, o document.title da página, ou "Document".
docxExportAuthorRichTextEditorO autor armazenado nas propriedades do arquivo .docx.
pdfExportFileName(none)Nome-base do arquivo da exportação em PDF quando nenhum nome é passado. Sem definição, é Export- seguido da data e da hora (YYMMDD-HHMMSS).
pdfExportTitle(none)O título armazenado nos metadados do PDF. Sem definição, o document.title da página, ou "Document".
pdfExportAuthor(empty)O autor armazenado nos metadados do PDF.
pdfExportFonthelveticaA fonte da exportação de PDF vetorial (plugin pdfexport): "helvetica", "times" ou "courier", as fontes padrão do PDF, que não precisam ser incorporadas. Elas cobrem apenas o latim da Europa Ocidental; consulte pdfExportRasterFallback.
pdfExportBaseFontSize11O tamanho do texto do corpo no PDF vetorial, em pontos; os títulos são dimensionados a partir dele.
pdfExportHeader(none)Texto simples centralizado no topo de cada página do PDF vetorial; {page} e {total} viram o número da página e o total de páginas. Sem definição, o texto do cabeçalho de página do documento (visualização de página), se houver.
pdfExportFooter(none)Texto simples centralizado no rodapé de cada página, com os mesmos {page} e {total}.
pdfExportRasterFallbacktrueQuando um documento tem caracteres que o PDF vetorial não consegue codificar (qualquer coisa fora do latim da Europa Ocidental: chinês, japonês, coreano, cirílico, grego, árabe...), exportToPdf() e o Export PDF da barra de ferramentas usam em vez disso a exportação rasterizada do html2pdf, que desenha qualquer escrita, e informam isso no console. editor.getPdfUnsupportedText() lista esses caracteres. Defina false para sempre gerar o PDF vetorial; esses caracteres então são impressos como "?". Na 2.6.11 e anteriores, eles sempre eram impressos como "?".
pdfExportUnicodeFont(none)Os bytes de uma fonte TrueType (.ttf, como ArrayBuffer ou Uint8Array) para o texto que as fontes padrão não conseguem desenhar: chinês, japonês, coreano, cirílico, grego... Com ela, o PDF vetorial incorpora os glifos que o documento usa (algumas centenas de KB, mesmo a partir de uma fonte CJK grande), e esse texto continua selecionável e pesquisável; sem ela, consulte pdfExportRasterFallback. editor.loadPdfFont(url) busca uma fonte que você serve e define esta opção; nada é buscado a menos que você o chame. Arquivos CFF (.otf) e de coleção (.ttc) são recusados com uma mensagem no console.
mentionTrigger@O caractere que abre a lista de menções (plugin mentions). A lista só funciona depois que mentionStaticList ou mentionSource é definido.
mentionStaticListnullUma lista fixa de pessoas para o gatilho padrão: um array de { id, label (or name), subtitle (or email) }. O que for digitado depois do gatilho filtra a lista pelo label, subtitle e id, sem diferenciar maiúsculas de minúsculas; sem nada digitado, aparecem os 50 primeiros.
mentionSourcenullUma função que fornece a lista para o gatilho padrão: (query, { trigger }) => um array de itens, ou uma Promise de um array. Tem prioridade sobre mentionStaticList. Para mais gatilhos, use mentionTriggers ou editor.mentions.register().
mentionTriggersnullGatilhos extras, cada um { trigger, source (or search), insertClass, label, renderItem, renderInsert }, por exemplo # para tags. Callbacks search(query, done) e funções async são aceitos. Um gatilho sem source nem search é ignorado, com um aviso no console.
mentionMaxItems8O número máximo de resultados que a lista mostra.
mentionDebounceMs150Por quanto tempo a digitação precisa pausar antes de a fonte ser consultada de novo, em milissegundos. Logo depois do gatilho (com nada digitado ainda), ela é consultada imediatamente.
mentionInsertClassrte-mentionA classe do elemento de menção inserido. Um gatilho pode definir o próprio insertClass.
slashCommandTrigger/A tecla que abre o menu de comandos de barra (plugin slash command), digitada no início de uma linha ou depois de um espaço, e nunca dentro de código ou de pre.
slashCommandMaxItems40O número máximo de comandos que o menu de barra lista de uma vez.
documentOutlineEnabledtrueO painel de estrutura do documento (plugin documentoutline): uma lista dos títulos do documento para navegar entre eles. Defina false para não ter o botão Outline na barra de ferramentas nem o painel.
documentOutlineAutoOpenfalseAbre o painel de estrutura quando o editor é iniciado.
documentOutlineMinLevel1O nível de título mais alto que a estrutura lista (1 a 6).
documentOutlineMaxLevel6O nível de título mais baixo que a estrutura lista (1 a 6, não acima de documentOutlineMinLevel).
documentOutlineTitle"Outline" (traduzido)O título e o nome acessível do painel. Sem definição, é usado o texto do pacote de idioma.
documentOutlineHint(texto traduzido)A linha abaixo do título do painel.
documentOutlineEmptyText(texto traduzido)O que o painel diz quando o documento não tem títulos.
contentMinimapEnabledtrueO painel de minimapa (plugin contentminimap): uma pequena prévia do documento inteiro, para clicar e pular até um ponto. Defina false para não ter o botão Minimap na barra de ferramentas nem o painel.
contentMinimapAutoOpenfalseAbre o painel de minimapa quando o editor é iniciado.
contentMinimapWidth168A largura do painel em pixels (no mínimo 148).
contentMinimapScale0.14O quanto a prévia reduz o documento (0.14 = 14% do tamanho dele).
contentMinimapTitle"Minimap" (traduzido)O título e o nome acessível do painel.
contentMinimapHint(texto traduzido)A linha abaixo do título do painel.
contentMinimapEmptyText(texto traduzido)O que o painel diz enquanto o documento está vazio.
accessibilityCheckerEnabledtrueO painel do verificador de acessibilidade (plugin accessibilitychecker), que lista problemas como níveis de título pulados, imagens sem texto alternativo e tabelas sem cabeçalhos, com correções. Defina false para não ter o botão na barra de ferramentas nem o painel.
accessibilityCheckerAutoOpenfalseAbre o painel do verificador de acessibilidade quando o editor é iniciado.
accessibilityCheckerTitle"Accessibility" (traduzido)O título e o nome acessível do painel.
accessibilityCheckerHint(texto traduzido)A linha abaixo do título do painel.
accessibilityCheckerEmptyText(texto traduzido)O que o painel diz quando não encontra problemas.
contentAriaLabel(none)O nome acessível da área de edição e o título do frame do editor (plugin a11yenhance), seguidos da dica sobre a tecla Escape, por exemplo "Article body Press Escape to leave the editing area.". Sem definição, o "Rich text editor. Editing area." do pacote de idioma. Dê a cada editor de uma página o seu próprio nome.
contentLabel(none)Usado como contentAriaLabel quando este não está definido.
a11yEditorLabel(none)Usado como nome da área de edição quando nem contentAriaLabel nem contentLabel estão definidos (plugin keyboarda11y). Na 2.6.11 e anteriores, não tinha efeito com o bundle de plugins carregado.
a11yEscapeHint"Press Escape to leave the editing area." (traduzido)As palavras adicionadas depois do nome da área de edição, que dizem aos usuários de teclado como sair do editor.
contentLang(o lang da página)O lang do documento em edição, para a verificação ortográfica e a pronúncia do leitor de tela. Sem definição, acompanha o <html lang> da página host, ou en.
a11yReadOnlySuffix"Read only."O que os leitores de tela anunciam quando o editor passa a ser somente leitura.
a11yEditableAgain"Editing enabled."O que os leitores de tela anunciam quando o editor deixa de ser somente leitura.
a11yRovingToolbartrueA barra de ferramentas é uma única parada de Tab, e as teclas de seta movem entre os botões dela (o padrão ARIA de toolbar). Defina false para que cada botão seja a sua própria parada de Tab.
commentHighlightBg#fff9c4Cor de fundo do texto comentado (plugin de comentários).
commentHighlightBorder#f9a825Cor da linha sob o texto comentado.
trackChangesInsertClassrte-tc rte-tc-insertClasse do elemento que envolve uma inserção sugerida (modo de sugestão). Altere-a para estilizar as sugestões do seu jeito.
trackChangesDeleteClassrte-tc rte-tc-deleteClasse do elemento que envolve uma exclusão sugerida.
onReviewDecisionDeniednullChamado com { entry, action, user } quando reviewCanDecide recusa o Accept ou o Reject de alguém, para que você possa explicar o motivo.
reviewCanDecidenullUma função (entry, action, user, editor) que decide se este usuário pode aceitar ou rejeitar uma sugestão; retorne false para recusar. Se ela lançar uma exceção, a decisão é recusada.
restrictedEditingModefalseBloqueia o documento, exceto as regiões marcadas com data-rte-editable="true" (plugin de edição restrita), como um formulário do Word com campos preenchíveis. editor.restrictedEditing marca regiões, liga e desliga o bloqueio e navega entre as regiões.
pageHeaderHtml(empty)HTML repetido no topo de cada página na visualização de página (plugin pagination); {page} e {total} viram o número da página e o total de páginas. Um cabeçalho definido na configuração de página do documento tem prioridade.
pageFooterHtml(empty)HTML repetido no rodapé de cada página na visualização de página, com os mesmos {page} e {total}.
readabilityWordsPerMinute200Velocidade de leitura usada na estimativa do tempo de leitura (plugin de estatísticas de legibilidade).
maxLength0O número máximo de caracteres que o documento pode conter (plugin de limite de caracteres); 0 significa sem limite.
maxWords0O número máximo de palavras que o documento pode conter; 0 significa sem limite.
charLimitEnforcetrueImpede digitar e colar além de maxLength / maxWords. Defina false para apenas contar e informar (editor.isOverLimit(), o evento charlimit).
charLimitShowCountertrueMostra o contador flutuante enquanto houver um limite definido.
sanitizerAllowTags[]Nomes de elementos extras que o sanitizador de conteúdo mantém (plugin sanitizer): nomes exatos, curingas "x-*" ou expressões regulares, por exemplo ["custom-el", "x-*", /^ui-/]. Script e outros elementos executáveis nunca são mantidos.
sanitizerAllowAttributes[]Nomes de atributos extras que o sanitizador mantém, nas mesmas formas, por exemplo ["data-cms-*"]. Atributos de handlers de eventos (on*) nunca são mantidos.
sanitizerAllowStyleTagsfalseMantém blocos <style> dentro do conteúdo. Desativado por padrão: um bloco de estilo em um documento muda o estilo da página em que ele é exibido.
sanitizerGuardLiveDomtrueTambém observa a própria área de edição e a limpa de novo quando conteúdo executável aparece ali por qualquer caminho - scripts, atributos on*, URLs javascript: -, e não só ao colar e com setHTMLCode(): conteúdo que chega pela sincronização de colaboração, por outro script na página ou por uma extensão do navegador. Defina false para limpar apenas o que passa pelos caminhos do próprio editor. O sanitizador roda no navegador; verifique o conteúdo no seu servidor também.
documentImportModereplaceO que a importação de um arquivo faz (plugin de importação de documentos): "replace" substitui o documento e "insert" insere na posição do cursor. A substituição é uma única etapa de desfazer.
documentImportAccept.md,.markdown,.html,.htm,.txt,.doc,.docxOs tipos de arquivo que a caixa de diálogo de importação oferece.
documentImportImagestrueTraz as imagens de um .docx importado, como data URIs. Defina false para ignorá-las em arquivos com muitas imagens.
documentImportResolver(none)Uma função (file) => HTML (ou uma Promise dele) que converte um arquivo por sua conta, por exemplo no seu servidor. Retorne uma string para assumir a conversão; qualquer outro valor, ou uma Promise rejeitada, volta para o leitor incluído.
dictationEnabledfalseAtiva o ditado (plugin dictation): a fala é digitada no documento por meio do reconhecimento de fala do navegador (Web Speech API). Desativado por padrão. Em alguns navegadores, como o Chrome, o reconhecimento roda nos servidores do fabricante do navegador, então o áudio sai do dispositivo do usuário; verifique se isso é aceitável antes de ativar.
dictationLang(o idioma do navegador)O idioma a reconhecer, como uma tag BCP-47, por exemplo en-US. Sem definição, navigator.language.
dictationContinuoustrueContinua ouvindo durante as pausas. Defina false para parar depois de uma fala.
dictationInterimResultstrueMostra a transcrição parcial enquanto o usuário ainda está falando.
dictationAutoPunctuationtrueColoca em maiúscula a primeira letra de cada frase ditada e a termina com um ponto final quando ela não tem pontuação própria.
commentsEnabledtrueO plugin de comentários (comentários inline, respostas, resolver). Defina false para desativá-lo.
trackChangesEnabledtrueO plugin de controle de alterações (modo de sugestão, aceitar e rejeitar). Defina false para desativá-lo.
currentUsernull{ id, name, color } - quem está editando. Comentários, sugestões, histórico de revisões e colaboração registram essa pessoa como autora; defina-o sempre que souber quem é o usuário.
mentionEnabledtrueO plugin de menções. Defina false para desativá-lo. As menções só aparecem depois que uma fonte é definida (mentionStaticList, mentionSource ou mentionTriggers).
slashCommandEnabledtrueO menu de comandos de barra (plugin slash command). Defina false para desativá-lo.
slashCommandIncludeAitrueLista as ações do AI Toolkit no menu de barra quando o AI Toolkit está carregado. Defina false para deixá-las de fora.
slashCommandsnullComandos extras para o menu de barra, registrados na inicialização: um array de { id, section, title, description, keywords, iconSvg, run }, no mesmo formato que editor.slashCommands.register() recebe.
galleryEndpoint(none)Uma URL à qual a caixa de diálogo da galeria pede pastas e imagens (plugin insertgallery). Ela retorna { currentFolder, currentFolderDisplay, parentFolder, folders: [{ folder, name }], images: [{ url, name, folder, size, source, alt }] }. Sem definição, a galeria mostra apenas galleryImages e não faz nenhuma requisição.
nodeTypesEnabledtrueO registro de tipos de nó personalizados (plugin nodetypes). Defina false para desativá-lo.
nodeTypes(none)Tipos de nó a registrar na inicialização, no mesmo formato que editor.nodeTypes.register() recebe: { name, match, inline, atomic, toJSON, fromJSON, toMarkdown }. Um elemento registrado mantém a sua marcação ao passar pelo sanitizador e recebe uma forma em Markdown que você escolhe, em vez de virar apenas o seu texto.
rubyAnnotationEnabledtrueAnotações ruby (plugin rubyannotation): guias de leitura acima de texto do Leste Asiático, escritas como <ruby> com <rt>. Defina false para desativá-las.
rubyAnnotationParenthesestrueGrava parênteses <rp> em volta de cada leitura, para que um leitor sem suporte a ruby mostre "base(leitura)" em vez de juntar os dois.
stateInspectorEnabledtrueO inspetor de estado (plugin stateinspector): um painel para desenvolvedores que mostra a estrutura do documento, problemas estruturais e um snapshot copiável para relatórios de bugs. Defina false para desativá-lo.
stateInspectorToolbarButtonfalseAdiciona um botão na barra de ferramentas que abre o inspetor de estado. Desativado por padrão; abra-o com editor.stateInspector.open().
stateInspectorAutoOpenfalseAbre o inspetor de estado quando o editor é iniciado.
stateInspectorLogLimit60Quantos eventos recentes do editor o inspetor guarda (10 a 500).
stateInspectorMaxDepth24Até que profundidade o inspetor percorre a árvore do documento (no mínimo 2).
stateInspectorTitleState inspectorO título do painel.
stateInspectorHint(texto)A linha abaixo do título do painel.
stateInspectorEmptyTextNo content to inspect yet.O que o painel diz enquanto o documento está vazio.
NomePadrãoDescrição
paragraphItemsNormal,H1,H2,H3,H4,H5,H6Um conjunto predefinido de blocos de formatação.
fontSizeItems8,9,10,11,12,13,14,16,
18,24,36,48,60,72,96
Um conjunto predefinido de tamanhos de fonte.
fontNameItemsArial,Arial Black,Comic Sans MS,
Courier New,Tahoma,Georgia,Helvetica,
Segoe UI,Sans-Serif,Impact,
Times New Roman,Verdana
Um conjunto predefinido de nomes de fontes.
lineHeightItems100%,150%,200%,250%,300%,
350%,400%,450%,500%,600%
Um conjunto predefinido de alturas de linha.
inlineStyles[["Red", "color:red", "color:red"],
["Bold", "font-weight:bold", "font-weight:bold"],
["Mark", "my-cls-mark"],
["Warning", "my-cls-warning"]]
Estilos CSS padrão do menu suspenso de estilos inline.
[texto, estilo css, estilo de exibição]
paragraphStyles[["Red", "color:red"],
["Bold", "font-weight:bold"],
["Quote", "my-cls-quote"],
["Large Center", "my-cls-largecenter"]]
Estilos CSS padrão do menu suspenso de estilos de parágrafo.
[texto, estilo css, estilo de exibição]
imageStyles[["Border", "border:solid 1px gray"],
["Shadow", "box-shadow:0 0 8px gray"],
["Margin10", "margin:10px"],
["Padding:10", "padding:10px"]]
Estilos CSS padrão do menu suspenso de estilos de imagem.
[texto, estilo css]
linkStyles[["Margin10", "margin:10px"],
["Padding:10", "padding:10px"],
["BigText", "font-size:36px"]]
Estilos CSS padrão do menu suspenso de estilos de link.
[texto, estilo css]
galleryImages[]Imagens predefinidas para a caixa de diálogo da galeria: uma URL, [url, text] ou { url, name, alt }. Vazio por padrão (até a 2.6.11, listava seis imagens de exemplo em richtexteditor.com, buscadas no nosso servidor sempre que a galeria abria). Consulte galeria de imagens.
htmlTemplates[]Modelos que a caixa de diálogo Insert Template oferece: [title, html] ou { title, html, description }. Vazio por padrão (até a 2.6.11, vinha com dois modelos de demonstração, ambos chamados "My Doc 1"); sem nenhum, a caixa de diálogo informa isso.
characterItemsUm conjunto predefinido de caracteres.
foreColorItemsUm conjunto predefinido de cores de texto.
backColorItemsUm conjunto predefinido de cores de fundo.
linkItems[]Endereços que a caixa de diálogo Insert Link sugere, por exemplo ["/about", "/contact"]. Vazio por padrão (até a 2.6.11, sugeria cinco sites de grandes empresas); sem itens, a seta de sugestões fica oculta.
imageItems[]Endereços que a caixa de diálogo Insert Image (por URL) sugere. Vazio por padrão; sem itens, a seta fica oculta.

Opções de plugins

As opções acima configuram o core do editor. Tudo o que vem abaixo é fornecido pelos plugins incluídos em richtexteditor/plugins/. Defina-as da mesma forma — no objeto de opções do construtor ou globalmente em RTE_DefaultConfig, antes de criar um editor.

Prévia do build a partir do código-fonte: opções de plugins mais recentes

Estas opções existem nos plugins atuais do código-fonte, mas não estão incluídas em todos os bundles publicados nem nos arquivos de demonstração atuais deste site. Use um build de plugins testado e correspondente; definir uma opção não adiciona um recurso ausente a um runtime mais antigo.

OpçãoPadrãoDescrição
aiToolkitImageResolvernullBuilds com geração de imagens: (prompt: string) => Promise<string>. O seu resolver retorna uma URL de imagem HTTPS ou uma data URL de imagem PNG/JPEG/WebP/GIF, com no máximo 6,000,000 caracteres. O plugin não chama nenhum provedor por conta própria. Mantenha as credenciais do provedor no seu servidor; aplique a sua política de upload/armazenamento antes de salvar imagens geradas.
galleryAcceptedExtensionsnullBuilds da galeria: um array como [".jpg", ".png"] que substitui os formatos que a caixa de diálogo Insert Gallery informa e permite. Defina-o com o que o seu endpoint de upload aceita.
commentMentions[]Builds com menções em comentários: [{ id, name }] fornece as pessoas sugeridas depois de @ no campo de redação do comentário. O id/name da pessoa escolhida é guardado com o comentário. É uma lista de sugestões, não um mecanismo de autorização nem um serviço de notificação/e-mail; a sua aplicação precisa fornecer isso separadamente.
tableRowDragtrueBuilds com arraste de linhas: defina false antes de criar o editor para ocultar as alças de arraste das linhas. As linhas de cabeçalho ficam fixas. Tabelas com células mescladas ou irregulares, conteúdo somente leitura/só de comentários e o modo de sugestão recusam movimentos não suportados; mover uma linha não é registrado como sugestão. Escape cancela um arraste.
tableColumnDragtrueBuilds com arraste de colunas: defina false antes de criar o editor para ocultar as alças de arraste das colunas. Move as células de todas as linhas junto com a largura da coluna; uma coluna de numeração de linhas continua em primeiro lugar. Tabelas com células mescladas ou irregulares e os modos somente leitura/só de comentários ou de sugestão recusam movimentos não suportados. Escape cancela um arraste.

IA

Todos os recursos de IA usam a sua própria chave: o editor chama uma função fornecida por você e nunca se comunica diretamente com um provedor.

OpçãoPadrãoDescrição
ghostTextfalseAtiva o preenchimento automático inline em texto cinza. Tab aceita, Esc descarta.
ghostTextResolvernullasync ({ before }) => string. Obrigatório para que ghostText faça alguma coisa.
aiToolkitReviewLegacyLayouttrueUsa o layout anterior da gaveta AI Review.
aitoolkit_skip_auto_csstrueNão injeta automaticamente a folha de estilo do AI Toolkit, quando você fornece a sua própria.

Ajudas de digitação e de redação

Comportamentos que agem enquanto o autor digita. Todos podem ser desativados individualmente.

OpçãoPadrãoDescrição
autocorrectEnabledtrueChave geral do plugin de autocorreção. Não desativa a tipografia inteligente do core do editor - consulte smartTypography.
autocorrectCapitalizetrueColoca em maiúscula a primeira letra de uma frase.
autocorrectSpellingtrueAplica a lista incluída de erros de ortografia comuns.
autocorrectTypographytrueAspas inteligentes, travessões e reticências feitos pelo plugin de autocorreção. O core do editor faz as mesmas substituições por conta própria; para impedi-las, defina smartTypography como false.
autocorrectReplacementsnullO seu próprio mapa de substituições { from: to }, mesclado com o incluído.
emojiAutocompleteEnabledtrueDigite :shortcode: para inserir um emoji.
emojiShortcodes{ … }Substitui ou estende o mapa de shortcodes para emojis.
foldHeadingsEnabledtrueTítulos recolhíveis na área de edição.
typewriterModeEnabledfalseMantém a linha do cursor fixa na vertical durante a digitação.
typewriterAnchor0.5Onde fica a linha do cursor, de 0 (topo) a 1 (base).
focusModeEnabledfalseEsmaece todos os blocos, exceto o que contém o cursor.
dragHandleEnabledtrueMostra a alça de arrastar blocos na margem.
dragHandleKeyboardtruePermite reordenar blocos pelo teclado (Alt+Up / Alt+Down).
formattingMarkPilcrowtrueMostra marcas de parágrafo (¶) quando as marcas de formatação estão ativas.
formattingMarkBlockstrueContorna os limites dos blocos quando as marcas de formatação estão ativas.
formattingMarkInvisiblestrueRevela espaços, tabulações e espaços não separáveis.
permanentPenClass"rte-pen"Classe aplicada ao texto da caneta permanente.
permanentPenStyle{ … }Objeto de estilo inline para o texto da caneta permanente.
titleCaseSmallWords"a an and as at …"Palavras que Change Case → Title Case deixa em minúsculas.
formatPainterProperties[ … ]Quais propriedades CSS o pincel de formatação copia.
readabilityStatstrueMostra estatísticas de facilidade de leitura na barra de status.
localDraftfalseMantém um rascunho local, para que o conteúdo sobreviva a um recarregamento acidental.

Blocos, estrutura e referências

Conteúdo estrutural: destaques (callouts), colunas, listas numeradas, notas de rodapé, referências cruzadas e um sumário.

OpçãoPadrãoDescrição
text_inlinecode"Inline code"Rótulo e dica de ferramenta do botão de código inline (comando "inlinecode", gera um elemento <code> simples).
calloutTypes[ … ]Tipos de destaque disponíveis (info, warning, …).
calloutDefaultType"info"Tipo de destaque inserido quando nenhum é escolhido.
columnsDefaultCount2Colunas criadas pelo bloco de colunas.
legalListClass"rte-legal-list"Classe aplicada às listas jurídicas de vários níveis.
legalListSeparator"."Separador entre os números dos níveis (1.1.1).
legalListSuffix"."Caractere final depois do último nível.
lineNumberStart1Primeiro número de linha.
lineNumberInterval1Mostra o número a cada N linhas.
lineNumberRestart"continuous""continuous" ou reinício a cada página.
lineNumberGutter38Largura da margem em pixels.
footnotesTitle"Footnotes"Título exibido acima da lista de notas de rodapé.
footnotesNumbering"decimal"Estilo do marcador na numeração das notas de rodapé.
footnotesMarkerPrefix""Texto antes de cada marcador de nota de rodapé.
footnotesMarkerSuffix""Texto depois de cada marcador de nota de rodapé.
crossRefFigureLabel"Figure"Rótulo usado ao fazer referência a uma figura.
crossRefTableLabel"Table"Rótulo usado ao fazer referência a uma tabela.
crossRefMissingText"[reference not found]"Exibido quando o destino de uma referência cruzada não existe mais.
tocTitle"Contents"Título do sumário gerado.
tocMinLevel1Nível de título mais alto incluído.
tocMaxLevel3Nível de título mais baixo incluído.
tocPageNumbers"auto"Mostra números de página no sumário.
mathDialogSamples[ … ]Equações iniciais oferecidas na caixa de diálogo de equações.
tableNumberSeries"numeric"Série de numeração para os números de linha da tabela.
tableNumberHeader"#"Texto do cabeçalho da coluna de números de linha.

Layout de página, exportação e importação

Tudo o que transforma o documento em um arquivo ou em uma página impressa. A exportação roda no navegador; nada é enviado.

OpçãoPadrãoDescrição
paginationEnabledfalseMostra o documento como páginas separadas.
pageFormat"A4"Tamanho de página usado pela paginação e pela exportação.
pageOrientation"portrait""portrait" ou "landscape".
pageMargins{ top: 1, right: 1, bottom: 1, left: 1 }Margens em polegadas.
paginationShowPageNumberstrueExibe números de página na visualização de página.
paginationShowPageCounttrueExibe "of N" ao lado dos números de página.
docxExporttrueAtiva a exportação para .docx (gerada no navegador, sem servidor).
wordExporttrueAtiva a exportação em HTML compatível com o Word.
documentImporttrueAtiva a importação de .docx.
pdfExporttrueAtiva a exportação para PDF vetorial com tags.
html2pdfScriptUrlnullCaminho para o html2pdf no fluxo de PDF rasterizado; omita para manter apenas o fluxo vetorial.
markdownExportEnabledtrueAtiva Copy / Download as Markdown.
emailWrapWidth640Largura da tabela usada pela exportação em HTML para e-mail.
emailInlineProperties[ … ]Propriedades CSS aplicadas inline nos elementos para clientes de e-mail.
watermarkText"DRAFT"Texto da marca d'água.
watermarkImagenullMarca d'água em imagem; substitui a marca d'água em texto.
watermarkMode"tile""tile" ou uma única marca centralizada.
watermarkOpacity0.18Opacidade da marca d'água, de 0 a 1.
watermarkAngle-30Rotação em graus.
watermarkColor"#94a3b8"Cor da marca d'água.
watermarkFontSize48Tamanho da fonte da marca d'água em pixels.
watermarkPrintfalseInclui a marca d'água na impressão.

Os resolvers permitem que você forneça a sua própria fonte de dados. Cada um é uma função simples, então o endpoint e as credenciais continuam sendo seus.

OpçãoPadrãoDescrição
autoEmbedEnabledtrueTransforma uma URL colada do YouTube ou do Vimeo em um embed responsivo.
autoEmbedResolvernull(url) => URL https do embed, ou null para recusar. Adicione os seus próprios provedores.
bookmarkResolvernull(url) => metadados para cards de prévia de link.
bookmarkFaviconService"/favicon-proxy?domain="Endpoint de favicon para os cards de bookmark. Aponte-o para o seu próprio proxy.
diagramResolvernullForneça um renderizador Mermaid; nenhum vem incluído.
diagramSamples[ … ]Diagramas iniciais oferecidos na caixa de diálogo de inserção.
drawingWidth640Plugin de desenho (drawing.js, próxima versão): largura da tela de desenho em pixels CSS.
drawingHeight360Plugin de desenho (próxima versão): altura da tela de desenho em pixels CSS.
drawingColors[6 colours]Plugin de desenho (próxima versão): as amostras de cor oferecidas para a caneta e o marcador.
text_insertdrawing"Drawing"Plugin de desenho (próxima versão): rótulo do botão insertdrawing na barra de ferramentas.
chipResolvernull(query) => itens de smart chip.
chipDateFormatnullString de formato para os chips de data.
mergeFields[ … ]Campos de mesclagem disponíveis.
mergeFieldPrefix"{{"Delimitador de abertura.
mergeFieldSuffix"}}"Delimitador de fechamento.
mergeFieldMissing"placeholder"O que exibir quando um campo não tem valor.

Idioma, direção e acessibilidade

O editor vem com 67 idiomas. Além disso, a direção do texto e o comportamento de acessibilidade são configuráveis.

OpçãoPadrãoDescrição
defaultTextDirectionnull"ltr", "rtl" ou null para herdar.
textDirectionAutoDetectfalseDetecta a direção a partir do texto que está sendo digitado.
textDirectionSwapAligntrueEspelha o alinhamento quando a direção se inverte.
rtlUserInterface"auto"Espelha a barra de ferramentas e as caixas de diálogo em localidades RTL.
a11yEnhancetrueNomes e papéis acessíveis na interface do editor.
dialogA11ytrueRetenção de foco e rótulos dentro das caixas de diálogo.
keyboardA11ytrueTabindex móvel (roving tabindex) nas barras de ferramentas, para que Tab saia do editor.
readAloudRate1.0Velocidade da fala na leitura em voz alta.
readAloudHighlighttrueDestaca o texto enquanto ele é falado.
textPartLanguages24 languagesIdiomas oferecidos pelo menu suspenso Language: [{ code, label, dir }]. WCAG 3.1.2.
textPartLanguageHighlighttrueSublinhado pontilhado nas frases marcadas durante a edição. Somente no editor; nunca é serializado.

Área de edição e regiões

Como alcançar posições que não têm um nó para conter o cursor, e como controlar várias regiões editáveis a partir de uma única barra de ferramentas.

OpçãoPadrãoDescrição
gapCursorKeystrueSetas/Home/End saem de uma tabela ou de outro bloco que prende o cursor na borda do documento.
gapCursorClicktrueClique no espaço em branco em volta do conteúdo para inserir um parágrafo ali.
gapCursorHinttrueMostra uma indicação de inserção em um limite de altura zero entre dois blocos.
multiRootGroupnullAs instâncias que compartilham este nome de grupo funcionam como um único editor, com uma única barra de ferramentas visível.
multiRootNamecontainer idO nome desta região na API do grupo (getHTML, focusRoot, …).
multiRootToolbarHostnullElemento (ou o id dele) para onde mover a barra de ferramentas ativa. null a mantém no lugar.
layoutTableOutlinetrueContorno tracejado em volta das tabelas de layout durante a edição. Uma tabela marcada com role="presentation" é invisível por definição; esta é a única forma de ver o que você está editando. Somente no editor.
shadowStyleAdoptiontrueCopia as folhas de estilo do editor para a shadow root que o contém. Sem isso, o editor edita corretamente, mas aparece ali totalmente sem estilo, porque nenhuma folha de estilo do documento atravessa o limite de uma shadow root. Não tem custo fora de uma shadow root.
shadowStyleSourcesnullURLs de folhas de estilo extras para copiar também através do limite da shadow root — as suas próprias sobrescritas de skin. String ou array.

Estilos a partir do seu próprio CSS

Preencha os menus suspensos de Quick Styles com as classes que já estão nas folhas de estilo da página, em vez de digitá-las de novo na configuração.

OpçãoPadrãoDescrição
importStylesfalseChave geral. Precisa ser ativada explicitamente, porque em uma página com CSS utilitário a lista de classes é enorme.
importStylesSheetsnullQuais folhas ler: string ou RegExp comparada com o href, ou uma função. null = todas as legíveis.
importStylesExclude/^(rte|ck|mce|…)/Lista de bloqueio de nomes de classes aplicada além da exclusão automática do CSS do editor.
importStylesFilternull(className, selector, bucket) => false para ignorar, ou uma string para renomear.
importStylesReplacefalseSubstitui os estilos configurados em vez de acrescentar a eles.
importStylesLimit100Limite por menu suspenso. O que fica de fora é informado; nada é cortado sem aviso.

Segurança e verificação do conteúdo

Filtragem e validação. Estas são as opções sobre as quais uma revisão de segurança vai perguntar.

OpçãoPadrãoDescrição
contentSanitizertrueFiltro de lista de permissões na entrada, na saída e no DOM ativo. Deixe-o ativado.
spellCheckEnabledtrueMarca a área editável com spellcheck="true" para o verificador do navegador.
spellCheckResolvernull(text) => [{ word, offset, length, suggestions }] a partir de qualquer serviço que você licencie.
linkCheckResolvernull(urls) => resultados de acessibilidade dos links para o verificador de links.
linkCheckMixedContenttrueSinaliza links http:// em uma página https://.
linkCheckUnsafeSchemes["javascript:", "data:", …]Esquemas informados como inseguros.

Histórico de revisões

Versões nomeadas do documento, mantidas no navegador e, opcionalmente, enviadas ao seu servidor.

OpçãoPadrãoDescrição
revisionHistoryEnabledtrueDefina como false para desativar o plugin de histórico de revisões.
revisionHistoryKey(page path + query)A partir do core 2.6.10: a chave sob a qual as versões DESTE documento são armazenadas. Defina-a com o id do registro em um CMS, principalmente quando a URL não identifica o documento. Builds anteriores compartilhavam uma única lista em todo o site.
revisionHistoryMaxEntries50Versões mantidas; as mais antigas são descartadas primeiro.
revisionHistoryAutoSnapshotMs0Cria uma versão automaticamente a cada N ms quando o conteúdo mudou; 0 = somente quando solicitado.
revisionHistorySnapshotBeforeRestoretrueA partir do core 2.6.10: Restore primeiro guarda o conteúdo atual como uma versão "Before restoring …", para que uma restauração feita por engano possa ser desfeita. false = o comportamento antigo, que descartava o trabalho não salvo.
revisionHistoryUrl""Faz POST de cada versão para esta URL como JSON.
revisionHistoryRequestHeadersnullCabeçalhos para esse POST, como um objeto ou uma função que retorna um (por exemplo, um token de autenticação).
onRevisionHistorySyncErrornull(detail) => chamada quando um POST falha; a versão continua guardada localmente.