volto-advanced-variations
Version:
Advanced variations: Volto add-on
153 lines (103 loc) • 6.02 kB
Markdown
# volto-advanced-variations
A [Plone/volto](https://plone.org/why-plone) [block](https://6.dev-docs.plone.org/volto/blocks/index.html) [add-on](https://6.dev-docs.plone.org/volto/addons/index.html) that add new variations to the listing and search blocks.
## Features
Based on [codesyntax/volto-listingadvanced-variation](https://github.com/codesyntax/volto-listingadvanced-variation) this addon add events options including dates times and location, displaying this listing or search as a carousel/slider, image gallery, styled list, or table layout.
### New in 0.8.0:
- Added 'Advanced Table' variation - displays items in a table with columns determined by selected options
- Added 'Advanced List Marker' variation - allows custom list marker styles (none, disc, circle, square, decimal, roman, alpha)
### New in 0.7.0:
- Added 'Advanced List' variation - displays items as a list with OL, UL, or no bullets styling
### Previous versions:
0.6.0: Added 'read more' and animation option.
0.5.1 move events options to fieldset
0.5.0 Volto-light-theme support and Background image URL correction
0.4.0: Added show Creator/Author support and option.
0.2.0: Added event recurrence support and option. if enable the event will show the future recurrence of the events and
will overwrite the order of the items.
### Listing options
A example of Listing options Sidebar, it look like the following capture:
---
### Carousel options
A example of Carousel options Sidebar, it look like the following capture:
---
### Advanced List Marker options
A example of Advanced List Marker options Sidebar, it look like the following capture:
---
### Advanced Table options
A example of Advanced Table options Sidebar, it look like the following capture:
---
## Advanced List Marker properties
### List Display Options
1. `titleTag` (_choice_): items heading level.
1. `listMarker` (_choice_): select the list marker style (None, Disc, Circle, Square, Decimal, Decimal Leading Zero, Lower Roman, Upper Roman, Lower Alpha, Upper Alpha).
1. `showTitle` (_boolean_): Show Title.
1. `showDescription` (_boolean_): Show Description.
### Item Event Options
1. `eventDate` (_boolean_): Show event date.
1. `eventTime` (_boolean_): Show event time.
1. `eventLocation` (_boolean_): Show event location.
1. `showRecurrence` (_boolean_): Show event recurrence date and change order.
1. `effectiveDate` (_boolean_): Show effective date.
1. `expirationDate` (_boolean_): Show expiration date.
1. `creatorauthor` (_boolean_): Show Creator/Author.
1. `readMore` (_boolean_): Show read more.
---
## Advanced Table properties
### Table Display Options
1. `showTitle` (_boolean_): Show Title.
1. `showDescription` (_boolean_): Show Description.
1. `effectiveDate` (_boolean_): Show effective date.
1. `expirationDate` (_boolean_): Show expiration date.
1. `eventDate` (_boolean_): Show event date.
1. `eventTime` (_boolean_): Show event time.
1. `eventLocation` (_boolean_): Show event location.
1. `creatorauthor` (_boolean_): Show Creator/Author.
---
## Advanced Listing properties
1. `titleTag` (_choice_): items heading level.
1. `howManyColumns` (_choice_): you can have one to four columns.
1. `imageSide` (_choice_): where the image will show, top, left, bottom, right background or no image.
1. `imageWidth` (_choice_): if the image shows left or right you can specify the width within the item div.
1. `showTitle` (_boolean_): Show Title.
1. `showDescription` (_boolean_): Show Description.
1. `eventCard` (_boolean_): Show event card.
1. `eventDate` (_boolean_): Show event date.
1. `eventTime` (_boolean_): Show event time.
1. `eventLocation` (_boolean_): Show event location.
1. `effectiveDate` (_boolean_): Show effective date.
1. `expirationDate` (_boolean_): Show expiration date.
1. `show as quote` (_boolean_): Show as quote.
1. `eventRecurrence` (_boolean_): Show event recurrence date and change order.
## Advanced Carousel properties
### Carousel/Slider Options
1. `howManyColumns` (_choice_): you can have one to four columns.
1. `slidesToScroll` (_choice_): how many items to scroll at a time.
1. `autoPlay` (_boolean_): auto play the carousel.
1. `autoPlaySpeed` (_number_): auto play speed in milliseconds.
### Item Display Options
1. `titleTag` (_choice_): items heading level.
1. `imageSide` (_choice_): where the image will show, top, left, bottom, right background or no image.
1. `showTitle` (_boolean_): Show Title.
1. `showDescription` (_boolean_): Show Description.
1. `eventCard` (_boolean_): Show event card.
1. `eventDate` (_boolean_): Show event date.
1. `eventTime` (_boolean_): Show event time.
1. `eventLocation` (_boolean_): Show event location.
1. `effectiveDate` (_boolean_): Show effective date.
1. `expirationDate` (_boolean_): Show expiration date.
1. `show as quote` (_boolean_): Show as quote.
1. `eventRecurrence` (_boolean_): Show event recurrence date and change order.
1. `enableAnimation` (_boolean_): Enable animation.
1. 'readMore' (_boolean_): Show read more.
## Screen recording
[](https://youtu.be/KhnCCyNOu28)
## How to contribute
See [DEVELOP.md](https://github.com/rnunez80/volto-advanced-variations/blob/main/DEVELOP.md).
## Copyright and license
The Initial Owner of the Original Code is Rafael Nunez.
All Rights Reserved.
See [LICENSE.md](https://github.com/rnunez80/volto-advanced-variations/blob/main/LICENSE.md) for details.