Primeiros passos

Instalação

Adicione o widget de comentários a qualquer site com um script e uma tag, e controle qual conversa cada página mostra.

O código de incorporação

Copie seu código de incorporação em Site Console → seu widget → Install & Embed, onde sua app key já vem preenchida.

<script defer src="https://embeds.crowment.com/comments.js"></script>

<crow-comments app-key="YOUR_APP_KEY"></crow-comments>
  1. Coloque a tag <script> no <head> das suas páginas. Basta carregá-la uma vez por página.
  2. Coloque a tag <crow-comments> no <body>, onde a seção de comentários deve aparecer, normalmente logo depois do seu artigo.

Essa é toda a instalação. O widget se ajusta à largura do elemento ao redor.

Só o dono do widget vê Install & Embed. Administradores e moderadores podem pedir o código de incorporação ao dono.

WordPress

O plugin Crowment Comments substitui os comentários nativos do WordPress pelo widget; não é preciso editar o tema.

  1. Baixe crowment-comments.zip.
  2. No WordPress, vá em Plugins → Add New → Upload Plugin, escolha o zip e selecione Install Now e depois Activate.
  3. Em Settings → Crowment Comments, cole sua app key e salve.

Seus comentários do WordPress continuam no banco de dados; ficam ocultos enquanto o plugin estiver ativo. Para atualizar o plugin, envie o novo zip do mesmo jeito e confirme a substituição da versão atual.

Sites no WordPress.com precisam de um plano que permita plugins.

Frameworks e criadores de sites

<crow-comments> é um web component padrão, então funciona em qualquer lugar onde você possa adicionar HTML: sites estáticos, temas de CMS, React, Vue, Svelte, Angular e outros.

Há guias passo a passo para WordPress, Hugo, Jekyll, Astro, Next.js, Nuxt, Ghost e Webflow na página Integrations (em inglês).

Alguns frameworks avisam sobre tags desconhecidas. Diga a eles que crow-comments é um elemento personalizado:

export default defineNuxtConfig({
  vue: {
    compilerOptions: {
      isCustomElement: tag => tag === 'crow-comments',
    },
  },
})

Aplicativos de página única

Você não precisa recriar o widget quando o aplicativo muda de rota. Ele acompanha sozinho a navegação no navegador (pushState, replaceState e os botões de voltar e avançar) e carrega a conversa da nova página.

Qual conversa uma página mostra

Cada página tem sua própria conversa. Por padrão, o widget identifica uma página pelo caminho da URL e ignora o resto do endereço. Para https://example.com/blog/ola?ref=mail#comentarios, isso é /blog/ola. Ou seja:

  • /blog/ola?utm_source=newsletter e /blog/ola compartilham uma conversa.
  • /blog/ola e /blog/ola/ são caminhos diferentes, então têm conversas diferentes. Mantenha suas URLs consistentes.
  • As conversas pertencem a um widget. Dois widgets nunca compartilham comentários, mesmo no mesmo caminho.

Três atributos mudam a forma como uma página é identificada:

  • watch-query adiciona os parâmetros de consulta à identidade da página, em ordem alfabética, então ?b=2&a=1 e ?a=1&b=2 são iguais. Use quando a consulta seleciona o conteúdo, como em /watch?v=abc123. Todo parâmetro conta, incluindo os de rastreamento como utm_source.
  • watch-hash adiciona o hash à identidade da página. Use com rotas baseadas em hash, como /#/posts/42.
  • page-id troca a URL por um identificador escolhido por você. Use quando o mesmo conteúdo está em várias URLs ou quando suas URLs podem mudar. Um valor estável, como o ID do post no seu banco de dados, mantém a conversa ligada à página mesmo que a URL mude.
<crow-comments app-key="YOUR_APP_KEY" page-id="post-1842"></crow-comments>
Decida como as páginas serão identificadas antes de publicar. Se depois você adicionar page-id ou watch-query, ou mudar a estrutura das suas URLs, as páginas ganham novas identidades e as conversas antigas deixam de aparecer. Os comentários não são apagados, mas continuam ligados à identidade antiga.

Adicione crowment_cid com o ID de um comentário a qualquer URL de página para abri-la com a conversa daquele comentário carregada, por exemplo https://example.com/blog/ola?crowment_cid=COMMENT_ID. Os IDs dos comentários podem ser copiados no menu do comentário, no widget.

Referência de atributos

Atributos booleanos ficam ativos quando estão presentes: <crow-comments app-key="…" watch-query>. Você pode mudar qualquer atributo depois que a página carregar, e o widget acompanha.

app-key
string required
A app key do seu widget, em Install & Embed.
lang
string
Idioma da interface: en (padrão), es, pt-BR ou tr. Veja Aparência e idioma.
light-theme
string
Tema em fundos claros. Padrão: light.
dark-theme
string
Tema em fundos escuros. Padrão: dark.
force-theme
string
Usa sempre este tema e desliga a detecção de claro e escuro.
watch-query
boolean
Inclui os parâmetros de consulta na identidade da página.
watch-hash
boolean
Inclui o hash da URL na identidade da página.
page-id
string
Seu próprio identificador de página, usado no lugar da URL.
sso-token
string
Um token que seu servidor assinou para o leitor conectado. Veja Login único.