@readsonic/nextjs
TypeScript icon, indicating that this package has built-in type declarations

1.4.2 • Public • Published

Official ReadSonic Next.js Component

Official Next.js component for ReadSonic.

Installation

NPM

npm install @readsonic/nextjs

Yarn

yarn add @readsonic/nextjs

PNPM

pnpm add @readsonic/nextjs

Usage

Add the <ReadSonic /> component to your page. The component should be placed in the component that wraps all of your blog posts.

For example, if you have a app/blog/[slug].tsx page that renders all of your blog posts, you should add the <ReadSonic /> component to that page, or to a component that is rendered by that page.

import ReadSonic from '@readsonic/nextjs';

export default function Post() {
  return (
    <div>
      <ReadSonic />  <-- Add this component
      <h1>Post Title</h1>
      <article>
        <p>Post content</p>
        <p>...</p>
      </article>
    </div>
  );
}

IMPORTANT: ReadSonic currently reads everything that is between the <article> and </article> tags on your page, but nothing else. Use these tags on your blog posts to ensure that ReadSonic reads the correct content.

Props

By default, <ReadSonic /> will render a play button wherever it is placed on the page. You can customize the component with the className prop.

<ReadSonic className="my-custom-class" />

Package Sidebar

Install

npm i @readsonic/nextjs

Weekly Downloads

0

Version

1.4.2

License

MIT

Unpacked Size

12.1 kB

Total Files

14

Last publish

Collaborators

  • richardkovacs