GithubHelp home page GithubHelp logo

Comments (2)

58bits avatar 58bits commented on September 26, 2024 2

In case anyone else finds this helpful - here's how I did this in the end.... creating a url-safe kebab-case ID for the heading element and anchor ref using slugify and a helper function to extract the text from the heading element.

import * as React from 'react'
import { PortableText } from '@portabletext/react'
import slugify from 'slugify'

const getTextFromChildren = (children: React.ReactNode) => {
  let text = ''
  React.Children.map(children, child => {
    if (typeof child === 'string') {
      text += child
    }
  })
  return text
}

type HeadingWithAnchorProps = {
  heading: string
  children: React.ReactNode
}

function HeadingWithAnchor({ heading, children }: HeadingWithAnchorProps) {
  const text = getTextFromChildren(children)
  const headingId = slugify(text, { lower: true })
  const Element = heading as keyof JSX.IntrinsicElements
  return (
    <Element id={headingId}>
      <a href={`#${headingId}`} aria-hidden="true" tabIndex={-1}>
        #
      </a>
      <span>{children}</span>
    </Element>
  )
}

const components: PortableTextComponents = {
  block: {
    h2: ({ children }) => {
      return <HeadingWithAnchor heading="h2">{children}</HeadingWithAnchor>
    },
    h3: ({ children }) => {
      return <HeadingWithAnchor heading="h3">{children}</HeadingWithAnchor>
    },
    h4: ({ children }) => {
      return <HeadingWithAnchor heading="h4">{children}</HeadingWithAnchor>
    },
  }
}

from react-portabletext.

58bits avatar 58bits commented on September 26, 2024

Ah okay I've just ready the migration docs here...

https://github.com/portabletext/react-portabletext/blob/main/MIGRATING.md

and so...

 const { node, children } = props
 const { style, _key } = node

becomes...

 const { value, children } = props
 const { style, _key } = value

What about the return defaultSerializers? (or the 'components') equivalent?

from react-portabletext.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.