Unverified Commit 3861e4b8 authored by David Fateh's avatar David Fateh Committed by GitHub

Adding Asset Component for Rich Text Renderer (#32503)



This PR accomplishes 2 things:

1. You can now add images to the rich text post of the example and see those images show up in the app. This is a good jumping off point for people who are learning how to customize the rich text renderers by adding custom components to the mapper.
2. Updating the README pictures to have a more up-to-date UI in the screenshots.

## Feature
- [x] Documentation added

## Documentation / Examples

- [x] Make sure the linting passes by running `yarn lint`
parent e5e04c90
...@@ -139,7 +139,7 @@ After setting up the content model (either manually or by running `npm run setup ...@@ -139,7 +139,7 @@ After setting up the content model (either manually or by running `npm run setup
**Content model overview** **Content model overview**
![Content model overview](./docs/content-model-overview.jpg) ![Content model overview](./docs/content-model-overview.png)
### Step 4. Populate Content ### Step 4. Populate Content
...@@ -158,7 +158,7 @@ Next, create another entry with the content type **Post**: ...@@ -158,7 +158,7 @@ Next, create another entry with the content type **Post**:
**Important:** For each entry and asset, you need to click on **Publish**. If not, the entry will be in draft state. **Important:** For each entry and asset, you need to click on **Publish**. If not, the entry will be in draft state.
![Published content entry](./docs/content-entry-publish.jpg) ![Published content entry](./docs/content-entry-publish.png)
### Step 5. Set up environment variables ### Step 5. Set up environment variables
...@@ -212,7 +212,7 @@ http://localhost:3000/api/preview?secret=<CONTENTFUL_PREVIEW_SECRET>&slug={entry ...@@ -212,7 +212,7 @@ http://localhost:3000/api/preview?secret=<CONTENTFUL_PREVIEW_SECRET>&slug={entry
Replace `<CONTENTFUL_PREVIEW_SECRET>` with its respective value in `.env.local`. Replace `<CONTENTFUL_PREVIEW_SECRET>` with its respective value in `.env.local`.
![Content preview setup](./docs/content-preview-setup.jpg) ![Content preview setup](./docs/content-preview-setup.png)
Once saved, go to one of the posts you've created and: Once saved, go to one of the posts you've created and:
...@@ -220,7 +220,7 @@ Once saved, go to one of the posts you've created and: ...@@ -220,7 +220,7 @@ Once saved, go to one of the posts you've created and:
- The state of the post will switch to **CHANGED** automatically. **Do not** publish it. By doing this, the post will be in draft state. - The state of the post will switch to **CHANGED** automatically. **Do not** publish it. By doing this, the post will be in draft state.
- In the sidebar, you will see the **Open preview** button. Click on it! - In the sidebar, you will see the **Open preview** button. Click on it!
![Content entry overview](./docs/content-entry-preview.jpg) ![Content entry overview](./docs/content-entry-preview.png)
You will now be able to see the updated title. To exit preview mode, you can click on **Click here to exit preview mode** at the top of the page. You will now be able to see the updated title. To exit preview mode, you can click on **Click here to exit preview mode** at the top of the page.
......
import { documentToReactComponents } from '@contentful/rich-text-react-renderer' import { documentToReactComponents } from '@contentful/rich-text-react-renderer'
import { BLOCKS } from '@contentful/rich-text-types'
import markdownStyles from './markdown-styles.module.css' import markdownStyles from './markdown-styles.module.css'
import RichTextAsset from './rich-text-asset'
const customMarkdownOptions = (content) => ({
renderNode: {
[BLOCKS.EMBEDDED_ASSET]: (node) => (
<RichTextAsset
id={node.data.target.sys.id}
assets={content.links.assets.block}
/>
),
},
})
export default function PostBody({ content }) { export default function PostBody({ content }) {
return ( return (
<div className="max-w-2xl mx-auto"> <div className="max-w-2xl mx-auto">
<div className={markdownStyles['markdown']}> <div className={markdownStyles['markdown']}>
{documentToReactComponents(content.json)} {documentToReactComponents(
content.json,
customMarkdownOptions(content)
)}
</div> </div>
</div> </div>
) )
......
import Image from 'next/image'
export default function RichTextAsset({ id, assets }) {
const asset = assets?.find((asset) => asset.sys.id === id)
if (asset?.url) {
return <Image src={asset.url} layout="fill" alt={asset.description} />
}
return null
}
...@@ -14,6 +14,17 @@ author { ...@@ -14,6 +14,17 @@ author {
excerpt excerpt
content { content {
json json
links {
assets {
block {
sys {
id
}
url
description
}
}
}
} }
` `
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
"dependencies": { "dependencies": {
"@contentful/rich-text-react-renderer": "^15.4.0", "@contentful/rich-text-react-renderer": "^15.4.0",
"classnames": "2.3.1", "classnames": "2.3.1",
"date-fns": "2.22.1", "date-fns": "2.28.0",
"next": "latest", "next": "latest",
"react": "^17.0.2", "react": "^17.0.2",
"react-dom": "^17.0.2" "react-dom": "^17.0.2"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment