{bb_events}

This module renders a list of events. Events can also be placed within a calendar.

This module supports Liquid.

Syntax

{bb_events filter="" sort="" limit="" display="" displayPagination="true" emptyMessage="No events found." collectionName="" layout=""}

Properties

• id - System generated ID number.
• filter - These fields and associated values build a filter string as follows:
  filter="fieldname1:fieldValue1 | fieldname2:fieldValue2"
  Options:
  • eventId - Text box.
  • eventTitle - Text box.
  • eventType - Mult-select list of the available event types.
  • tags - Multi-select list of all tags available.
  • publishedBetween - From Date and To Date
  • latest - Displays the latest item(s). Amount of items displayed is controlled by the limit property.
• sort - This parameter can be used for sorting and builds a sort string as follows:
  sort="eventTitle:Ascending | eventDate:Descending | sortOrder:Descending"
  Options:
  • id
  • eventTitle
  • eventDate
• limit – Set the maximum number of items to display. Default is "10".
• display - Use Month to render a monthly calendar with all your events or use List to return a basic list that can be managed using Design > Module Layouts > Events.
• resultsPerPage - (Not available yet) When displayPagination is set to "true" this number will determine the number of items displayed in a page.
• displayPagination - (Not available yet) Renders the pagination section when there are more in the data items than the resultsPerPage value.
• 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.

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.
• {{eventRequiresPayment}}– Renders a "true" if checked, a "false" if not.
• {{eventPaymentForm}}– Renders the name of the webform that is used to collect payment.
• {{eventPercentFull}}– Calculated percentage of the total seats reserved for the event.
• {{eventStartDate}} – Start date of the event. Use Liquid date switches to format display.
• {{eventEndDate}} – End date of the event. Use Liquid date switches to format display.
• {{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.
• {{eventLink | text: "Your Text"}} – Creates a link that enables the user to click to view the event details.
• {{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.