npm package: @kitconcept/volto-introduction-block
Description: A standalone (detached slate) block that provides a text block meant to be used as introduction to a content page.
Author: kitconcept, GmbH
Latest version: 1.4.1

# Volto Introduction Block (@kitconcept/volto-introduction-block)

A standalone (detached slate) block that provides a text block meant to be used as introduction to a content page.

[![npm](https://img.shields.io/npm/v/@kitconcept/volto-introduction-block)](https://www.npmjs.com/package/@kitconcept/volto-introduction-block)
[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook&logoColor=white&style=flat-square)](https://kitconcept.github.io/volto-introduction-block/)
[![Code analysis checks](https://github.com/kitconcept/volto-introduction-block/actions/workflows/code.yml/badge.svg)](https://github.com/kitconcept/volto-introduction-block/actions/workflows/code.yml)
[![Unit tests](https://github.com/kitconcept/volto-introduction-block/actions/workflows/unit.yml/badge.svg)](https://github.com/kitconcept/volto-introduction-block/actions/workflows/unit.yml)

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://kitconcept.com/kitconcept-white.svg">
  <img width="300" alt="kitconcept, GmbH" src="https://kitconcept.com/kitconcept-black.svg">
</picture>

## Screenshot

<img alt="Volto Introduction Block" src="https://github.com/user-attachments/assets/5be1a11a-afe1-44c9-9882-3510c4d3bfdf">

## Screencast

https://github.com/user-attachments/assets/0705000b-6fcb-47f1-8862-c6197a048b83

## Features

- **Introduction block** — Registers a standalone (detached Slate) `introduction` block that provides a styled text block meant to be used as an introduction to a content page.
- **Inline editing** — Text is editable inline using the Slate rich-text editor, just like Volto's standard text block.
- **Detached block** — Renders outside the normal block flow, making it suitable for page introductions without affecting the surrounding layout.

## Installation

To install your project, you must choose the method appropriate to your version of Volto.


### Volto 17 and earlier

Create a new Volto project (you can skip this step if you already have one):

```
npm install -g yo @plone/generator-volto
yo @plone/volto my-volto-project --addon @kitconcept/volto-introduction-block
cd my-volto-project
```

Add `@kitconcept/volto-introduction-block` to your package.json:

```JSON
"addons": [
    "@kitconcept/volto-introduction-block"
],

"dependencies": {
    "@kitconcept/volto-introduction-block": "*"
}
```

Download and install the new add-on by running:

```
yarn install
```

Start volto with:

```
yarn start
```

### Volto 18 and later

Add `@kitconcept/volto-introduction-block` to your `package.json`:

```json
"dependencies": {
    "@kitconcept/volto-introduction-block": "*"
}
```

Add `@kitconcept/volto-introduction-block` to your `volto.config.js`:

```javascript
const addons = ['@kitconcept/volto-introduction-block'];
```

If this package provides a Volto theme, and you want to activate it, then add the following to your `volto.config.js`:

```javascript
const theme = '@kitconcept/volto-introduction-block';
```

## Test installation

Visit http://localhost:3000/ in a browser, login, and check the awesome new features.


## Development

The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest `mrs-developer` and other Volto core improvements.
For this reason, it only works with pnpm and Volto 18 (currently in alpha).


### Pre-requisites

-   [Node.js](https://6.docs.plone.org/install/create-project.html#node-js)
-   [Make](https://6.docs.plone.org/install/create-project.html#make)
-   [Docker](https://6.docs.plone.org/install/create-project.html#docker)


### Make convenience commands

Run `make help` to list the available commands.

```text
help                             Show this help
install                          Installs the add-on in a development environment
start                            Starts Volto, allowing reloading of the add-on during development
build                            Build a production bundle for distribution of the project with the add-on
i18n                             Sync i18n
ci-i18n                          Check if i18n is not synced
format                           Format codebase
lint                             Lint, or catch and remove problems, in code base
release                          Release the add-on on npmjs.org
release-dry-run                  Dry-run the release of the add-on on npmjs.org
test                             Run unit tests
ci-test                          Run unit tests in CI
backend-docker-start             Starts a Docker-based backend for development
storybook-start                  Start Storybook server on port 6006
storybook-build                  Build Storybook
acceptance-frontend-dev-start    Start acceptance frontend in development mode
acceptance-frontend-prod-start   Start acceptance frontend in production mode
acceptance-backend-start         Start backend acceptance server
ci-acceptance-backend-start      Start backend acceptance server in headless mode for CI
acceptance-test                  Start Cypress in interactive mode
ci-acceptance-test               Run cypress tests in headless mode for CI
```

### Development environment set up

Install package requirements.

```shell
make install
```

### Start developing

Start the backend.

```shell
make backend-docker-start
```

In a separate terminal session, start the frontend.

```shell
make start
```

### Lint code

Run ESlint, Prettier, and Stylelint in analyze mode.

```shell
make lint
```

### Format code

Run ESlint, Prettier, and Stylelint in fix mode.

```shell
make format
```

### i18n

Extract the i18n messages to locales.

```shell
make i18n
```

### Unit tests

Run unit tests.

```shell
make test
```

### Run Cypress tests

Run each of these steps in separate terminal sessions.

In the first session, start the frontend in development mode.

```shell
make acceptance-frontend-dev-start
```

In the second session, start the backend acceptance server.

```shell
make acceptance-backend-start
```

In the third session, start the Cypress interactive test runner.

```shell
make acceptance-test
```

## License

The project is licensed under the MIT license.

## Credits and Acknowledgements 🙏

Crafted with care by **Generated using [Cookieplone (0.8.2)](https://github.com/plone/cookieplone) and [cookiecutter-plone (d9b5293)](https://github.com/plone/cookiecutter-plone/commit/d9b52933cbc6efd137e93e35a270214e307359f0) on 2025-01-17 16:02:46.759351**. A special thanks to all contributors and supporters!