JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 3
  • Score
    100M100P100Q48416F
  • License MIT

React HOC for Utterance comment widget

Package Exports

  • with-utterances

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (with-utterances) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React ❤️ Utterances

WithUtterances is a React Higher-Order-Component for Super LightWeight Comments Widget named Utterances.

No need Duplicated DOM Bindings for each react component.

Just Wrap It!

  1. import withUtterances from 'with-utterances'
  2. Wrap your react component
  3. Pass your repo as a String
  4. Done!

Installation

npm i with-utterances
yarn add with-utterances

Usage

import withUtterances to the file which has component that you want to show utterances comment widget.

import withUtterances from 'with-utterances'


class PostPage extends React.Component {
    //...
}

// Or

const PostPage = () => {
    //...
}

export default withUtterances(PostPage, 'YOUR_REPO')

// Or to specify a theme

export default withUtterances(PostPage, 'YOUR_REPO', 'github-dark')

// Or to specfiy an issue term

export default withUtterances(PostPage, 'YOUR_REPO', 'github-light', 'og:title')


// Or to specfiy label for newly created issues
export default withUtterances(PostPage, 'YOUR_REPO', 'github-light', 'og:title', 'comments')

It uses your pathname as issue-term.

Supported Themes

By default Utterances comes with 6 choices for themes:

  • github-light - The normal Github style
  • github-dark - A dark mode in the style of Github
  • github-dark-orange - A custom dark orange mode in the style of Github
  • icy-dark - A custom blue glow theme
  • dark-blue - A custom blue and black theme
  • photon-dark - A custom dark grey and blue theme

More themes can be added with additional stylesheets.

Supported Issue Terms

  • pathname - Issue title which contains the path of the current page.
  • url - Issue title which contains the URL of the current page.
  • title - Issue title which contains the tab title of the current page.
  • og:title - Issue title which contains the Open Graph title meta.
  • <serach term> - Issue title which contains the given String.

PS. preload and prefetch Applied

It will make your Utterances Widget to load slightly faster. <3

PS. DEMO SITE

Demo Using withUtterance