Rich text

Intro

Enonic boasts a rich text input type. Unlike basic text fields, rich-text may contain more complex concepts such as tables, images, links and custom components. Each of these will typically need to be processed during rendering in order to provide a contextually correct URL, ideal image sizes etc.

Sample content

Luckily, the sample data set contains everything we need to get going. The Bio field for persons is rich text, and some content is even populated with relevant content, like you see below:

Figure 1. Rich text bio field for Lea Seydoux

Rich text rendering

Update the Person processor

/src/main/resources/react4xp/components/content/PersonProcessor.ts

import {processHtml} from '/lib/enonic/react4xp';

...


export const personProcessor: ComponentProcessorFunction<PageDescriptor>
    = (params) => {
...

    return {
        displayName: `${params.content.displayName}`,
        photo: {
            _id,
            title: displayName,
            imageUrl: imageUrl({id: _id, scale: 'block(1200, 675)'})
        },
        birthDate: params.content.data.dateofbirth,
        restPhotos: extraPhotos,
        bio: `${params.content.data.bio}`,
        bioHtml: processHtml({
            value: params.content.data.bio as string,
            imageWidths: [200, 400, 800],
        })
    };
};

ProcessHtml is a function to prepare data for the RichText component that already comes with react4xp.

add it to your component

/src/main/resources/react4xp/components/content/Person.tsx

import {componentRegistry} from '/react4xp/componentRegistry';
import {RichText} from '@enonic/react-components';

...

export const Person = (props) => {
    const {displayName, photo, restPhotos, bioHtml, birthDate} = props as any;

...

</div>
    {
        bioHtml && (
            <>
                <h2>Bio</h2>
                <div className={styles.richText}>
                    <RichText
                        data={bioHtml}
                        componentRegistry={componentRegistry}
                        loading="lazy"
                    />
                </div>
            </>
        )
    }
</div>
)
}

Et voilà!

And just like that we have a fully functional rich text renderer.

The page should look something like this:

Figure 2. Person content rendered with rich text

If you have a sharp eye, you might notice there is something missing, we need to add a macro component to render factbox!

Macro component

Adding the Fact-Box is easy, we just need to add a new component that will be used to render the macro:

Component

/src/main/resources/react4xp/components/macro/FactBox.tsx

import {MacroComponentParams} from '@enonic/react-components';
import React from 'react';
import styles from './FactBox.module.css';


export const Factbox = ({config, children}: MacroComponentParams) => {

    return (
        <ins className={styles.factbox}>
            <i>💬</i>
            <strong className={styles.header}>{config.header ? config.header as string : "Fact Box"}</strong>
            <div className={styles.bodyContent}> {children}</div>
        </ins>
    );
};

Styling

/src/main/resources/react4xp/components/macro/FactBox.module.css

.factbox {
  display: block;
  text-decoration: none;
  border-radius: 8px;
  clear: both;
  padding: 10px 20px;
  max-width: fit-content;
  margin: 1rem;
  position: relative;
  background-color: #0b0425;

  i {
    font-style: normal;
  }
}

.factbox .header {
  font-size: 20px;
  line-height: 24px;
  margin: 0 0 0 1rem;
}

Register the component

/src/main/resources/react4xp/componentRegistry.tsx

import {ComponentRegistry} from '@enonic/react-components';
import {Person} from './components/content/Person';
import {Hello} from './components/hello/Hello';
import {Factbox} from './components/macro/FactBox';

export const componentRegistry = new ComponentRegistry();

componentRegistry.addContentType('portal:site', {View: Hello});
componentRegistry.addContentType('com.enonic.app.hmdb:person', {View: Person});
componentRegistry.addMacro('factbox', {View: Factbox});

Factbox complete!

You should now see Lea Seydoux updated with the FactBox macro:

Figure 3. Person content rendered with rich text and macro

Sweet! next up pages.

Rich text

Contents

Intro

Sample content

Rich text rendering

Macro component

Contents

Contents