National Poetry Month

    fastcomments-vue
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.1 • Public • Published

    fastcomments-vue

    A Vue library for FastComments, a fast and developer friendly comment system.

    NPM JavaScript Style Guide

    For Vue 3.0, see fastcomments-vue-next.

    Installation

    NPM

    npm install --save fastcomments-vue

    Yarn

    yarn add fastcomments-vue

    Usage

    The Comment Widget

    The FastCommentsVue component contains the live FastComments comment widget.

    Replace "demo" below with your "tenantId" - available here in the FastComments admin area.

    The widget supports a lot of options - see FastCommentsConfig here.

    <script lang="ts">
    import Vue from 'vue';
    import FastCommentsVue from 'fastcomments-vue';
    
    export default Vue.extend({
      name: 'ServeDev',
      components: {
        FastCommentsVue
      }
    });
    </script>
    
    <template>
      <div id="app">
        <fast-comments-vue v-bind:config="{tenantId: 'demo'}" />
      </div>
    </template>

    Updating The Current Page (SPA Example)

    In FastComments we call the article id, or page the comments get tied to, the URL ID as it can be a url or an ID. Define the URL ID in the following manner. The component watches for changes in config object, and will reload, so you can just update the "url" and "urlId" settings.

    See a full working example here.

    Run the pagination example via:

    npm run serve-pagination
    
    <fast-comments-vue v-bind:config="{tenantId: 'demo', url: 'https://example.com', urlId: 'some-page-id'}" />

    Account Region (ATTENTION: EU Customers)

    If your account is located in the EU, set region = 'eu' in the widget configuration, for example:

    <fast-comments-vue v-bind:config="{tenantId: 'demo', url: 'https://example.com', urlId: 'some-page-id', region: 'eu'}" />

    Otherwise, you do not have to define region.

    Contributing

    Please check out our contribution guidelines before starting on a change. Remember to communicate first!

    License

    MIT © winrid

    Keywords

    none

    Install

    npm i fastcomments-vue

    DownloadsWeekly Downloads

    13

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    57.4 kB

    Total Files

    11

    Last publish

    Collaborators

    • winrid-org