DocumentaçãoSDK no GitHub

Documentação Guias

Configurar o editor

Defina aparência, idioma, modos de edição e recursos disponíveis.

Nesta página

Definir padrões no painel

Salve os padrões no painel. Opções de montagem de nível superior prevalecem sobre editorConfig; configurações omitidas usam os valores do painel. Preferências do SDK não podem ativar recursos bloqueados pelo serviço, assinatura ou painel.

Alterar aparência e idioma

theme define o estilo da interface do editor. Use as configurações do próprio e-mail para mudar seu design. A opção locale define o idioma da interface. Alterar o idioma preserva o texto escrito; os rótulos dos temporizadores seguem a interface.

typescript
import { mount } from '@weavour/editor';

const editor = mount('#email-editor', {
  editorKey: 'YOUR_PUBLIC_EDITOR_KEY',
  userId: 'user-123',
  locale: 'en',
  theme: {
    mode: 'light',
    primaryColor: '#6b59d0',
    shellColor: '#f7f8fc',
    inputColor: '#ffffff',
    fontFamily: 'Inter',
    cornerRadius: 8,
    density: 'compact',
  },
  onError: console.error,
});

await editor.ready;
editor.updateConfig({ theme: { mode: 'dark' }, locale: 'fr' });

Alternar entre edição e prévia

Defina mode na montagem ou chame updateConfig({ mode: 'preview' }). Use edit para voltar à edição. A troca preserva o e-mail e o histórico de desfazer; modos sem edição pausam o salvamento automático. Exige SDK 0.1.7 e um editor hospedado compatível.

typescript
// Call these from your application's preview and edit actions.
function showPreview() {
  editor.updateConfig({ mode: 'preview' });
}

function resumeEditing() {
  editor.updateConfig({ mode: 'edit' });
}

Escolher blocos e recursos

allowedBlocks filtra a paleta de inserção. Um array vazio oculta todas as opções; o conteúdo existente é preservado. As opções de recursos podem ser definidas na montagem ou por updateConfig().

Blocos da organização exigem userId e organizationId. Desative enableOrganizationBlocks para ocultar salvamento e reutilização, preservando os blocos salvos. Antes de desativar o salvamento automático, conclua as alterações que deseja salvar.

typescript
// Run on your mounted editor instance.
editor.updateConfig({
  allowedBlocks: ['text', 'heading', 'image', 'button', 'section', 'columns'],
  enableTemplates: true,
  enableEmailAudit: true,
  enableTestEmail: false,
  enableOrganizationBlocks: false, // Hide organization block saving and reuse.
});

// Opt out of hosted drafts when your application manages persistence.
editor.updateConfig({ enableAutosave: false });

Blocos personalizados

Informe customBlocks para registrar blocos definidos pela sua aplicação. Cada definição fornece valores JSON iniciais, controles de campos e uma função de renderização HTML. Eles aparecem após os blocos padrão na mesma grade. Use custom:<id> em uma lista explícita de allowedBlocks.

Ativar IA

Configure créditos gerenciados ou sua chave OpenAI no painel. Nunca passe uma chave de provedor pelo SDK. A IA exige acesso pago ou teste ativo em ambas as opções.

Precisa de ajuda? Fale com a gente