npm package: @plone-collective/volto-footer
Description: Volto editable footer
Author: Plone Community
Latest version: 1.0.0

# Volto Footer (volto-footer)

Volto addon to make the footer editable. Intended to be used with [collective.volto.footer](https://github.com/collective/collective.volto.footer)

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

## Features




https://github.com/user-attachments/assets/64b0b329-86f2-4dfd-afc6-742b0802f051





This addon allows you to customize the footer by adding blocks to it. You can add any type of block to create rich, dynamic footer content. The footer will automatically use the closest footer configuration relative to the current page.

**Requirements:**
- This addon requires [collective.volto.footer](https://github.com/collective/collective.volto.footer) to be installed on the backend.

**Key Features:**
- **Block-based customization**: Add any type of Volto block to your footer
- **Context-aware**: Automatically selects the most appropriate footer based on page location
- **Editable behavior**: Only content with the editable footer behavior enabled can be modified
- **Flexible configuration**: The editable footer behavior can be activated on any content type

## Installation

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


### Volto 18 and later

Add `volto-footer` to your `package.json`:

```json
"dependencies": {
    "volto-footer": "*"
}
```

Add `volto-footer` to your `volto.config.js`:

```javascript
const addons = ['volto-footer'];
```

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 = 'volto-footer';
```

### 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 volto-footer
cd my-volto-project
```

Add `volto-footer` to your package.json:

```JSON
"addons": [
    "volto-footer"
],

"dependencies": {
    "volto-footer": "*"
}
```

Download and install the new add-on by running:

```
yarn install
```

Start volto with:

```
yarn start
```

## 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).


### Prerequisites ✅

-   An [operating system](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation) that runs all the requirements mentioned.
-   [nvm](https://6.docs.plone.org/install/create-project-cookieplone.html#nvm)
-   [Node.js and pnpm](https://6.docs.plone.org/install/create-project.html#node-js) 22
-   [Make](https://6.docs.plone.org/install/create-project-cookieplone.html#make)
-   [Git](https://6.docs.plone.org/install/create-project-cookieplone.html#git)
-   [Docker](https://docs.docker.com/get-started/get-docker/) (optional)

### Installation 🔧

1.  Clone this repository, then change your working directory.

    ```shell
    git clone git@github.com:collective/volto-footer.git
    cd volto-footer
    ```

2.  Install this code base.

    ```shell
    make install
    ```


### 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 🙏

Generated using [Cookieplone (0.9.7)](https://github.com/plone/cookieplone) and [cookieplone-templates (5bf1a02)](https://github.com/plone/cookieplone-templates/commit/5bf1a02b9f870b38a941f55718e3f53d1c2b9fa7) on 2025-05-29 14:40:47.567379. A special thanks to all contributors and supporters!