1.0.3 • Published 2 years ago

hyvor-talk-react-typescript v1.0.3

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

npm npm

Hyvor Talk - React (TypeScript)

Same as https://github.com/HyvorTalk/hyvor-talk-react but rewritten in TypeScript and updated dependencies

Install

npm i hyvor-talk-react-typescript

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 from 'react';

import { Embed, CommentCount } from 'hyvor-talk-react-typescript';

const Article: React.FC = () => {
  return (
    <div>
      <h1>Article Title</h1>

      <div className="comment-count-view">
        {/* Comment Counts */}
        <CommentCount websiteId={YOUR_WEBSITE_ID} id={WEBPAGE_IDENTIFIER} />
      </div>

      <content>Your Article Here</content>

      {/* Load Comments now */}
      <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.

License

MIT © HyvorTalk

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago