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

    1.1.2 • Public • Published

    disqus-react

    npm version

    A package for integrating Disqus services into React applications.

    Installation

    Using npm:

    $ npm install --save disqus-react

    Using yarn:

    $ yarn add disqus-react

    Usage

    DiscussionEmbed

    This is the component that will load the main Disqus comments section.

    import { DiscussionEmbed } from 'disqus-react';
    
    <DiscussionEmbed
        shortname='example'
        config={
            {
                url: this.props.article.url,
                identifier: this.props.article.id,
                title: this.props.article.title,
                language: 'zh_TW' //e.g. for Traditional Chinese (Taiwan)	
            }
        }
    />

    This component is limited to one instance in the DOM at a time and will handle updates to both the config and shortname props and reload appropriately with the new discussion thread.

    CommentCount

    This component will display the comment count for the Disqus thread associated with the provided config.

    import { CommentCount } from 'disqus-react';
    
    <CommentCount
        shortname='example'
        config={
            {
                url: this.props.article.url,
                identifier: this.props.article.id,
                title: this.props.article.title,
            }
        }
    >
        {/* Placeholder Text */}
        Comments
    </CommentCount>

    Multiple instances of this component can be included on the same page with different config variables (e.g. an article list showing the comment count for each). However, all threads on the site must be under the same primary site shortname. If the component receives a new shortname, all instances will be reset with counts for threads matching the updated site.

    CommentEmbed

    This component can be used to embed a Disqus comment into your page.

    import { CommentEmbed } from 'disqus-react';
    
    <CommentEmbed
        commentId={this.props.article.featuredCommentId}
        showMedia={true}
        showParentComment={true}
        width={420}
        height={320}
    />

    Multiple instances of this component may be include on the same page with different commentId variables and does not require that the embedded comment be under the same primary site shortname.

    Recommendations

    This component can be used to embed Disqus Recommendations into your page.

    import { Recommendations } from 'disqus-react';
    
    <Recommendations 
        shortname='example'
        config={
            {
                url: this.props.article.url,
                identifier: this.props.article.id,
                title: this.props.article.title,
            }
        }
    />

    The config prop is optional and is used to prevent any discussions on the current page from being included in the recommendations. This component is limited to one instance in the DOM at a time and will handle updates to the shortname prop and reload appropriately with recommended pages for the new forum shortname.

    Contributing

    If you'd like to contribute to this package feel free to submit a bug report, feature request, or pull request. Though we would ask that you first read through the contributing guidelines.

    Keywords

    none

    Install

    npm i disqus-react

    DownloadsWeekly Downloads

    12,131

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    127 kB

    Total Files

    15

    Last publish

    Collaborators

    • ryanvalentin
    • disqus-oss
    • byk
    • tail
    • tterb