Files
talk/docs/source/version-5-counts.md
T
Wyatt Johnson ca10062498 [CORL-646] Docs update (#2648)
* docs: added docs for trust proxy

* fix: adjusted incorrect HTML

- fixes #2656
2019-10-22 17:01:48 +00:00

1.7 KiB
Raw Blame History

title, permalink
title permalink
Comment Count Integration /v5/integrating/counts/

Add the count.js script to your html tree. On a page that includes the Stream Embed this is done for you automatically, however for best performance we recommend to include it into the <head> tag.

<script src="//{{ CORAL_DOMAIN_NAME }}/assets/js/count.js" defer></script>

NOTE: Replace the value of {% raw %}{{ CORAL_DOMAIN_NAME }}{% endraw %} with the location of your running instance of Coral.

Insert an html element with the class coral-count and configure it using data-coral-* attributes.

<span class="coral-count" data-coral-url="http://example.com/blog-entry-1/"></span>

After successful injection it will become:

<span class="coral-count" data-coral-url="http://example.com/blog-entry-1/">
   <span class="coral-count-number">5</span>
  <span class="coral-count-text">Comments</span>
</span>

Available data-coral-* attributes

Set the class of your html element to coral-count in order to get story counts. The following data-coral-* attributes will configure the output:

  • data-coral-id The id of the story of which counts should be injected.
  • data-coral-url The url of the story of which counts should be injected.
  • data-coral-notext If set to "true", only the count number will be injected

Either data-coral-id or data-coral-url should be set. If none are provided the story url will be retrieved from the canonical url reference <link rel="canonical" href="..."> or inferred using the current page url.