Configuration

The embedded Muut forums and comment sections can be further tweaked in many aspects. Each aspect corresponds to a key with a default value unless you explicitly override it in one of the following ways:

HTML attributes

Embedding options are passed to the Muut element as data- attributes, except the title option, which simply makes use of the native title attribute. For example:

<a class="muut"
  href="https://muut.com/i/community-name/comments/classical-music:bach-vs-telemann"
  title="Comments on Bach vs. Telemann"
  data-channel="Classical Music Blog"
  data-show_online="false"
  data-upload="false">
  Comments
</a>

The title attribute sets a custom title for the commenting thread, displayed when it is listed along with other threads in your forum. The data-show_online attribute determines whether the list of online users is shown on top of the comments. The data-upload attribute determines whether image uploading is enabled or disabled for users.

JavaScript

The Muut application targets <a> or <div> elements with class name "muut" for automatic installation. If you prefer installing a forum or a comment section on an arbitrary element, or initializing the client separately with different configuration options, Muut provides a JavaScript-based solution using jQuery syntax. For example, to install a Muut comment section directly on <div id="muut-custom"></div>, insert a <script/> block after the target element as follows:

<script>
  var conf = {
     url: "https://muut.com/i/community-name/comments/classical-music:bach-vs-telemann",
     title: "Comments on Bach vs. Telemann",
     channel: "Classical Music Blog",
     show_online: false,
     upload: false
  };

  $("#muut-custom").muut(conf);
</script>

Note that url is the JavaScript equivalent of href, and is mandatory. In case you don't need other tweaking options, you may just pass the url value using the shortcut script as follows:

$("#muut-custom").muut("https://muut.com/i/community-name/comments/classical-music:bach-vs-telemann");

Reference

  • channel
  • string
  • commenting only

Specifies a custom title for the channel that contains the thread. By default this is taken from the path.

  • page_url
  • string
  • iframe embedding only

Specifies the URL of the page where Muut forum or comment section is viewed, excluding location.hash (the portion starting with #). This attribute is necessary in the scenarios where Muut must be embedded inside an iframe (as seen in certain website builders like Wix and Google Sites). Without providing this parameter, Muut can only reach the URL of the iframe instead of the main page that people actually visit, resulting in wrong links in notification emails and social media sharing.

  • share
  • true

Specifies whether sharing buttons (twitter, facebook…) are shown on the client.

  • show_online
  • true

Specifies whether the list of online users is shown.

  • show_title
  • true
  • threaded commenting only
  • Specifies whether individual thread titles are shown in a multi-thread comment section. When set to false, the title field will be unavailable upon creating new threads. In addition, threads are never collapsed.

    • title
    • string
    • flat commenting only

    Specifies a custom title for the single thread when used for flat commenting. The title is displayed in your forum only, not on the commenting pages. By default this is taken from document.title. Do not use the data- prefix when passed as an HTML attribute.

    • upload
    • true

    Specifies whether image uploading is enabled for users.

    • widget
    • false

    Specifies whether the embedded Muut is in “Widget” mode. When set to true, the embedded Muut will not change the global properties of the page including document.title and location.hash.

    • api
    • object

    Contains the API key, message, signature and timestamp of a signed embed.

    • login_url
    • string

    In a Federated Identities setup, this is used to determine where users are sent to login from the embed.

    • autowatch
    • false

    False configuration property displays a “Watch for new replies”- checkbox when replying or creating new topics. By default this is true and threads are automatically followed. On both cases users have the option to click the eye icon to follow/unfollow threads.

    • autowatch_checked
    • false

    False configuration property forces the autowatch checkbox to be unchecked by default.

    • sso
    • true

    Let's the system know you're using Federated ID. Be sure to do the rest of the work! See our page on FedID