The {bb_events} module renders a list of Events. Events can be displayed within a list or calendar.
This module supports Liquid.
Syntax
{bb_events filter="" limit="" sort="" display="list|month" displayPagination="true|false" emptyMessage="No events found." collectionName="" layout=""}
Parameters
- id - System generated ID number.
- filter - These option and associated values build a filter string as follows:
filter="option1:optionvalue1 | option2:optionvalue2"
Options:- id - Returns a specific Event item.
- tags - Multi-select list of all tags available. Separate individual tags with semi-colon. Example: filter="tags:Tag 1;Tag 2"
- eventType - Filters the results by Event types.
- datesBetween - From beginning date and to an end date separated with a semi-colon. Format: %M/%d/yyyy;%M/%d/yyyy. Example: filter="dateBetween:1/1/2021;12/31/2021"
- limit – Set the maximum number of Event items to display. Default is "10".
- sort - This parameter can be used for sorting and builds a sort string as follows:
sort="eventTitle:Ascending | eventStartDate:Descending"
Options:- eventId
- eventTitle (default) - Sorts returned Event items according to Event titles.
- eventStartDate - Sorts returned Event items according to Event Start dates.
- display - List (default) to return a basic list or use Month to render a monthly calendar with all your events.
- resultsPerPage - When displayPagination is set to "true" this number will determine the number of items displayed in a page. (Part of future release)
- displayPagination - Renders the pagination section when there are more in the data items than the resultsPerPage value. (Part of future release)
- emptyMessage - Custom message value that is rendered. Default text is "No items found.".
- collectionName - The parameter is used to access the collection the Liquid tags.
- layout - Renders the module output using:
layout="Default"
- sets the layout to the Default module layout;layout="My Custom Layout"
- set the layout to use a custom layout template;layout=""
- allows you to code a custom layout right within the web page HTML.
Areas Available
The {bb_events} module tag can be placed within these areas.
- Page Templates
- Web Pages
- Landing Pages
- Content Holders
- Data Collections
Liquid Tags
{{eventId}}
– System generated ID of the event.{{eventTitle}}
– Renders the event title with a hyperlink.{{eventTitleNoLink}}
– Render the event title without a hyperlink.{{eventContent}}
– Description of the event.{{eventCapacity}}
– Total number of seats available for the event.{{eventCapacityEmpty}}
– Calculated number of remaining seats available for the event.{{eventCapacityDescription}}
– Description for number of seats available. Possible value are: Seats Available; Filling Up; Almost Full; Full.{{eventFee}}
– Renders the fee to attend the event.{{eventPercentFull}}
– Calculated percentage of the total seats reserved for the event.{{eventDate}}
- Full date format. Customize by using: {{eventDate | date: 'mm dd, yyyy'}} and standard .NET date formatting options.{{eventStartDate}}
– Start date of the event using the Month, Day, Year format.{{eventEndDate}}
– End date of the event using the Month, Day, Year format.{{eventPublishDate}}
– Date the event should be published to the website. This allows you to enter events in advance and then have them display when you want the event to display.{{eventLastUpdated}}
– Date the event was last updated.{{eventUrlWithHost}}
– URL to the event including the primary domain.{{eventUrl}}
– Relative URL to the event.{{eventTags}}
– List of tags that this event is assigned. Tags can be used for sorting data.{{eventSecureZones}}
– Renders a comma separated list of secure zones that the event has been assigned to.{{eventAddFavorite | addimage: "path/add_image.jpg" | removeimage: "path/remove_image.jpg"}}
– Adds an Event to your favorites lists. Displays only when a user is logged in.{{eventCounter}}
– Incremental count of the event booking.{{eventType}}
– Displays the assigned event types.{{eventRegistrationForm}}
– Displays the assigned event registration form. (Future release){{eventRequiresPayment}}
– Renders a "true" if checked, a "false" if not. (Future release){{eventPaymentForm}}
– Renders the name of the webform that is used to collect payment. (Future release)