https://github.com/coreyward/react-portable-text
An easy way to render Portable Text block content in React applications.
https://github.com/coreyward/react-portable-text
block-content portable-text react reactjs sanity sanity-io serialization
Last synced: 26 days ago
JSON representation
An easy way to render Portable Text block content in React applications.
- Host: GitHub
- URL: https://github.com/coreyward/react-portable-text
- Owner: coreyward
- License: mit
- Created: 2021-02-20T01:30:24.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T00:37:48.000Z (about 2 months ago)
- Last Synced: 2025-03-28T09:04:36.016Z (about 1 month ago)
- Topics: block-content, portable-text, react, reactjs, sanity, sanity-io, serialization
- Language: JavaScript
- Homepage:
- Size: 214 KB
- Stars: 73
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Portable Text
[](https://www.npmjs.com/package/react-portable-text)
[](https://github.com/coreyward/react-portable-text/issues)
An easy way to render Portable Text block content in React applications.
Want to display images from Sanity in your Portable Text content? Check out
[sanity-image](https://github.com/coreyward/sanity-image). No extra fields
required in your GROQ query.
## Quick Example
```sh
yarn add react-portable-text
```
```jsx
import PortableText from "react-portable-text"
const YourComponent = ({ portableTextContent }) => (
,
li: ({ children }) => {children} ,
someCustomType: YourComponent,
}}
/>
)
```
## Why not just use @sanity/block-content-to-react directly?
I found it difficult to create abstractions on top of
[@sanity/block-content-to-react](https://github.com/sanity-io/block-content-to-react).
Remembering whether a serializer needed to be codified as a `type`, a `mark`, or
as something under `block` was challenging, and the special treatment for lists
and list items was confusing. Further, the props being wrapped in an object
under the `node` property, or extraneous props for `mark` types meant I was
creating intermediate component types just to avoid passing invalid props to the
React elements (otherwise they render in the DOM).
React Portable Text uses `@sanity/block-content-to-react` under the hood, but
maps each of these types to the correct place in the serializers for you and
normalizing props to match the fields supplied by users in your Sanity Studio,
simplifying the cognitive load required to author new ones.
## Serializer Documentation
React Portable Text maps the following types explicitly, and treats all other
properties of the `serializers` object as custom types. Custom types are used
for both `type` and `block` blocks (i.e. custom marks as well as custom
block-level insertion types).
| Serializer | Notes |
| ----------------- | ---------------------------------------------------------------------------------------- |
| **Marks** |
| `link` | All `link` marks used for anchor links |
| `strong` | Bold/strong text |
| `em` | Emphasized/italic text |
| `underline` | Underlined text |
| `del` | Text with strikethrough styles |
| `code` | Inline text with `code styling` |
| **Lists** |
| `ul` | Unordered lists |
| `ol` | Ordered lists |
| `li` | List items for any type of list |
| **Blocks** |
| `h1` | Heading level 1 |
| `h2` | Heading level 2 |
| `h3` | Heading level 3 |
| `h4` | Heading level 4 |
| `h5` | Heading level 5 |
| `h6` | Heading level 6 |
| `normal` | Paragraph styles |
| `blockquote` | Blockquote styles |
| **Special Types** | |
| `container` | Override the component wrapping the blocks |
| `block` | Override the default block serializer (not recommended) |
| `span` | Override the default span serializer (not recommended) |
| `hardBreak` | Serializer for newlines; defaults to `br`; pass `false` to preserve newlines |
| `unknownType` | Fallback for blocks of unknown type, if `ignoreUnknownTypes` is set to `false` (default) |
| `unknownMark` | Fallback for marks of unknown type; defaults to a plain `span` |
### Additional Props
Additional props are passed through to `@sanity/block-content-to-react`, so if
you want to configure `imageOptions` or set the `projectId` and `dataset`
options you can just pass them directly to React Portable Text:
```jsx
```
## Rendering Plain Text
As a bonus, `react-portable-text` offers a function that will render your
portable text content to a plaintext string. This is often useful for previews
and such in the Studio and for ancillary uses of content in contexts where
formatting is not supported (e.g. calendar invite descriptions, meta tags,
etc.).
```jsx
import { blockContentToPlainText } from "react-portable-text"
const MetaDescription = ({ content }) => (
)
```
## Contributing
Did I miss something? Is something not compatible with your setup?
[Open an issue](https://github.com/coreyward/react-portable-text/issues/new)
with details, and if possible, a CodeSandbox reproduction. Pull requests are
also welcomed!
## License
Copyright ©2022 Corey Ward. Available under the
[MIT License](https://github.com/coreyward/react-portable-text/blob/master/LICENSE).