# @hyvor/hyvor-talk-react

> Hyvor Talk React Component

Latest version **1.0.2** (published 2025-02-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @hyvor/hyvor-talk-react
pnpm add @hyvor/hyvor-talk-react
yarn add @hyvor/hyvor-talk-react
bun add @hyvor/hyvor-talk-react
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2025-02-11 |
| First published | 2023-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 27.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | supunkavinda |

## Links

- npm: https://www.npmjs.com/package/@hyvor/hyvor-talk-react
- Repository: https://github.com/hyvor/hyvor-talk-libraries
- Homepage: https://github.com/hyvor/hyvor-talk-libraries#readme
- Issues: https://github.com/hyvor/hyvor-talk-libraries/issues
- npm.io page: https://npm.io/package/@hyvor/hyvor-talk-react

## Dependencies (1)

- [@hyvor/hyvor-talk-base](https://npm.io/package/@hyvor/hyvor-talk-base.md) ^1.0.1

## Recent versions

- 1.0.2 (latest) — 2025-02-11
- 1.0.0-beta.3 (beta) — 2024-09-03
- 1.0.1 — 2024-09-09
- 1.0.0 — 2024-09-04
- 1.0.0-beta.2 — 2024-09-03
- 1.0.0-beta.1 — 2024-09-03
- 0.0.3-patch.3 — 2024-08-02
- 0.0.3-patch.2 — 2024-08-02
- 0.0.3-patch.1 — 2024-08-02
- 0.0.3 — 2024-03-20
- 0.0.2 — 2023-07-16
- 0.0.1-beta.7 — 2023-05-02
- 0.0.1-beta.6 — 2023-05-02
- 0.0.1-beta.5 — 2023-05-02
- 0.0.1-beta.4 — 2023-05-02
- … 3 more at https://npm.io/package/@hyvor/hyvor-talk-react/versions

## README

### Installation

```bash
npm install @hyvor/hyvor-talk-react
```

### Usage

The following components are available:

-   **`<Comments>`** - wraps [`<hyvor-talk-comments>`](https://talk.hyvor.com/docs/comments)
-   **`<CommentCount>`** - wraps [`<hyvor-talk-comment-count>`](https://talk.hyvor.com/docs/comment-counts)
-   **`<NewsletterForm>`** - wraps [`<hyvor-talk-newsletter>`](https://talk.hyvor.com/docs/newsletters)
-   **`<Memberships>`** - wraps [`<hyvor-talk-memberships>`](https://talk.hyvor.com/docs/memberships)
-   **`<GatedContent>`** - wraps [`<hyvor-talk-gated-content>`](https://talk.hyvor.com/docs/gated-content)

### Comments

Use the `<Comments>` component to add comments to your webpage. The props are the same as the attributes of [hyvor-talk-comments](https://talk.hyvor.com/docs/comments#attributes).

```jsx
import React from "react";
import { Comments } from "@hyvor/hyvor-talk-react";

const App = () => {
    return <Comments website-id={YOUR_WEBSITE_ID} page-id={UNIQUE_PAGE_ID} />;
};
```

### Comment Counts

Use the `<CommentCount>` component to display the number of comments on a page.
All props are the same as the base [hyvor-talk-comment-count](https://talk.hyvor.com/docs/comment-counts) Web Component.

First, add the `<CommentCount>` components to your app. Then, call `CommentCounts.load()` in `onMount` to load the comment counts.

```jsx
import React from "react";
import { CommentCount } from "@hyvor/hyvor-talk-react";
import { CommentCounts } from "@hyvor/hyvor-talk-base";

const App = () => {
    useEffect(() => {
        CommentCounts.load({
            "website-id": YOUR_WEBSITE_ID,
        });
    }, []);

    return (
        <div>
            <CommentCount page-id={PAGE_ID_1} />
            <CommentCount page-id={PAGE_ID_2} />
        </div>
    );
};
```

### Newsletter Form

Use the `<NewsletterForm>` component to add a newsletter form to your webpage. The props are the same as the attributes of [hyvor-talk-newsletter](https://talk.hyvor.com/docs/newsletters#form-properties).

```tsx
import React from "react";
import { NewsletterForm } from "@hyvor/hyvor-talk-react";

const App = () => {
    return <NewsletterForm website-id={YOUR_WEBSITE_ID} />;
};
```

### Memberships & Gated Content

Use the `<Memberships>` component to add memberships to your webpage. The props are the same as the attributes of [hyvor-talk-memberships](https://talk.hyvor.com/docs/memberships#component-attributes).

```tsx
import React from "react";
import { Memberships } from "@hyvor/hyvor-talk-react";

const App = () => {
    return <Memberships website-id={YOUR_WEBSITE_ID} />;
};
```

Once you have memberships set up, you can use the `<GatedContent>` component to show content only to members. The props are the same as the attributes of [hyvor-talk-gated-content](https://talk.hyvor.com/docs/gated-content#component-attributes). The `key` prop is renamed to `_key` to avoid conflicts with the reserved `key` prop in React.

```tsx
import React from "react";
import { GatedContent } from "@hyvor/hyvor-talk-react";

const App = () => {
    return <GatedContent _key="my-content" />;
};
```

---

### Listening to Events

You can listen to [events](https://talk.hyvor.com/docs/comments#events) emitted by the components using the `on` prop. This is supported by all components that have events.

```jsx
import React from "react";

const App = () => {
    return (
        <Comments
            website-id={YOUR_WEBSITE_ID}
            on={{
                loaded: () => console.log("Comments loaded"),
                "comment:published": (comment) =>
                    console.log("Comment published", comment),
            }}
        />
    );
};
```

### Accessing the Web Component Instance

You can access the underlying Web Component instance using the `ref` prop, which returns an object with two methods: `wrap` and `element`. This is supported by all components.

```jsx
import React, { useRef, useEffect } from "react";
import { type CommentsCustomElement } from "@hyvor/hyvor-talk-base";

const App = () => {
    const commentsRef = useRef < {
        wrap: () => HTMLDivElement;
        element: () => CommentsCustomElement;
    } | null > (null);

    useEffect(() => {
        if (commentsRef.current) {

            // This is the wrapping <div> element
            const wrap = commentsRef.current.wrap();

            // This is the underlying <hyvor-talk-comments> element
            const element = commentsRef.current.element();

            // Listen to events
            element.addEventListener('loaded', () => {
                // Call API methods
                console.log(element.api.page());
            });

        }
    }, []);

    return (
        <Comments
            ref={commentsRef}
            website-id={YOUR_WEBSITE_ID}
        />
    );
};
```

---
_Source: https://npm.io/package/@hyvor/hyvor-talk-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
