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

    2.3.1 • Public • Published

    fastcomments-react

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

    NPM JavaScript Style Guide

    Installation

    NPM

    npm install --save fastcomments-react

    Yarn

    yarn add fastcomments-react

    Examples

    You'll find examples for various use cases (dark mode, pagination, etc) in the examples folder. Each example can be setup with npm install and started with npm run start.

    Usage

    The Main Widget Component

    The FastCommentsCommentWidget 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 FastCommentsCommentWidgetConfig in src/index.tsx.

    import React, { Component } from 'react'
    
    import {FastCommentsCommentWidget} from 'fastcomments-react'
    
    class Example extends Component {
      render() {
        return <FastCommentsCommentWidget tenantId="demo" />
      }
    }

    Updating The Current Page (For SPAs)

    To update the page/article the comment thread is tied to you must update the configuration parameters "urlId" and "url". See the example and explanation here.

    Account Region (ATTENTION: EU Customers)

    If you're in the EU, you'll want to tell the client widgets what region you are in. See examples/example-eu; Otherwise, you do not have to define region.

    The Comment Count Widget

    The FastCommentsCommentCountWidget component contains the live FastComments comment count widget.

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

    See FastCommentsCommentCountConfig in src/index.tsx for the supported configuration options.

    import React, { Component } from 'react'
    
    import {FastCommentsCommentCountWidget} from 'fastcomments-react'
    
    class Example extends Component {
      render() {
        return <FastCommentsCommentCountWidget tenantId="demo" urlId="https://example.com/some-page-or-id" />
      }
    }

    Native

    For React Native, see fastcomments-react-native.

    Contributing

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

    License

    MIT © winrid

    Keywords

    none

    Install

    npm i fastcomments-react

    DownloadsWeekly Downloads

    520

    Version

    2.3.1

    License

    MIT

    Unpacked Size

    230 kB

    Total Files

    15

    Last publish

    Collaborators

    • winrid-org