Back to integrations

Integrate Quill with Strapi

Integrate Quill with Strapi

tweet selection
Quill Editor and Strapi Integration.png

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

    Why Use Quill?

    By integrating Quill with Strapi, you can enhance your content editing capabilities with a free, open-source WYSIWYG editor that shines with exceptional performance and modularity. Quill is among the most lightweight rich text editors you'll find, loading faster and using less memory than rivals like CKEditor and TinyMCE.

    Quill offers more advanced editing capabilities than Strapi's default editor while keeping performance smooth. Its clean API and comprehensive documentation make it easy to integrate, whether you need simple text formatting or robust content creation tools.

    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 Quill

    Integrating Quill with Strapi gives you powerful content editing capabilities for your headless CMS. Here's how to set up Quill as your rich text editor in Strapi.

    Installing Quill and Adjusting Settings in Strapi

    With your Strapi environment ready, let's integrate Quill.

    To create a custom plugin for your WYSIWYG editor in Strapi, you will need to follow a different approach than using the yarn strapi generate command, which is intended for generating a custom Strapi API endpoint. Instead, explore Strapi's documentation or community resources for the correct method to develop plugins tailored to your needs.

    Once you have created your custom plugin, proceed to install React-Quill:

    yarn add react-quill

    Configure the plugin in config/plugins.js:

    1module.exports = {
2  wysiwyg: {
3    enabled: true,
4    resolve: './src/plugins/wysiwyg',
5  },
6};

    This tells Strapi to use your custom WYSIWYG plugin instead of the default editor, effectively integrating Quill with Strapi. By generating this plugin, you're essentially creating a custom loader for Strapi, enabling you to tailor the editor to your needs.

    Code Implementation: Integrate Quill With Strapi

    Now implement the Quill editor by creating a QuillEditor component. If you're considering changing WYSIWYG to Quill in Strapi, this step is critical.

    Create the basic editor component in your plugin directory:

    1import React from 'react';
2import ReactQuill from 'react-quill';
3import 'react-quill/dist/quill.snow.css';
4
5const QuillEditor = ({ value, onChange }) => {
6  const modules = {
7    toolbar: [
8      [{ header: [1, 2, false] }],
9      ['bold', 'italic', 'underline', 'strike'],
10      [{ list: 'ordered' }, { list: 'bullet' }],
11      ['link', 'image'],
12      ['clean'],
13    ],
14  };
15
16  return (
17    <ReactQuill
18      theme="snow"
19      value={value}
20      onChange={onChange}
21      modules={modules}
22    />
23  );
24};
25
26export default QuillEditor;

    Customize the toolbar to match your content needs. The example includes common formatting options, but you can adjust it based on your requirements when you integrate Quill with Strapi.

    Implement integration with Strapi's field system by creating a field component using your Quill editor.

    Build the admin UI:

    yarn build

    Start the development server:

    yarn develop

    To integrate Quill as the rich text editor in the Strapi admin panel, customization is required according to Strapi documentation and available community plugins.

    For advanced customization, adjust Quill's behavior by modifying the modules configuration. You can add more formatting options by defining your desired features in the modules configuration, such as headers, fonts, text styles, and other tools:

    1const modules = {
2  toolbar: [
3    [{ header: '1' }, { header: '2' }, { font: [] }],
4    ['bold', 'italic', 'underline', 'strike', 'blockquote'],
5    [{ list: 'ordered' }, { list: 'bullet' }],
6    ['link', 'image', 'video'],
7    ['clean'],
8  ],
9};

    This setup gives you a solid foundation to integrate Quill with Strapi. From here, you can further customize the editor's appearance, add custom formats, or implement specialized handling for media uploads.

    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 Quill documentation.

    tweet selection