Nuxt Strapi Blocks Renderer

[![Github Actions][github-actions-src]][github-actions-href]
[![NPM version][npm-version-src]][npm-version-href]
[![NPM last update][npm-last-update-src]][npm-last-update-href]
[![License][license-src]][license-href]

Fully customizable module for Nuxt 3 & 4 to render the "Blocks" rich text editor element from Strapi CMS.

The implementation is based on Strapi's Blocks React Renderer.

- ✨ Release notes
- 🏀 Online stackblitz playground

Installation

To install the Nuxt Strapi Blocks Renderer module, run the following command:

``bash
npx nuxt@latest module add nuxt-strapi-blocks-renderer
`

Usage

To render text, use the StrapiBlocksText component:

`vue

`

In this example, the blockNodes are taken from the JSON response which Strapi provides when using the Blocks rich
text editor element:

`vue



`

To use the useStrapi composable, install the Strapi Nuxt module.

$3

In situations where your project requires specific styling or behavior for certain HTML tags such as ,

,
and others, you can override the default rendering components used by the Nuxt Strapi Blocks Renderer.
This flexibility allows you to tailor the rendering to align with your project's unique design and functional needs.

#### Global Component Registration

First, ensure that your components are globally registered in your Nuxt app.
This step is crucial for your custom components to be recognized and used by the renderer.

In your Nuxt configuration (nuxt.config.{js|ts}), add:

`ts
export default defineNuxtConfig({
components: {
dirs: [
{
path: '~/components/blocks',
pathPrefix: false,
global: true,
},
// also include ~/components to ensure other local components are resolved properly
'~/components'
],
},
})
`

> [!IMPORTANT]
> It's important to include ~/components in the dirs array.
> Omitting it may cause locally scoped components (outside of ~/components/blocks) not to resolve correctly.

#### Customizing the Paragraph Tag

To customize the rendering of the paragraph (

) tag, you need to create a corresponding Vue component.
The name of the component follows a predefined pattern: 'StrapiBlocksText' + [NodeName] + 'Node.vue'.
To override the default paragraph tag, we create a file called StrapiBlocksTextParagraphNode.vue.

`html


`

This component assigns a custom class my-custom-class-for-p to the paragraph tag, which can be styled as needed.

The prefix for the custom components can be adjusted in your nuxt.config.{js|ts}:

`ts
export default defineNuxtConfig({
strapiBlocksRenderer: {
prefix: 'MyCustomPrefix',
blocksPrefix: 'MyCustomBlocksPrefix',
},
})
`

With this configuration, the StrapiBlocksText component becomes MyCustomPrefixStrapiBlocksText and the custom
paragraph node component would be named MyCustomBlocksPrefixParagraphNode.

#### Other Custom Tags

You can apply similar customizations to all other HTML tags used by the renderer:

Development

$3

To install the dependencies, run the install command:

`bash
npm install
`

The project requires Node.js and NPM to run.
You can either install these manually on your system or if you have the nix package manager installed, use the
provided nix-shell with the following command:

`bash
nix-shell
`

This will automatically install the needed software and start up a shell.

$3

To generate the type stubs for the nuxt module, run the dev:prepare command:

`bash
npm run dev:prepare
`

$3

To start the development server with the provided text components, run the dev command:

`bash
npm run dev
`

This will boot up the playground with the default text components.
To start the development server using custom text components, overriding the provided components,
use the dev:custom command:

`bash
npm run dev:custom
`

$3

#### Linter

To run ESLint, use the following command:

`bash
npm run lint:es
`

#### Type checks

To run the TypeScript type checks, use the following command:

`bash
npm run lint:types
`

#### Unit Tests

To run the Vitest unit tests, run the following command:

`bash
npm run test
``

$3

To build the module, first install all dependencies and generate the type stubs.
Then run the build script:

`bash
npm run build
`

The module files will be output to the dist folder.

$3

To release a new version of the strapi blocks renderer nuxt module, take the following steps:

1. Increment version number in the package.json file
2. Add changelog entry for the new version number
3. Run linters and unit tests
4. Build the nuxt module

`bash
npm run build
`

5. Log in to NPM using your access token
6. Run the release command

`bash
npm run release
``

[github-actions-src]: https://github.com/freb97/nuxt-strapi-blocks-renderer/actions/workflows/ci.yml/badge.svg
[github-actions-href]: https://github.com/freb97/nuxt-strapi-blocks-renderer/actions

[npm-version-src]: https://img.shields.io/npm/v/nuxt-strapi-blocks-renderer/latest.svg?style=flat&colorA=18181B&colorB=31C553
[npm-version-href]: https://npmjs.com/package/nuxt-strapi-blocks-renderer

[npm-last-update-src]: https://img.shields.io/npm/last-update/nuxt-strapi-blocks-renderer.svg?style=flat&colorA=18181B&colorB=31C553
[npm-last-update-href]: https://npmjs.com/package/nuxt-strapi-blocks-renderer

[license-src]: https://img.shields.io/github/license/freb97/nuxt-strapi-blocks-renderer.svg?style=flat&colorA=18181B&colorB=31C553
[license-href]: https://github.com/freb97/nuxt-strapi-blocks-renderer/blob/main/LICENSE