Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eea/volto-doublerange-facet

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/eea/volto-doublerange-facet
Owner: eea
License: mit
Created: 2024-02-22T10:27:59.000Z (9 months ago)
Default Branch: master
Last Pushed: 2024-03-23T11:48:21.000Z (8 months ago)
Last Synced: 2024-07-05T08:33:51.684Z (4 months ago)
Language: JavaScript
Size: 43.9 KB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-volto - volto-doublerange-facet - Adds a double range facet filter to the Volto Search block (Addons / Widgets)

README

        # volto-doublerange-facet

[![Releases](https://img.shields.io/github/v/release/eea/volto-doublerange-facet)](https://github.com/eea/volto-doublerange-facet/releases)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-doublerange-facet%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-doublerange-facet/job/master/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-master)

[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-doublerange-facet%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-doublerange-facet/job/develop/display/redirect)

[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)

[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)

[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)

[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-doublerange-facet-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-doublerange-facet-develop)

[Volto](https://github.com/plone/volto) add-on

## Features

This addon let's you configure a double range facet in the Volto Search Block.

This allows you to build a year range selector for instance.

This facet requires to have the value indexed as a `FieldIndex` in the Plone backend.

At this moment the values need to be indexes as strings in the Plone backend. We will be working on supporting also values indexed as ints in the backend.

When configuring the facet, it allows to define the step in which the range will be moved up and down and it automatically detects the lower and highest values of the range.

## Images

![full range](./docs/full-range.png)

![lower range](./docs/lower-range.png)

![both ranges](./docs/both-ranges.png)

## Getting started

### Try volto-doublerange-facet with Docker

      git clone https://github.com/eea/volto-doublerange-facet.git

      cd volto-doublerange-facet

      make

      make start

Go to http://localhost:3000

### Add volto-doublerange-facet to your Volto project

1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone

   ```Bash

   docker compose up backend

   ```

1. Start Volto frontend

- If you already have a volto project, just update `package.json`:

  ```JSON

  "addons": [

      "@eeacms/volto-doublerange-facet"

  ],

  "dependencies": {

      "@eeacms/volto-doublerange-facet": "*"

  }

  ```

- If not, create one:

  ```

  npm install -g yo @plone/generator-volto

  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-doublerange-facet

  cd my-volto-project

  ```

1. Install new add-ons and restart Volto:

   ```

   yarn

   yarn start

   ```

1. Go to http://localhost:3000

1. Happy editing!

## Release

See [RELEASE.md](https://github.com/eea/volto-doublerange-facet/blob/master/RELEASE.md).

## How to contribute

See [DEVELOP.md](https://github.com/eea/volto-doublerange-facet/blob/master/DEVELOP.md).

## Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA).

All Rights Reserved.

See [LICENSE.md](https://github.com/eea/volto-doublerange-facet/blob/master/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)

ter/LICENSE.md) for details.

## Funding

[European Environment Agency (EU)](http://eea.europa.eu)