fastcomments-vue-next

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

Live Demo

Try every widget live at https://fastcomments.com/commenting-system-for-vue.

Live Showcase

To see every widget and flow running locally against the public demo tenant, clone the repo and run:

npm install
npm run dev

The showcase entry point lives in src/App.vue and index.html — each widget/flow is rendered in the same app you can copy into your own Vue 3 project.

Installation

NPM

npm install --save fastcomments-vue-next

Yarn

yarn add fastcomments-vue-next

Usage

The Comment Widget

The FastCommentsVueNext 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.

<template>
  <FastComments v-bind:config="{tenantId: 'demo'}" />
</template>
<script>
import { FastComments } from 'fastcomments-vue-next'
export default {
  name: 'FastCommentsExample',
  components: {
    FastComments
  }
}
</script>

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 update the URL ID.

<FastComments v-bind:config="{tenantId: 'demo', url: 'https://example.com/somepage', 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:

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

Otherwise, you do not have to define region.

In Production

You probably don't want to define the config inline if you're passing callbacks etc. Instead, you'll want to define the config via computed(), otherwise each time your callback etc is invoked the entire widget will re-render.

All Widgets and Documentation

Run the local documentation:

npm run serve

Contributing

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

License

MIT © winrid

Maintenance Status

These components are wrappers around our core VanillaJS components. We can automatically update these components (fix bugs, add features) without publishing this library, so while it may not be published for a while that does not mean FastComments is not under active development! Feel free to check our blog for updates. Breaking API changes or features will never be shipped to the underlying core library without a version bump in this library.