Menu

#616 Menu item list

Parent Category:
DPCalendar
Category:
Menu items
Last Updated:
Allon Moritz, Monday, 27 May 2024 08:33
Created:
Wednesday, 22 February 2012 10:15
Hits:
10311

This feature is part of the DPCalendar Standard subscription.
SubscribePHP 7.4PHP 8Joomla 3.10Joomla 4.4Joomla 5

Introduction

The Event list menu item shows a list of upcoming events, similar to a Joomla articles category list, below a map. Initially is the list shown for a given timeframe, specified in the options. Through the navigation button, can the visitor browse the events in time.

Map

The map above the events list does show their locations. If there are multiple events on close locations or even on the same location, then a cluster is shown which shows an icon about how many events do appear on that spot. Clicking on the cluster icon will expand the events where the visitor can click on them to show their info popup.

How to setup the map providers and more is documented in the maps Introduction article.

Events list

Search form

There is a search area available which allows to search between dates and in content. Users are also able to search events in a certain radius for a specific location.

The basic options are empty by default, which means the global settings of component options will be used, but you can override this in the menu link configuration. The search criteria is saved in the session, which means, when the visitor comes back, then the settings are remembered.

Events list form

Location search autocomplete

If the user wants to search based on locations, then he can start typing a name in the location field. Instantly a search is performed which delivers a list of locations to choose from. These locations are fetched from the defined maps provider in the DPCalendar options.

Events list form location

Important options

There are tons of settings for the list view in the global DPCalendar options. We would like to explain here the most important ones. Every option has a detailed explanation as tooltip when hoovering over the label in the Joomla configuration manager.

  • Ordering
    The order of the events, can be ascending, descending or adaptive. The adaptive setting changes the order for past events to descending and for future events to ascending.
  • Start date
    The start date where the list should load initially.
  • List increment
    The list shows the events time based and with the increment setting the admin can define the time span of the shown events. This setting is also used when the user navigates in the list back and forth.
  • Expand events
    If expand events is set to yes, then the individual instances of a series are shown, otherwise only the original events beside the single events. If only the original events are shown, then a human readable string is displayed of the rrule attribute of the event.

Filters

In the list menu item the admin can set different filters for the events to display only what is needed.

Author filter

When filtering for an author, then only events of a given user are shown within the calendar. There is a special "My" option available which displays only events of the current logged in user.

Location filter

A filter to display only events from the selected locations.

Tags filter

A filter to display only events from the selected tags. Tags can be set while editing an event.

Options

The settings can be configured globally in the DPCalendar options or per menu item. If the value is empty in the menu item, then it will be inherited from the global options.

Start Date [Type: Text]
The start date, can be relative to now like '+1 day'.
End Date [Type: Text]
The end date, can be relative to now like '+1 day'.
Date Format [Type: Text] [Default: j.n.Y]
The date format in the header of the list.
List Increment [Type: Text] [Default: 1 month]
The increment value for the navigation. Accepts strings like 1 month, 2 weeks or 4 days.
Include ongoing events [Type: Radio] [Default: No]
Should ongoing events be included.
The following options are available:
  1. No
  2. Yes
Expand Events [Type: Radio] [Default: Yes]
Show the instances of a series or only the original event.
The following options are available:
  1. No
  2. Yes
Content Before [Type: Textarea]
This text will be displayed before the component output (can contain HTML and supports content plugins).
Content After [Type: Textarea]
This text will be displayed after the component output (can contain HTML and supports content plugins).
Description Limit [Type: Text]
Specify how much text will be be displayed from the event description. Empty means unlimited.
Event ordering [Type: List] [Default: Adaptive]
How should the ordering of the events be. The adaptive setting orders the past events descending and future ones ascending.
The following options are available:
  1. Ascending
  2. Descending
  3. Adaptive
Search Form [Type: List] [Default: Show]
How should the state of the search form be.
The following options are available:
  1. Show
  2. Expand
  3. Hide
Hidden Search Form Fields [Type: Dpcfields]
The fields to hide in the search form.
Show Hits [Type: Radio] [Default: Yes]
Should the hits value be shown.
The following options are available:
  1. No
  2. Yes
Show Print Button [Type: Radio] [Default: Yes]
Should the print button be shown.
The following options are available:
  1. No
  2. Yes
Show Booking Button [Type: Radio] [Default: Yes]
Show the booking button.
The following options are available:
  1. No
  2. Yes
Show Capacity [Type: Radio] [Default: Yes]
Should the capacity of the event be shown?
The following options are available:
  1. No
  2. Yes
Show Display Data [Type: Radio] [Default: No]
Should the data from content plugins like custom fields be displayed?
The following options are available:
  1. No
  2. Yes
Show Map [Type: Radio] [Default: Yes]
Should a map be shown.
The following options are available:
  1. No
  2. Yes
Map Zoom [Type: Text] [Default: 4]
The initial zoom level of the map.
Map Width [Type: Text] [Default: 100%]
The width of the map.
Map Height [Type: Text] [Default: 350px]
The height of the map.
Map Latitude [Type: Text] [Default: 47]
The initial latitude of the map.
Map Longitude [Type: Text] [Default: 4]
The initial longitude of the map.
Featured [Type: Radio] [Default: No]
Show only featured events.
The following options are available:
  1. No
  2. Yes
Enable Autocomplete [Type: Radio] [Default: Yes]
Should autocomplete be enabled?
The following options are available:
  1. No
  2. Yes
Filter Author [Type: Dpauthor] [Default: None]
Filters events by author. If my is set, then only events from the currently logged in user are shown.
The following options are available:
  1. My
  2. None
Filter Locations [Type: Location]
Only show events for the given locations. If empty, the filter has no influence.
Filter Tags [Type: Tag]
Only show events for the given tags. If empty, the filter has no influence.
Custom CSS [Type: Textarea]
Custom CSS code which will be added to the HTML document.

Comments (0)

We use cookies on our website. Some of them are essential for the operation of the site, while others help us to improve this site and the user experience (tracking cookies). You can decide for yourself whether you want to allow cookies or not. Please note that if you reject them, you may not be able to use all the functionalities of the site.

Ok Decline
More information