ngx-fastcomments

This is an Angular library for FastComments, a live embedded commenting library.

Installation

You will need fastcomments-typescript, which is a peer dependency. Please ensure this is included in your TypeScript compilation. In the future, this peer dependency will be moved to @types/fastcomments which will simplify this installation.

npm install fastcomments-typescript --save
npm install ngx-fastcomments --save

The peer dependency can be added in your tsconfig.json file, for example:

"include": [
  "src/**/*.ts",
  "node_modules/fastcomments-typescript/src/index.ts"
],

Then, add the FastCommentsModule to your application:

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';
import { FastCommentsModule } from 'ngx-fastcomments';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    FastCommentsModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Usage

To get started, we pass a config object for the demo tenant:

<lib-fastcomments [config]="{ tenantId: 'demo' }"></lib-fastcomments>

Replace this with your own tenant ID, like so:

<lib-fastcomments [config]="{ tenantId: 'abc123' }"></lib-fastcomments>

Since the configuration can get quite complicated, we can pass in an object reference:

<lib-fastcomments [config]="fastcommentsConfig"></lib-fastcomments>

The widget uses change detection, so changing any properties of the configuration object will cause it to be reloaded.

This allows support for things like toggling dark mode, or pagination, simply by changing the configuration.

All configuration in our docs is supported. You can find the TypeScript definitions for the configuration on GitHub.