Set up Clasp's metafields and tags
Chapter 7 of the Clasp user guide.
Clasp's material badges, stack layers and per-product engraving surfaces read metafields in the custom namespace, the one Shopify admin uses when you create a definition. Three product tags add badges. You don't need an app, and you only need the data for the features you use: every feature hides when its data is empty, or falls back to its section or block settings, so nothing breaks while you fill them in. Metals, stones and ring sizes need no metafields at all: they come from your product options (chapters 8 and 9).
What Clasp reads
| Name (yours to choose) | Namespace and key | Owner | Type | Example | What it does |
|---|---|---|---|---|---|
| Materials | custom.materials | Product | Single line text, List of values | 14k gold fill · Nickel free · Hypoallergenic | One material badge per entry under the price (chapter 8), and the Materials row on the compare page |
| Stack image | custom.stack_image | Product | File (images), one value | sienna-band-stack.png | The piece's layer on the stack builder's display (chapter 11) |
| Stack image | custom.stack_image | Variant | File (images), one value | sienna-band-rose-gold-stack.png | The layer for that variant, such as the band in rose gold; it wins over the product's, so the stack shows the metal the shopper chose |
| Engraving image | custom.engraving_image | Product | File (images), one value | sienna-band-inside.jpg | The engraving surface in the engraving preview (chapter 10), instead of the block's image |
| Engraving area | custom.engraving_area | Product | Single line text, one value | 50, 42, 46, 0, 30 | Where the engraving sits on that surface: across %, down %, width %, rotation in degrees and curve (chapter 10), instead of the block's settings |
And these product tags (capitals don't matter):
| Tag | What it does |
|---|---|
new | A New badge, whatever the product's publish date. Without the tag, products get the badge for Theme settings › Product cards › New badge for products published within days (21) after they're published. |
engravable | An Engravable badge on cards and on the product photo. The tag is set in Theme settings › Product cards › Engravable badge tag ("engravable" by default; blank hides the badge). It also decides which products offer engraving: with Theme settings › Jewelry › Show engraving only on products tagged engravable on (the default), only products with the tag show the Engraving block (chapter 10). |
pre-order or preorder | A Pre-order badge on cards and on the product photo. The stock line, the add button and the cart property come from the Product section's pre-order settings instead (chapter 6). |
Clasp reads no metal tags: a product's metals come from its options. If you want "Shop by metal" collections, make them automated collections with a condition of your choice (a product tag such as metal-gold, for example) and link the Collections section's tiles to them.
Two more are filled in by review apps, not by you: reviews.rating and reviews.rating_count give the stars and "4.9 · 212 reviews" in the Rating block. And a Spec row (chapter 6) can show any metafield you create, such as specs.band_width.
Step 1: create the product metafield definitions
In admin, go to Settings › Custom data › Products and click Add definition for each metafield you need:
- Type the Name (yours to choose; it's what you see when you edit a product).
- Check the Namespace and key under it and change it to exactly the key in the table above. Shopify suggests
custom.plus the name, so "Stack image" givescustom.stack_image, but "Stack photo" would givecustom.stack_photo, which the theme won't find. Keys are case-sensitive. - Click Select type and choose the type in the table:
- Materials: Single line text, then List of values. A single line text with One value shows as one badge, commas and all.
- Stack image and Engraving image: File, One value. Limit it to images if you like.
- Engraving area: Single line text, One value.
- Save.
Step 2: create the variant metafield definition (optional)
Only for stack images per metal. Go to Settings › Custom data › Variants, click Add definition, name it "Stack image", set the Namespace and key to exactly custom.stack_image, choose File, One value, and Save. A variant without one uses the product's stack image.
Step 3: fill them in
Open a product in admin and scroll to Metafields: every product definition you created is listed there. Add each material as its own entry, and upload the stack image and engraving image. For a variant's stack image, open the variant (click it in the product's Variants list) and fill its Metafields. To fill many products at once, use Bulk edit from the products list and add the metafield columns. Add the new, engravable and pre-order tags in the product's Tags field.
How the theme reads what you type
- Materials shows each entry as a badge, in your order, up to the Material badges block's Badges to show (4). Keep them short: "14k gold fill", "Recycled sterling silver", "Nickel free".
- Stack image is drawn on the display at the size set by the stack builder's Piece size on the base, centred on its slot. Use a transparent PNG of the piece alone, cropped tight, at least 800px wide, photographed as it sits on your display: for rings, as the lowest ring on your ring cone or stand; for charms, the charm alone (chapter 11).
- Engraving image is shown in a small oval, so use a close photo of the surface you engrave: the inside of a band seen from above, or the face of a pendant.
- Engraving area is up to five numbers separated by commas, in this order: across (the text's centre from the image's left edge, 0 to 100%), down (from the top edge, 0 to 100%), width (the engraving area's width, 10 to 100% of the image), rotation (−45 to 45 degrees) and curve (0 for a straight line, up to 100 for a strong arc, for the inside of a band). The first three are needed; leave off the last two to use the block's Rotation and Curve (for the inside of a band). Anything that isn't at least three numbers uses the block's settings.
What shows without the data
| Missing | What happens |
|---|---|
| Materials | The Material badges block's Materials text, if you typed one; otherwise no badges and no gap |
| Stack image (product and variant) | The piece still joins the stack, as a small thumbnail under the display ("Also in your stack") instead of a layer |
| Engraving image | The Engraving block's Engraving surface, then the product's first image |
| Engraving area | The Engraving block's Text position across, Text position down, Engraving area width, Rotation and Curve (for the inside of a band) |
In the theme editor, features with no data show a sample tagged Sample so you can see the design: three sample material badges, a sample ring size row on products without a ring size option, the engraving block opened with its sample text, and a sample stack. Shoppers never see them.
Settings you type into a block on the product template (the Material badges Materials text, the Engraving block's surface and area) show on every product that uses this template. Use them for a catalog where most products are alike, or on a template you make for those products (in the theme editor, Create template from the product template and assign it to those products in admin). For a mixed catalog, use the metafields.