Back to Top (volto-back-to-top)

[](https://www.npmjs.com/package/volto-back-to-top [](https://macagua.github.io/volto-back-to-top

A new add-on for Volto that include a button to go back to the top when you scroll down the page.

Features

It provides a simple way to access to Back to Top features such as:

• A button to go back to the top when you scroll down the page.

• A progress bar included in the button that visually indicates how much you've scrolled.

Screenshots

Back to top button

This Volto component looks like this:

---

Translations

This product support the following languages:

• English

Compatibility

• Tested with Node.js 22.16.0, Volto 18, and volto-light-theme 7.8.6.

Install it

To install in your project, the volto-back-to-top add-on, you must choose the method appropriate to your version of Volto.

Volto 18 and later

Add volto-back-to-top to your package.json file:

"addons": [
    "volto-back-to-top": "*"
]

"dependencies": {
    "volto-back-to-top": "workspace:*",
}

Install from GitHub

If you trying to install from GitHub you need edit the mrs.developer.json file:

{
  "volto-back-to-top": {
    "develop": true,
    "output": "./packages/",
    "package": "volto-back-to-top",
    "url": "git@github.com:collective/volto-back-to-top.git",
    "https": "https://github.com/collective/volto-back-to-top.git",
    "branch": "main"
  }
}

The mrs.developer.json file is using by an Node.js utility called mrs.developer that makes it easy to work with npm projects containing lots of packages, of which you only want to develop some.

Also add volto-back-to-top to your package.json file:

"addons": [
    "volto-back-to-top": "*"
]

"dependencies": {
    "volto-back-to-top": "workspace:*",
}

---

Download and install the new add-on by running:

make install

Start Volto with:

make start

Settings it

For use this add-on, you need to configure the following in the settings.ts file:

• up_icon_default: Up Icon default settings.

Example:

import upSVG from '@plone/volto/icons/up.svg';

export default function install(config) {
  config.settings.up_icon_default = upSVG;
  return config;
}

Test installation

Visit http://localhost:3000/ in a browser, and check the Back to top button into the pages.

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 that runs all the requirements mentioned.
• nvm
• Node.js and pnpm 22
• Make
• Git
• Docker (optional)

Installation 🔧

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

   git clone git@github.com:collective/volto-back-to-top.git
   cd volto-back-to-top

2. Install this code base.

   make install

Make convenience commands

Run make help to list the available commands.

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.

make install

Start developing

Start the backend.

make backend-docker-start

In a separate terminal session, start the frontend.

make start

Lint code

Run ESlint, Prettier, and Stylelint in analyze mode.

make lint

Format code

Run ESlint, Prettier, and Stylelint in fix mode.

make format

i18n

Extract the i18n messages to locales.

make i18n

Unit tests

Run unit tests.

make test

Run Cypress tests

Run each of these steps in separate terminal sessions.

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

make acceptance-frontend-dev-start

In the second session, start the backend acceptance server.

make acceptance-backend-start

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

make acceptance-test

Run Storybook server

Ro run Start Storybook server on port 6006

make storybook-start

Credits

Developed with the support of:

• Instituto Municipal de Deportes - IMD, Seville City Council, Spain.

  

Acknowledgements 🙏

Generated using Cookieplone (1.1.0) and cookieplone-templates (8e49881) on 2026-09-08 09:55:51.534423. A special thanks to all contributors and supporters!

Authors

This product was developed by Leonardo J. Caballero G..

License

The project is licensed under the MIT license.