Back to integrations

Integrate Lexical with Strapi

Learn how to integrate Lexical with Strapi

tweet selection
Lexical and Strapi Integration.png

    These integration guides are not official documentation and the Strapi Support Team will not provide assistance with them.

    Why Use Lexical?

    Lexical, developed by Facebook, is a text editor framework that focuses on reliability, accessibility, and performance—making it an excellent choice for integration with Strapi. Lexical ships with React bindings but integrates with any JavaScript framework you prefer. Strapi is primarily an open-source headless CMS that integrates with various technologies. It provides APIs that can be consumed by JavaScript in browsers and by Swift in iOS applications. When you integrate Lexical with Strapi, building anything from a simple plain-text editor to a full-featured WYSIWYG experience becomes straightforward with Lexical's declarative APIs.

    Integrating Lexical with Strapi can enhance your enterprise content management capabilities. Ready to explore? Check out the complete documentation on Lexical's official website.

    Why Use Strapi?

    Strapi is the leading open-source headless CMS offering features, like customizable APIs, role-based permissions, multilingual support, etc. It simplifies content management and integrates effortlessly with modern frontend frameworks.

    Explore the Strapi documentation for more details.

    Strapi 5 Highlights

    The out-of-the-box Strapi features allow you to get up and running in no time: 1. Single types: Create one-off pages that have a unique content structure. 2. Draft and Publish: Reduce the risk of publishing errors and streamline collaboration. 3. 100% TypeScript Support: Enjoy type safety & easy maintainability 4. Customizable API: With Strapi, you can just hop in your code editor and edit the code to fit your API to your needs. 5. Integrations: Strapi supports integrations with Cloudinary, SendGrid, Algolia, and others. 6. Editor interface: The editor allows you to pull in dynamic blocks of content. 7. Authentication: Secure and authorize access to your API with JWT or providers. 8. RBAC: Help maximize operational efficiency, reduce dev team support work, and safeguard against unauthorized access or configuration modifications. 9. i18n: Manage content in multiple languages. Easily query the different locales through the API. 10. Plugins: Customize and extend Strapi using plugins.

    Learn more about Strapi 5 feature.

    See Strapi in action with an interactive demo

    Explore Strapi in an instant, hands-on demo set up just for you.

    Setup Strapi 5 Headless CMS

    We are going to start by setting up our Strapi 5 project with the following command:

    🖐️ Note: make sure that you have created a new directory for your project.

    You can find the full documentation for Strapi 5 here.

    Install Strapi

    npx create-strapi-app@latest server

    You will be asked to choose if you would like to use Strapi Cloud we will choose to skip for now.

     Strapi   v5.6.0 🚀 Let's create your new project

 
We can't find any auth credentials in your Strapi config.

Create a free account on Strapi Cloud and benefit from:

- ✦ Blazing-fast ✦ deployment for your projects
- ✦ Exclusive ✦ access to resources to make your project successful
- An ✦ Awesome ✦ community and full enjoyment of Strapi's ecosystem

Start your 14-day free trial now!


? Please log in or sign up. 
  Login/Sign up 
❯ Skip

    After that, you will be asked how you would like to set up your project. We will choose the following options:

    ? Do you want to use the default database (sqlite) ? Yes
? Start with an example structure & data? Yes <-- make sure you say yes 
? Start with Typescript? Yes
? Install dependencies with npm? Yes
? Initialize a git repository? Yes

    Once everything is set up and all the dependencies are installed, you can start your Strapi server with the following command:

    cd server
npm run develop

    You will be greeted with the Admin Create Account screen.

    003-strapi-5.png

    Go ahead and create your first Strapi user. All of this is local so you can use whatever you want.

    Once you have created your user, you will be redirected to the Strapi Dashboard screen.

    004-strapi-5.png

    Publish Article Entries

    Since we created our app with the example data, you should be able to navigate to your Article collection and see the data that was created for us.

    005-strapi-5.png

    Now, let's make sure that all of the data is published. If not, you can select all items via the checkbox and then click the Publish button.

    Strapi Articles Published

    Enable API Access

    Once all your articles are published, we will expose our Strapi API for the Articles Collection. This can be done in Settings -> Users & Permissions plugin -> Roles -> Public -> Article.

    You should have find and findOne selected. If not, go ahead and select them.

    007-strapi-5.png

    Test API

    Now, if we make a GET request to http://localhost:1337/api/articles, we should see the following data for our articles.

    008-strapi-5.png

    🖐️ Note: The article covers (images) are not returned. This is because the REST API by default does not populate any relations, media fields, components, or dynamic zones.. Learn more about REST API: Population & Field Selection.

    So, let's get the article covers by using the populate=* parameter: http://localhost:1337/api/articles?populate=*

    vuejs strapi integration - api request.png

    Getting Started with Lexical

    Combining Lexical with Strapi creates a powerful rich text editing experience for your content management system. Here's how to set everything up quickly.

    Installing Lexical and Adjusting Settings in Strapi

    Let's get Lexical installed in your Strapi project:

    1. Open your terminal and navigate to your Strapi project root.
    2. Install the required packages:
    npm install lexical @lexical/react
    1. To configure various aspects of Strapi's admin panel, you may update ./config/admin.js with the following code:
    1module.exports = ({ env }) => ({
2 webpack: (config) => {
3   config.resolve.alias['lexical'] = require.resolve('lexical');
4   return config;
5 },
6});

    For specific integrations or customizations like Lexical, additional steps or specific resources might be necessary. 4. Generate a plugin for your Lexical integration:

    yarn strapi generate plugin

    or

    npm run strapi generate plugin

    Then, name the plugin when prompted. 5. Enable your new plugin in ./config/plugins.js:

    1module.exports = {
2 'lexical-editor': {
3   enabled: true,
4   resolve: './src/plugins/lexical-editor'
5 }
6};
    1. To create or add custom field types for Lexical, consult the software's documentation or contact their support team for guidance.

    To enhance your productivity, consider exploring Strapi plugins for productivity and installing essential Strapi plugins that can streamline your development process.

    Code Implementation for Integrating Lexical with Strapi

    Here's how to bring everything together with actual code to integrate Lexical with Strapi:

    First, create a basic Lexical editor component:

    1import React from 'react';
2import { LexicalComposer } from '@lexical/react/LexicalComposer';
3import { RichTextPlugin } from '@lexical/react/LexicalRichTextPlugin';
4import { ContentEditable } from '@lexical/react/LexicalContentEditable';
5import { HistoryPlugin } from '@lexical/react/LexicalHistoryPlugin';
6
7const LexicalField = ({ attribute, onChange, name, value }) => {
8  const initialConfig = {
9    namespace: 'MyEditor',
10    onError: (error) => console.error(error),
11  };
12
13  return (
14    <LexicalComposer initialConfig={initialConfig}>
15      <RichTextPlugin
16        contentEditable={<ContentEditable />}
17        placeholder={<div>Enter some text...</div>}
18      />
19      <HistoryPlugin />
20    </LexicalComposer>
21  );
22};
23
24export default LexicalField;

    Next, register your custom field in the plugin's index file:

    1import pluginPkg from '../../package.json';
2import LexicalField from './components/LexicalField';
3import pluginId from './pluginId';
4
5export default {
6  register(app) {
7    app.addFields({ type: 'lexical', Component: LexicalField });
8  },
9  bootstrap(app) {},
10};

    To save content changes, use the OnChangePlugin with an onChange handler in a LexicalComposer component:

    1// Import OnChangePlugin
2import { OnChangePlugin } from '@lexical/react/LexicalOnChangePlugin';
3
4// Add change handler function
5const handleChange = (editorState) => {
6  onChange({ target: { name, value: JSON.stringify(editorState) } });
7};
8
9// Add this inside your LexicalComposer component
10<OnChangePlugin onChange={handleChange} />

    Finally, adjust your API controller to manage data effectively:

    1module.exports = {
2  async find(ctx) {
3    const entities = await strapi.services['api::article.article'].find(ctx.query);
4    return entities.map(entity => ({
5      ...entity,
6      content: entity.content // Ensure appropriate handling of content
7    }));
8  },
9};

    Remember to restart your Strapi server after these changes. Additionally, you might consider building a custom loader for Strapi to enhance data fetching capabilities.

    According to JavaScript Plain English, this setup gives you a solid foundation to integrate Lexical with Strapi as your rich text editor.

    You're done, congrats!

    Strapi Open Office Hours

    If you have any questions about Strapi 5 or just would like to stop by and say hi, you can join us at Strapi's Discord Open Office Hours Monday through Friday at 12:30 pm - 1:30 pm CST: Strapi Discord Open Office Hours

    For more details, visit the Strapi documentation and Lexical documentation.

    tweet selection