The Events List Widget allows customers to choose an upcoming event from a list:
The Events List Widget can be used for booking products that have a schedule (tours, activities, classes, and courses). The advantage of this over a datepicker (calendar) is that there is no need to scroll through months where the event is not scheduled.
There are 4 parts this guide will cover:
- Creating a product
- Configuring the product in BookThatApp
- Setting up the events list widget for your store
- Adding the events calendar to your store's navigation
There are 2 ways to create your products: via the Shopify admin product page, or through the app installation process. We recommend using the app installation method as it streamlines the process and walks you through each of the steps from product creation to implementing your booking widget.
If you opt to create your product in Shopify first please select the following link.
BookThatApp (BTA) Setup Wizard
The BTA setup wizard walks you through creating a product and configuring the widget that will allow the booking form to display on the product page of your storefront.
1. In the app admin select Installation to begin the process.
2. After selecting the option for the type of bookings you will take you will select the Next button to continue the process. For this example we selected the Activity/Tour/Experiences option.
3. Here are a few brief notes regarding variants.
- Any option representing pricing should be done through variants.
- Do not enter the dates or times of the event as variants because you will create a schedule in the app.
- If you have a minimum party size requirement for your bookings you will want to create a set of variants for Party Size. An example of this would be a booking requirement for the minimum party size of 2 and a maximum party size of 7.
4. If you created your product in Shopify and imported it into the app choose Tour/Activity as the Profile. This is automatically done if you are creating your product through the app's Setup Wizard.
The remaining configuration steps are the same regardless of the method you used to create your products.
5. Enter the capacity of the event (max number of people permitted per time slot).
6. Choose to base capacity on Product, Variant, or Resource. In this example we want the event capacity to be based on product since there are no options for the customer to choose from.
7. Enter the Duration.
8. Modify the Count if needed. Normally this is not necessary.
9. Setup Seasonal Rates if needed. An example of this would be if you have a high and low season.
10. Select to hide any variants you do not want the booking calendar to appear on.
11. Set the Units value equal to the amount of attendees for each variant. As this product has no variants representing party size the Unit value should remain at 1.
12. Add a Location (if applicable). This will let you schedule by location and include the location's address in reminder emails.
13. Add a cutoff date or future date (if applicable)
14. If desired, choose a set of colours for the activity. This allows you to differentiate events by colour on the Booking Overview Calendar.
15. In the field under Sign Up List enter in email address where you want an enrollment report to be sent.
16. Create the schedule for your event:
- One off Dates: Use this option if your dates are random (ie. Jan 1, Feb 5, Mar 12)
- Repeat: Use this option if the class recurs on a regular basis. (ie. Every Monday at 6pm)
17. Hit Save.
The Events List widget can be used to allow your customers to choose the event date and time, and there are several settings available to change the way it works. The widget preview updates in real time so you can see the effect of the changes.
If you are using the Setup Wizard it will automatically walk you through the steps to configure and customize the widget. If you imported your product from Shopify you will need to complete the following steps.
- Access the widgets section of the app by selecting Widgets.
- Click Create widget and select the Events List Widget to enable it.
- In the Products tab of the widget you can choose to use this widget configuration for all your scheduled event products, or you can specify specific products.
- Widget Settings
- Name: You can have multiple Event List widgets with different settings so you can use the name field to describe what this widget is for.
- Mode: Determines how the widget appears in the product page. Inline or Popup option.
- Time Format: Enter the time format that you would like to use. Some options are:
- 12 hour clock: h:mm a
- 24 hour clock: H:mm
- Date Format: Enter the preferred date format. You can view a complete list of date variables in the following.
- Low Capacity Threshold: This determines when the text shown in the second column will change. The value is set to 4 for our widget. This means the capacity for an event must decrease to 4 in order for the number of remaining spaces to display.
- Max Months: This determines the number of months into the future the widget will pull events. The higher the value the more loading speed is impacted.
- Page Size: Sets the amount of events that will appear on the screen at one time.
- Show Booking Fields: Displays the additional fields created in the Booking Fields section of the app.
- Allow Choosing Location: Displays the location selector.
- Show Timezone Helper: Includes a timezone selector at the bottom of the widget.
- Show Price: Option to control if the price is shown or omitted within the widget.
- Use Swatches: Display variants using swatches instead of a drop-down selector.
- Allow Waitlist: Enables/disables the waitlist feature.
If you've completed the steps above you should now be able to visit the product page in your storefront and see the widget appear.