How to let visitors compare products or bookable items side by side (Item comparison)
In TeleportHQ, the Item comparison plugin lets the visitors of your store or booking site compare products or bookable items side by side. To switch it on, click Plugins in the editor's left sidebar, click Item comparison and turn on Item comparison enabled. E-commerce or Bookings must be on first. Visitors then press Compare beside an item's price, see their picks in a tray in the corner of every page, and open a Compare page at /compare that lines the items up in a table, with the best value tagged.
Before you start
- E-commerce or Bookings must be on. Item comparison compares your products, your bookable items, or both. See How to add a store to an existing project and How to add bookings to an existing project.
- The table compares what your items already have: their price, rating, brand, capacity and more, plus the details you give them as Custom Properties, for example
Material: Linenon a product orSize: 30 m²on a room. See How to add a product and How to add a bookable item.
Turn on Item comparison
- In the TeleportHQ editor, in the left sidebar, click Plugins.
- Under Search & discovery, click Item comparison ("Let visitors compare products or bookable items side by side."). To find it faster, type
comparein Search plugins.... Its settings open in a drawer beside the list. - Under Feature, click the Item comparison enabled switch. The Turn on Item comparison window opens.
- Read its three short steps (On every item, Tray and page, Settings) with Next, or click Skip.
- Click Turn on Item comparison.
If the window shows Use what your pages already have, your project already has a page that looks like a comparison, for example one named Compare. Keep its switch on to use that page: the plugin adds its comparison table to it instead of making a new page.
When it's done, a message lists what was added, and the Compare Page Ready window asks whether you want to see how Compare looks. Click Show the Page to open it on the canvas (a Back to Item comparison button above the canvas brings the settings back for a few seconds), or click Keep Editing. A card titled Item comparison is ready! also offers a short tour: click Show Me, or Maybe Later.
What Item comparison adds to your project
- A Compare button at the end of the price line of every product page and bookable item page, and of the cards on your shop's products page and your booking page. Pointing at it shows "Add to comparison".
- The Compare Tray component, in your Components list, in a folder named Item comparison. It shows on every page of your published site while a visitor compares items.
- The Compare page at
/compare, in your Pages list, in a folder named Item comparison, between your site's navigation and footer.
Choose what visitors compare
All the Item comparison settings are in its drawer: Plugins → Item comparison. They're greyed out until the plugin is on. Each change is saved as soon as you make it, and the canvas follows at once. Your live site gets it the next time you publish: "A publish brings the change to visitors."
What can be compared
- Kinds of items: tick Products ("Needs E-commerce"), Bookable items ("Needs Bookings"), or both. "A kind is offered only while its plugin is on." If only one of the two was on when you switched Item comparison on, the other kind joins this setting by itself once you switch its feature on; then click Add controls under Needs attention to give those items their Compare button.
- Compare from the listings too (on at first): puts the Compare button on the cards of your shop and your booking page too. Turn it off to keep it only on each item's own page.
- Items at once: how many items a visitor can compare together, from 2 to 6 (4 at first). The tray shows that many slots.
Comparison table
The Item comparison table has one column per item and one row per attribute you tick:
| Setting | What it does | At first |
|---|---|---|
| Product attributes | The rows for products: Price, Rating, Brand, Condition, Category, Tags, Weight, Dimensions, In stock and SKU | Price, Rating, Brand, Category, In stock |
| Product custom properties | Rows for your products' custom properties: Every custom property, The ones I pick or None | Every custom property |
| Bookable item attributes | The rows for bookable items: Price, Booked by, Capacity, Duration and Category | All five |
| Bookable item custom properties | The same, for your bookable items' custom properties | Every custom property |
| Highlight the best value | "The lowest price and the highest rating stand out." | On |
| Only differences | "Leaves out the rows where every compared item has the same value." | Off |
With The ones I pick, a list appears under it: Product properties compared (or Bookable item properties compared). Click it and tick the properties you want as rows, for example Material and Color. It lists the property names your items already have, and reads No properties chosen until you tick one. With Every custom property, a property you give an item later joins the table by itself.
Only the custom properties visitors can see become rows: on a product, the ones with Show on the product details page ticked; on a bookable item, the ones with Show to visitors ticked. A comparison shows up to 30 custom property rows.
What visitors see on your published site
The Compare button
On your TeleportHQ site, a visitor presses Compare beside an item's price. A short message says "Added to the comparison", and the button stays pressed. Pressing it again takes the item out: "Removed from the comparison".
- One kind at a time. A comparison holds products or bookable items, never both. If a visitor presses Compare on a bookable item while comparing products, the browser asks "Your comparison holds items of another kind. Start a new comparison with this one?"
- A limit. Once the comparison is full, the message says, for example, "You can compare up to 4 items. Remove one first."
- Kept in the visitor's browser. The picks are still there when the visitor comes back in the same browser. Nothing is saved in your project or your database.
The tray
While a visitor compares items on your TeleportHQ site, the tray stands in the bottom-right corner of every page, with:
- the picture of each picked item, with an ✕ to take it out, and an empty slot for each place left;
- the count, for example
2 picked; - Compare, which opens the comparison page once two items are picked ("Pick one more" before that);
- Clear, which empties the comparison;
- a fold button that folds the tray into a round button with the count. Clicking the round button opens the tray again.
On a phone, the tray lies along the bottom of the screen and starts folded. It never shows on the comparison page, the cart or the checkout.
The comparison page
The Compare page of your TeleportHQ site opens with the heading Compare, the line "The items you picked, side by side. Press Compare on any item to add it here." and a Clear all button. Below it:
- One column per item: its picture, its name (a link to its own page) and Remove.
- One row per attribute, then one row per custom property. A dash (—) stands where an item has no value, and a row that no compared item has is left out.
- A Best tag on the best value of a row: the lowest Price, the highest Rating, In stock over out of stock and, for bookable items, the highest Capacity. A row where every item says the same gets no tag.
- The price a shopper sees on the card. A product is compared at the price its card shows; for a product with variants, that's the price of the variant its card shows.
On a narrow screen, the table scrolls sideways and the row names stay in view. With nothing picked, the page says "Nothing to compare yet. Press Compare on the items you want side by side." with a Browse button that leads to your products page, or to your booking page when bookable items are the only kind compared.
Preview the comparison in the editor (the Compare pill)
You don't need to publish to see the comparison filled. In the TeleportHQ editor, the Compare pill above the canvas fills the comparison page and the tray with your own items:
- In the Pages list, open the Item comparison folder and click Compare. The pill also shows on your products page, your product pages, your booking page, your bookable item pages and the Compare Tray component.
- Above the canvas, at the top left, click Compare. The Compare simulator opens, listing your Products and Bookable items.
Next to a product, click Compare. Click Compare next to a second product. The comparison page on the canvas fills with them, and the pill shows how many you picked.
The simulator counts your picks against the limit, for example 2 / 4. Click Remove next to an item to take it out, or Clear to start again. The picks are only for the editor ("Your visitors’ own picks stay in their browser."), and reloading the editor forgets them.
On the Compare Tray component's canvas, a switch above the tray shows it Open or Folded, the round button a phone shows first.
Restyle the button, the tray and the comparison page
Everything Item comparison adds is part of your TeleportHQ project, so you edit it like any page or component. It starts in your site's colors and button style.
- The Compare button: select it on a product card or page, and change it in the right panel.
- The tray: in the Components list, open the Item comparison folder and click Compare Tray. A note above the canvas says "Your compare tray: it docks on every page while a visitor compares items."
- The comparison page: in the Pages list, open the Item comparison folder and click Compare. Change the heading's words, the colors and the spacing. Above the canvas, Plugin settings opens the plugin's drawer, and How it works plays the tour.
Keep the buttons the plugin built (Compare, Remove, Clear and Clear all): your published site makes them work. If you delete the page, the tray or a card's Compare button, the drawer's Needs attention section offers to add it back.
Turn Item comparison off
- In the TeleportHQ editor, in the left sidebar, click Plugins, then click Item comparison.
- Click the Item comparison enabled switch. The Disable Item comparison window says "This removes the Compare controls, the Compare Tray component and the /compare page from the project. Nothing in your data changes."
- Click Disable Item comparison. The message "Item comparison has been disabled." appears.
A page of yours that the plugin used as its comparison page stays; only the comparison table leaves it. Publish your site to take the comparison off your live site too.
Check that it worked
In the editor, the Plugins list shows Item comparison with On, the cards on your products page show a Compare button at the end of the price line, and the Pages list has an Item comparison folder with Compare. On your published site (publish first), press Compare on two products: the tray shows 2 picked, and its Compare button opens the side-by-side table.
Troubleshooting
The Item comparison row says "Needs E-commerce or Bookings", and its switch is greyed out The drawer says "Item comparison works on what E-commerce or Bookings offer. Switch one of them on first." Click Open E-commerce under the switch to open the E-commerce drawer and switch the store on, or switch on Bookings instead.
"products cannot be compared" or "bookable items cannot be compared" under Needs attention That kind is ticked in Kinds of items, but its feature (E-commerce or Bookings) is off. Switch the feature on, or click Show setting and untick the kind.
"A card lacks its Compare control" (or, for example, "3 cards lack their Compare control") A card or page shows an item without a Compare button: a card added later, or a kind you switched on later. Click Add controls.
"The comparison page is missing" or "The compare tray is missing" The page or the tray was deleted. Click Add page or Add tray.
"The comparison page has no rows for custom properties yet", "The comparison page’s heading is not in your pages’ style yet", "The compare tray cannot fold yet" or "The compare tray lies across the page" The page or the tray was built by an earlier version of Item comparison. Click Add the rows, Refresh the heading or Rebuild the tray. Rebuild the tray also puts the tray's words and looks back to the plugin's.
A custom property is missing from the table Check that the property has a value and is visible (Show on the product details page on a product, Show to visitors on a bookable item), that Product custom properties or Bookable item custom properties isn't set to None, and, with The ones I pick, that the property is ticked.
The tray has no Compare button It shows once two items are picked. With one item, the tray says "Pick one more".
Visitors don't see a change I made Settings and design changes reach your live site with the next publish. See How to publish your site.
Good to know
- Items booked by night or by day show
1 hin the Duration row. Duration is the length of an item booked by time. To compare rooms or rentals, untick Duration under Bookable item attributes. - The AI Assistant can switch Item comparison on and change its settings when you ask, for example "allow comparing up to 3 products".