> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kwebby.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Spin wheel

> A prize wheel that reveals one of your own discount codes, with every prize and its odds listed. Off on install.

![Spin wheel on the storefront](https://mintcdn.com/kwebby/Y7lUE3PaLXfHjaRp/images/vesper/spin-wheel.webp?fit=max\&auto=format\&n=Y7lUE3PaLXfHjaRp\&q=85\&s=c68fffac8d0b834eb99d57125d251b1b)

Spin wheel, highlighted with the demo content

## Where to find it

The Overlays group. In the theme editor open any page, find Spin wheel under Overlays in the sidebar, and turn on Enable spin wheel. It ships both hidden and turned off.

## How it works

* Each Prize block is one segment with a label, a discount code you created in Discounts, and a weight. The odds of a prize are its weight divided by the total of all weights.
* The wheel lists every prize with its odds under Prizes and odds, and links your terms page there.
* A Segment without a prize block adds a turn that wins nothing. It is listed with its odds, and the wheel stops saying every turn wins.
* The wheel opens from a tab on the left edge, from links in the menu drawer and footer, or by itself after a delay you set. It never opens by itself on the cart, account, contact or password pages.
* One spin per visitor every Show again after days (30 by default). It does not open by itself again in that time if the visitor spun or closed it.
* Asking for an email is optional. An address is sent to Customers only when the visitor ticks the consent box, which is never ticked in advance.
* The code shows with a Copy button. The theme does not email the code.

![Spin wheel in the theme editor](https://mintcdn.com/kwebby/ipMVAv6ECVUC3DoM/images/vesper/editor-spin-wheel.webp?fit=max\&auto=format\&n=ipMVAv6ECVUC3DoM\&q=85\&s=4e49a75bddcdffd33712cf567e03f094)

In the theme editor: 1 Spin wheel, under Overlays · 2 its settings. While it is selected, the wheel opens in the preview.

## Edit it

* Create each code in Discounts first, with an end date and one use per customer.
* Add a Prize block per code (2 to 8 segments in all) with a short label such as 10% off, the code exactly as created, and a weight.
* Choose a Terms of the offer page with the rules of each prize.
* Set Open by itself after (0 opens it only from the tab and links) and Show again after.
* Turn on Require an email address only where that is lawful, and edit the consent label.
* Tick Enable spin wheel, then show the section with the eye icon in the sidebar.

## Settings

> [!TIP]
>
> Reveals one of your own discount codes. Create each code first in Discounts, with an end date and one use per customer. The theme never creates or checks codes, and anyone can read them in the page source, so treat them as public.

| Setting | What it does |
| - | - |
| **Enable spin wheel** | On or off. Needs at least two segments and one prize with a code. Default: off. |

**Opening**

| Setting | What it does |
| - | - |
| **Show tab on the left** | On or off. A slim star below 1200 px. On phones it shows only over the first screen of pages with a hero film. The menu and footer can also link to the wheel. Default: on. |
| **Tab label** | Text. Default: A gift from the salon. |
| **Open by itself after** | Slider from 0 to 120 s, in steps of 15. 0 opens it only from the tab and links. Never opens by itself on cart, account, contact or password pages. Default: 0 s. |
| **Show again after** | Slider from 1 to 90 d. Days before a visitor who spun or closed the wheel can spin again, or sees it open by itself again. Default: 30 d. |

**Content**

| Setting | What it does |
| - | - |
| **Label above the title** | Text. Default: The salon. |
| **Title** | Text. Default: A gift from the salon. |
| **Note under the code** | Text. Default: Enter the code at checkout. One code per guest. |
| **Terms of the offer** | Choose a page. A page with the rules of each prize: end date, minimum spend and one use per customer. Linked under Prizes and odds. |

**Email**

| Setting | What it does |
| - | - |
| **Require an email address** | On or off. Shopify's customer form subscribes every address it receives, so the wheel sends an address only when the visitor ticks the consent box. With this on, visitors must give an address and tick the box to spin. Check this is allowed where you sell. Addresses are tagged spin-wheel in Customers. Default: off. |
| **Consent checkbox label** | Text. Never ticked in advance. Leave empty for the default wording. |
| **Color scheme** | Color scheme for this area (edit the schemes in Theme settings → Colors). Default: Scheme 1. |

## Blocks

Up to 8 blocks. Add a block with **Add block** under the section in the sidebar; drag blocks to reorder them.

### Prize

| Setting | What it does |
| - | - |
| **Label on the wheel** | Text. Short, up to about 16 characters, for example 10% off. |
| **Discount code** | Text. Exactly as created in Discounts. |
| **Weight** | Slider from 1 to 100. Sets the odds: this weight divided by the total of all weights. The wheel lists every chance. Default: 10. |

### Segment without a prize

> [!TIP]
>
> Optional. A turn that lands here wins nothing. It is listed with its odds, and the wheel stops saying every turn wins.

| Setting | What it does |
| - | - |
| **Label on the wheel** | Text. Default: Next time. |
| **Weight** | Slider from 1 to 100. Default: 10. |

> [!NOTE]
>
> Codes are in the page source, so treat them as public. See [Spin wheel](https://docs.kwebby.com/gloaming/guides/spin-wheel.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.