Git Product home page Git Product logo

hyvor-talk-react's Introduction

Hyvor Talk - React

Add Hyvor Talk to React Apps

NPM JavaScript Style Guide

Install

npm install hyvor-talk-react

Library

This library includes two Components.

  1. Embed - To load Hyvor Talk embed
  2. CommentCount - To load comment counts for listing pages

Example

import React, { Component } from 'react'

import HyvorTalk from 'hyvor-talk-react'

class Article extends Component {
  render () {
    return (
      <div>
        <h1>Article Title</h1>

        <div className="comment-count-view">

          { /* Comment Counts */ }
          <HyvorTalk.CommentCount 
            websiteId={YOUR_WEBSITE_ID}
            id={WEBPAGE_IDENTIFIER} 
          />

        </div>
        
        <content>Your Article Here</content>

        { /* Load Comments now */ }
        <HyvorTalk.Embed 
          websiteId={YOUR_WEBSITE_ID}
          id={WEBPAGE_IDENTIFIER}
        />
      </div>
    )
  }
}

HyvorTalk.Embed Component

This component loads the comments iframe into your website and supports the following attributes.

  • websiteId - (int) (required) ID of your website. This ID is given to you when you register your website on Hyvor Talk. Visit console find it or create new one.
  • id - (any) (optional) This is used to identify each web pages uniquely by Hyvor Talk. If you don't set it, the canonical URL will be used as the ID. If canonical URLs are not set URL of the page will be used without query params.
  • url - (string) (optional) You can explicitly set the URL of the page.
  • loadMode - (string) (optional) Load Hyvor Talk on load, click, or scroll
  • palette - (object) (optional) A palette object to set colors dynamically.
  • sso - (object) (optional) Single sign-on object. See the documentation for more details. Note that to use SSO with React, you'll need to fetch the SSO details from the backend and render the component after that.

HyvorTalk.CommentCount

This component can be used to display comment counts on a listing page or a blog page itself.

Attributes:

  • websiteId
  • id - ID of the webpage (should be the same used to load comments)
  • mode - (string) (optional) Use mode="number" to display only the number of comments.

Here's a simple live demo

License

MIT © HyvorTalk

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.