notion-blocks-chakra-ui
TypeScript icon, indicating that this package has built-in type declarations

0.0.15 • Public • Published

Parse Notion blocks into Chakra UI React components

Get started

npm install notion-blocks-chakra-ui

or

yarn add notion-blocks-chakra-ui

How to use

import { Stack } from '@chakra-ui/react';
import { NotionBlock } from 'notion-blocks-chakra-ui';

// fetch `blocks` from a Notion API call
<Stack>
  {blocks.map((block) => (
    <NotionBlock key={block.id} block={block} />
  ))}
</Stack>;

Images and video (unsupported by Notion API)

In order to parse images and video, because it is natively unsupported by Notion API, you need to add this kind of block in your Notion doc:

[image, <imageUrl>]
[video, <video>]
[youtube, <youtubeId>]

Custom image component

<NotionBlock
  block={block}
  customImage={{
    MyCustomComponent,
    props: {
      className: 'image',
    },
  }}
/>

Inspired by samuelkraft/notion-blog-nextjs

Here is my portofolio source code which uses this library

Readme

Keywords

none

Package Sidebar

Install

npm i notion-blocks-chakra-ui

Weekly Downloads

1

Version

0.0.15

License

MIT

Unpacked Size

65.8 kB

Total Files

43

Last publish

Collaborators

  • baptistearnaud