Skip to content

portabletext/solid-portabletext

Repository files navigation

@portabletext/solid

npm versionnpm bundle size

Render Portable Text with Solid JS.

Table of contents

Installation

npm install --save @portabletext/solid

Basic usage

import { PortableText, type PortableTextComponents } from '@portabletext/solid'
import type { PortableTextBlock } from '@portabletext/types'
import type { Component } from 'solid-js'

const blocks: PortableTextBlock[] = [
  /* array of portable text blocks */
]

const components: PortableTextComponents = {
  /* optional object of custom components to use */
}

const App: Component = () => {
  return <PortableText value={blocks} components={components} />
}

Credits

This repository is based on solid-portabletext, shoutout to @nonphoto for the original work 💖

License

MIT