3D Jewelry Designer

Embed a 3D viewer or ring builder

Save a design as a project, then in Dashboard → Embeds publish it as either a Ring Builder (a live 3D configurator with options, SKU, price and add to cart) or a Media Only set (a 360 hero plus captured stills that replace your product photos). You choose which when you create it, and you can convert later without losing anything.

3D Jewelry Designer28 min read

Two kinds of embed

In Dashboard → Embeds you publish either a Ring Builder (a live 3D configurator shoppers use on your store: options, live SKU + price, add to cart) or a Media Only set (a 360° hero plus captured still shots that replace your product photos; no options, no cart). You choose which when you create it, and you can convert later. Nothing is deleted, so converting back restores exactly what was there.

A third kind, Try it on you, puts every ring on your product grid onto one photo of the shopper's own hand. It has its own section on the same page and its own settings. A fourth, the Carat sizer, shows a diamond page's stone at its true size on a hand, and a Complete look lets shoppers put a whole set together and see it on a model (both below). A Showroom runs your builder on an iPad or touch screen in your shop.

A fifth, a Saved design, publishes one of your projects as an interactive 3D viewer, with no options or cart. Over the API, GET /api/public/embeds lists your saved-design embeds and POST /api/public/embeds publishes a project as one, within your plan's embeds (scopes embeds:read and embeds:write). In GraphQL use embeds(type: "viewer") and createEmbed; the SDK has embeds.list() and embeds.create().

Ring Builder embeds

Publish a live interactive 3D configurator customers can build right on your store: a real-time WebGL ring they drag to rotate, with instant option switching (every published part is warmed up front) and instant metal/gem swaps. Control the default ring, allowed metals, the AR try-on, live SKU + price and an "add to cart" button.

One page, guided steps or one scroll

Layout → Shopper flow sets how the options are paced:

  • One page, where new builders start: the options as five numbered decisions beside the live 3D, Setting, Metal, Shape, Centre stone and Finishing touches (the ring size, engraving and, when you offer them, matching bands). Each decision shows only what the chosen design has. The design gallery opens from Your design, never on its own, so nothing covers the page.
  • Guided steps: Design, Diamond and Review, opening on the design gallery.
  • One scroll: every option in a single panel.

Builders made earlier keep their flow until you pick another.

With Carry the ring in your page's address on (Layout → Shopper flow; new builders start with it on), your store page's address names the ring as it is built, for example ?setting=85164&metal=18k-white-gold&shape=round&carat=1.25, with a sealed link that reopens the exact build. Any ring can then be shared, bookmarked or linked from an ad; a link with those words and no sealed link opens the closest ring. It needs ring-builder.js 2.14 or later on the page.

In the Centre stone decision, a store whose quality tiers include both kinds asks Natural or Lab-grown first, then shows that kind's tiers. Where the price breakup shows the stone, each carat shows the whole ring's price. Or start with a diamond, under Setting, opens the diamond finder first, and the finder shows three stones recommended for the setting's shape and carat above the full list.

Ready-made layouts

The Layout button beside Themes in the editor (and at the top of the Layout pane) offers six ready-made layouts. A layout sets only how the builder is laid out: its steps, how it opens, where the choices sit, the step bar, the panel's header and what the Diamond step shows first. Your colours, fonts, prices and options stay as they are, so any layout works with any theme. Preview shows one on the editor's stage and saves nothing; Use puts it in your draft, and shoppers see it when you publish.

  • Three steps: the setting gallery first, then the diamond, then Review, under a bar across the top that shows each choice with its picture, its price and Change. With live diamonds the diamond finder opens the first time the shopper reaches the diamond.
  • One page: every choice on one scrolling panel beside a large ring view, with the quality tiers and their prices, and the total and Add to cart always in view.
  • Diamond first: the diamond finder first, with photos and filters, then the settings that hold that stone (the design gallery opens on its shape and carat), then Review. A store without diamonds or quality tiers opens on the design gallery instead.
  • Product page: reads like your own product pages. The ring's name, your rating (when you show one) and the price at the top, compact rows of choices, the size and engraving, Add to cart, then the ring's details and its price breakdown in folds. No step bar.
  • Showcase: a full-width ring view with the choices in rows beneath it, and the design gallery opening over it.
  • Sidebar: the builder as it has always been, the ring beside guided steps that open on the design gallery. A builder that picks no layout shows this.

Builders made before layouts look exactly as they did until you use one. The Layout pane holds the same parts one at a time (How it opens with The diamond first, Step bar, The Diamond step opens on and Panel header), so you can fine-tune the layout you picked. A theme with a designed page keeps its own blocks; a layout sets its pacing.

Over the API, GET /api/public/ring-builder/layouts lists the six (ringBuilderLayouts in GraphQL, ringBuilder.layouts() in the SDK). Put one in a theme's draft with PATCH /api/public/ring-builder/embeds/{id}/themes/{themeId} and { "layout": "three-steps" } (updateRingBuilderTheme with patch: { layout }, ringBuilder.themes.update in the SDK), then publish. Each theme's layout says which one its look is, or null for a layout of its own.

Talk to us, the ring size and the ring's name

Under Pricing & checkout, Talk to us puts a button beside Add to cart that opens your booking page, WhatsApp, chat, e-mail (mailto:) or phone (tel:) link. Leave the link empty for no button. Ask for the ring size first makes Add to cart wait for a size: until the shopper picks one, the button takes them to the size picker and asks them to pick a size. New builders start with it on. On one page, the line above the total names the ring as it is built: the design, metal, stone and quality. Below it, Ships by gives a date counted in business days from Ships within (Conversion → Trust & reviews, 0 hides it), with your trust badges beside it, and the print button makes a spec sheet: the ring as it is on screen, every choice, its weight and stones, and the total. Engraving shows its price in its title.

Quick options on the stage

Switch on Quick options on the stage and the product's own metal and shape swatches sit on the 3D view itself, by default in a slim rail on the left edge (you can move it to the right edge or above the view buttons under Features → Quick options). The rail shows the current metal and shape as pictures; tapping one opens every choice (beside the rail on a computer, or in a low tray under the ring on a phone, where the rail is smaller and slides behind a small arrow at the edge when it is not in use; shoppers can hide it themselves too), using the same metal and diamond pictures your configurator uses.

Metals are shown as colour + karat (White, Yellow, Rose, Platinum and a 9K / 14K / 18K switch), only the ones that can actually be bought, with what each choice adds or takes off the price when your theme sends its prices. Every karat is shown in its 18K colour, and Platinum in the same finish as white gold, just as your product photos show them. On a computer, resting the mouse on a metal previews it on the ring before it is chosen.

The choices put themselves away after 5 seconds unused, when the shopper touches the ring, or when the 3D scrolls out of view. You choose whether it shows on phones and on computers, and whether it starts open on each, in every view, including while the shopper is wearing it in try-on. Its opens and picks appear on the embed's Analytics page. A pick changes the ring instantly and selects the matching store variant, so the price and the cart follow; your page's own swatches stay and stay in sync. Your theme tells the embed what that product can be built as; see the install recipe.

Compare rings

Switch on Compare rings (Conversion tab, under Save & share) and the builder gets a Compare button beside Save. It opens the ring on screen next to up to three rings the shopper set aside, each with its picture, today's price and every choice by name; a row where the rings part says Differs. Add to compare sets the current ring aside (a fourth replaces the oldest), and Open this ring brings a saved one back into the builder. The rings are kept in the shopper's own browser, so nothing reaches you until they save, enquire or add to cart. A headless storefront gets the same answer from POST /api/public/ring-builder/compare (or ringCompare in GraphQL).

Add to cart and orders on the Analytics page

When a shopper adds the product to the cart with your theme's own button, the embed on that page counts it under Add to cart. The theme snippet passes the click to the embed and marks the cart line with the embed and the shopper's session, in hidden line properties (_3jd_embed, _3jd_session) that shoppers do not see and your order admin does.

With your store connected through the Shopify app, each order that carries those properties appears under Orders, with the amount of the lines the embed sold (not the whole order). Older orders that only carry the "View in 3D" link are matched from that link. Orders paid in the builder's own checkout count there too.

The shopper journey

A ring builder's Analytics page shows where shoppers go, counted in visits: how many opened the builder, changed the ring, saved it, asked about it or added it to the cart, and ordered, each as a share of the step before. The step that keeps the fewest shoppers is marked Biggest drop. Beside it you see how many tried the ring on, turned or zoomed it, how long the first ring took to show, how often the 3D view could not run, and visits by phone, tablet and computer.

What to look at lists what stands out, each with the numbers and one thing to try, for example when few visitors on phones change the ring compared with those on computers. It says what was counted, not why. Notes start once a period has 200 visits. Whole builds lists the complete rings shoppers saved or carted most and the ones that sold most.

Install in one line

Copy a ready Shopify / WooCommerce / Wix / custom recipe under Install on your store, or drop in the raw iframe / JS loader (RMJRingBuilder.mount(...)). "Add to cart" emits an authoritative quote (server-recomputed SKU + price + a quoteId you can trust) plus the full selection, so you wire it to any cart.

Height. A builder set to Fit content (Layout → Frame height; new builders start with it) reports its own height and the frame follows it, with the plain iframe code as well as the script, so your page scrolls once. Fill the frame keeps the height your page gives it. The height in the Shopify block and in the WooCommerce settings is the starting height.

Finish setting up on the Overview asks how your store is built (Shopify, WooCommerce, Wix or Squarespace, your own website, or no online store yet), and the install guides then open on that recipe first. You can change the answer there at any time.

Need a build-your-own UI instead of the widget? Use the API: the published catalog via GET /api/public/ring-builder/catalog and authoritative quotes from POST /api/public/ring-builder/quotes (or ringQuote). The developer reference lists both.

Launch checklist

The bar at the top of a ring builder's editor rail shows how much of it is ready. Click it for the Launch checklist: each line says what is missing and opens the setting that fixes it.

  • Store connected: a Shopify cart mode (Match, Mint, Create or Draft) needs your Shopify store connected, and the line opens the Shopify page in a new tab. Hosted checkout, your own cart and enquiry-only builders need no connection.
  • Default ring chosen and Steps visible: the ring the builder opens on, with the band step showing.
  • Your prices: done once the builder's price book sets its prices, as a list, a formula or your Shopify prices. Until then the builder prices from 3JD's catalogue.
  • Diamonds: what shoppers choose from, live diamonds from the partner feed, your own quality tiers or 3JD's.
  • Add to cart wired: a cart mode set under Pricing & checkout, so a build reaches your cart on its own.
  • On your store: done once the builder has opened on a page of your store through ring-builder.js, which the Shopify app block and the WooCommerce plugin load. The line names the store address and when. A plain iframe, or the script with inheritStyles: false, doesn't report the page.
  • Live orders: test mode is off.
  • Embed is live: the builder isn't paused.

The list checks again when you come back to the tab, so a store you connected in another tab shows at once. GET /api/public/ring-builder/embeds/{id}/readiness returns the same checks (ringBuilderReadiness in GraphQL, ringBuilder.readiness in the SDK).

Set up step by step

A new ring builder opens on Set up your ring builder, eight short steps: your store, the default ring, your prices, diamonds, the look, adding it to your store, a test order and going live. Each step shows its lines of the launch checklist.

  • Your store asks how your store is built, the same question as Finish setting up on the Overview: a Shopify store gets a Shopify cart mode (matched to your variants by SKU), WooCommerce, Wix or Squarespace and your own website the add-to-cart event, and no online store takes enquiries.
  • Test order turns test mode on, and Go live turns it off and switches a paused builder on.
  • Each choice is saved as you make it (in the theme editor it goes into the draft, and reaches your store when you publish). Skip any step. A step whose setting is in the editor (the default ring, Appearance, the install options) opens it, and Continue setup under the top bar brings you back.
  • Prices and diamonds open the pricing console in a new tab; the step follows when you come back.

Set up step by step in the launch checklist opens it again on the first step that has something left to do. Set up a ring builder walks through each step.

Views on the stage: 3D, On model, In box

Under Hand and box (both embed kinds) switch on the On model and In box buttons, and shoppers then tap a pill on the 3D view itself to swap between 3D view (the turnable ring), On model (the model hand, with a skin-tone picker) and In box, without leaving the builder. In box uses the embed's own tone mapping and exposure, so the metal matches the 3D view.

There are no zoom or play buttons on the stage: shoppers pinch to zoom on a phone and scroll to zoom on a computer once they have clicked the ring (a scroll that merely passes over the ring still moves the page), a finger dragged up or down over the ring scrolls the page while a sideways drag turns it, and while a turn or a pinch is under way the page holds still, iPhone included. The full view button fills the screen on every phone (on iPhone, which has no fullscreen for pages, the store page expands the 3D frame instead); there an up/down drag tilts the ring. The turntable pauses while the ring is held and resumes a few seconds after it is let go.

The tab reads On model, not "On hand": beside a Try on that means the shopper's OWN hand, "on hand" read as the same offer twice. Those three are views, so they keep the strip to themselves. Try on is an action, so it sits apart in the stage's top-left corner, stacked under your logo if you have one: nothing near your watermark, and no one mistaking it for a fourth view.

It reads the shopper's device: with a camera it shows Try on; with none (a desktop tower, or a frame that blocks the camera) it shows On phone instead, a QR that opens the same ring on their phone. On a desktop both appear together; on a phone-sized screen the QR never does, since they are already holding the phone.

The Materials and Branding tabs are available on a Media Only embed too, where they set the metal and gemstone every still is rendered in, plus your accent colour and logo. Your accent colour also paints the try-on itself (the mode pills, buttons and pickers inside it), so shoppers never jump from your colours into ours; leave it unset and try-on keeps the default theme.

Media Only embeds

Pick the camera angles (and the On hand / In box showcase views) in Media tiles, set hero behaviour in Hero and views (interactive 360 or a locked angle, caption, share, zoom), then paste one line, RMJRingBuilder.mountMedia(...), where your product photos are; the loader hides your existing gallery on mount and restores it if 3D cannot start. Install and embed runs a real test capture so you can watch the actual stills come back before going live. The stills are rendered with the embed's own render settings, effects included, so they match the live 360 view.

A Media Only embed only ever shows the ring the product page asks for. When that design is not in your catalogue, the loader brings your own gallery back. When the design is there but the page's combination is not (a shape or carat it isn't made in), the 3D view shows Not found instead of the nearest ring, and no still is taken for it. Once the shopper picks a variant that exists, the ring comes back.

A product page can also say what kind of jewelry it sells. A wedding band's page passes its category and design number, for example type=wedding_band&design=50924, with the band's own options such as width=6mm, and the embed shows that design's band in that width. A ring and its matching band often share a number, so the category is what keeps them apart: a page that names no category is a ring page and only ever shows rings. When several rings share one band file, a band page for any of them shows the band made to match that ring. When nothing matches, the 3D view shows Not found, never a ring with the same number. Wedding bands show once they are on in Ring Catalog → Setup → Builder types.

With Features → Matching bands on the product page on, a ring's product page offers the band made to match it: an Add the matching band button floats at the bottom of the 3D view. A tap stacks the band beside the ring; the button then reads Matching band added with a small × that takes the band off again. Under it the button shows the band's width and, once Dashboard → Shopify → Products has matched your wedding bands, your band product's own name and your price for it in the ring's metal. It never shows the band's SKU. Your page can also put the band on by itself: add matching=1 to the 3D view's address for the ring's first matching band, or matching= and a band's SKU, slug or name for that band (for example /embed/YOUR_SLUG?mode=view&controls=1&matching=1). Your page is told which bands are on (see the SDK's onLook), so it can show or sell each band's own product. A band that is on shows in every view (the 3D view, On model, In box and try-on) and in the photos beside the 3D view, which are taken again with it. It stays when the shopper changes the ring's options on your page, in the ring's new metal, and comes off only when your page shows a ring it isn't made to match. The switch shows once wedding bands are on, and a ring offers only the published bands made to match it.

Diamond carat sizer

A Carat sizer is an embed of its own: in Dashboard → Embeds, choose Carat sizer under Create an embed. On a diamond page it shows that page's stone at its true size in your own ring on a 3D hand, with carat chips to compare (the page's stone first, as Yours). The hand never turns by itself: it opens facing the shopper, or at the angle and zoom you set, and shoppers can turn and zoom it but not move it aside. The ring's head follows the stone: a carat your design has no head for is drawn at its true size, and with Offer shapes on, shoppers can pick only the shapes your design is made in. A row of carats or shapes too long for the frame gets an arrow at each end. It fills its frame, which is square on the page unless you set another shape, so nothing is cut off on a phone or a wide screen. A new sizer starts with the look and default ring of your newest Ring Builder or Media Only embed.

Its editor has the Carat sizer pane (the carats, shapes and the hand's skin tones), then Default ring (the ring the stone sits in), Materials (its metal and the stone's gem), Appearance (the lighting, the background behind the hand and the Opening view: turn on Face the shopper, or turn it off and set the angle and zoom, or turn the preview and press Use this view), Branding and Install & embed. Then put this on each diamond page, with that page's stone filled in:

<div data-3jd-carat-sizer data-sizer="YOUR_SIZER_ID"
     data-shape="emerald" data-carat="1.08" data-mm="7.18 x 5.13 x 3.40"></div>
<script src="https://3djewelrydesigner.com/carat-sizer.js" defer></script>

data-mm is the stone's certificate measurements; without them the size comes from average proportions for the shape and carat. The ring is the sizer's default unless the page names one: data-sku (your own variant SKU) or data-band (one of your designs). Its metal and centre stone colour are the sizer's Materials unless the page names them: data-metal (white, yellow, rose or platinum, with a karat if you like, such as 14k yellow, or 14k_rose_gold in an address; the nearest metal the ring is sold in is shown) and data-gem (white, yellow, pink, blue, green, champagne, black, sapphire, ruby or emerald, or a gem id). Every other setting can be changed the same way (data-carats, data-tones, data-controls, data-accent), or in the frame's own address at /embed/YOUR_SIZER_ID. data-ratio (for example 4/3) or data-height gives the frame another shape. TJDCaratSizer.update(el, { carat: 1.5 }) changes a sizer without reloading it. Over the API, a sizer is an embed with surface: "sizer", its settings are sizer in its config, and GET /api/public/diamonds/size (or diamondSize in GraphQL) gives a stone's size in mm. Sizers already installed with a ring builder's ID (data-embed) keep working.

Complete look

A Complete look is an embed of its own: in Dashboard → Embeds, choose Complete look under Create an embed. Shoppers choose one design for each piece of a set (a ring, a wedding band, earrings, a pendant, a necklace and a bracelet), all in one metal, and see the whole set on the model. The Face & neck view wears the earrings, pendant and necklace; the Hand view wears the ring with its wedding band on the ring finger and the bracelet on the wrist. Picking a piece turns the model to the view that wears it. On a wide screen the model sits beside the pickers; on a phone, above them.

Its editor has the Pieces pane (which pieces shoppers fill, the view the look opens on and the model's skin tones), then Default ring (the ring it starts with), Materials (the metals shoppers choose from), Branding (its accent colour) and Install & embed. Rings and wedding bands come from the catalogue your ring builder sells; earrings, pendants, necklaces and bracelets are the catalogue's published designs. A new look starts with the look and default ring of your newest Ring Builder or Media Only embed. Put it on any page with one frame:

<iframe src="https://3djewelrydesigner.com/embed/YOUR_LOOK_ID" width="100%" height="720"
  style="border:0;border-radius:16px" title="Complete look"></iframe>

In the Pieces pane, Starts with sets the design each piece shows first (or leaves it empty), and Ready-made looks saves up to eight named looks, each with its pieces and, if you like, its metal. Shoppers put one on with a tap, then change any piece.

Shoppers buy a look with Request this look: they leave their name and an email or phone, and you get the whole look as one order request in Leads, by email and through your webhook. The ring and wedding band are priced by our server as in your ring builder, and the look shows their price; the earrings, pendant, necklace and bracelet come with it for you to price when you confirm.

In the Hand view, Try it on opens the camera with the ring, its wedding band and the bracelet on the shopper's own hand at once. In the Face & neck view it opens the front camera with the earrings, the pendant and the necklace on the shopper at once, and Save picture keeps a photo of the whole look. Both show when your plan and the look's settings allow try-on, and the camera picture stays on the shopper's device.

Add ?view=face or ?view=hand to the address to open on that view. Over the API, a complete look is an embed with surface: "look", and its pieces, starting designs, ready-made looks and opening view are look in its config.

Look like my store

On a Ring Builder embed's Appearance tab, Look like my store makes the builder take the look of the store page it sits on, by itself, every time it loads: the font of your text and of your headings, with the font files your pages load and their Google Fonts, Adobe Fonts or Shopify font stylesheets; your page and text colours; your button colour as the builder's accent; and your buttons' corners, capitals, letter spacing and weight. New builders start with it on. It needs ring-builder.js 2.17 or later on the page, which the Shopify app block and section load for you.

Once it has seen your store, the builder opens in the look it last saw there, so it doesn't show its own look first, and fades to what the page shows as it loads. When your store switches to a dark look, the builder follows.

What you set yourself still wins: an accent colour under Branding, and the colours, fonts and button shape under Colours and type. A colour that would be hard to read is left out: page and text colours too close to each other, or a button colour that would be hard to see on the builder's panels. Your buttons' label colour stays when it reads on the button; otherwise the builder uses white or near-black, whichever reads. Under the switch, the editor shows what it last saw on your store and anything it leaves out, and its preview shows the builder in that look.

Turned off, the builder looks as builders did before: it takes your page's colours and the name of its text font, and keeps its own buttons. A page whose script sets inheritStyles: false, or that shows the builder in a plain <iframe> without the script, keeps the builder's own look. Over the API the switch is appearance.storeLook: auto or off.

Colours and type

On a Ring Builder embed's Appearance tab, Colours and type sets the builder's own look: the page, panel, text and line colours, a text font and a heading font, custom corners, the button shape (pill, rounded or square), the spacing (compact, comfortable or airy) and the motion (standard or reduced). Every field starts on Automatic, which keeps your store's look: all of it with Look like my store on, otherwise your store's colours and font when the builder can read them, else its own.

Set both a panel (or page) colour and a text colour to repaint the builder. If text would be hard to read on those panels, the builder keeps your store's colours and the editor tells you. The fonts are built in, so nothing loads from another site. The accent colour stays under Branding, and Reset colours and type puts every field back on Automatic. Over the API these settings are appearance in the embed's config.

From the Pro plan, Custom CSS under the same heading adds your own styles. Every rule stays inside the builder, so nothing on the rest of your store page changes; @import, @font-face and similar rules are left out, and the editor names any it left out. Reset keeps your CSS.

Match the studio look

On the embed's Appearance tab, tune brightness, diamond brilliance and reflection intensity; defaults render the diamond and metal exactly as the studio does. On a saved-design embed, the appearance overrides apply as set: the chosen environment lights the piece, a metal or gem override recolours an uploaded design's parts too, tone mapping None renders with no tone mapping, Bloom on adds its glow, and Shadow off removes the shadow.

A saved-design embed takes every gesture over the piece by default. Turn on Page scroll in its settings when it sits inside a long page: on a phone a vertical swipe then scrolls your page and a sideways drag turns the piece, and a mouse wheel zooms only after a click on the piece, as the ring builder does.

Page builder

From the Pro plan, design the whole page around a builder in Dashboard → Embeds → Page. Drag blocks (ring viewer, configurator steps, price, buy, trust, FAQ, custom HTML) onto the outline, set your theme colours and fonts, and preview the real embed live at a phone's 390, a tablet's 834 and a desktop's 1280 pixels, scaled to fit (every embed editor previews the same way; opened on a phone, it starts on the phone). The Configurator steps block renders the same One page / One step / Three step flow as the built-in page; toggle it from the Page builder's Layout tab or the embed editor's own Layout pane, and they stay in sync. Your draft saves as you go and only reaches shoppers when you press Publish; every publish keeps a restore point, and Unpublish puts the built-in layout back.

Block settings

Select a block to see its settings; rarely needed ones, such as text size, sit under More settings. Every block that shows something also has Spacing and background: space above and below, a background colour or an https image, and its position (full width, left, centre or right).

Every image setting opens the media library: the images in your Drive, with search, and Upload an image, which keeps the new image in your Drive too. You can also paste a link; a page shows images from https links only.

The Rich text block takes formatted text without any HTML: start a line with # or ## for a heading, wrap words in ** for bold or * for italic, write [words](https://…) for a link, and start lines with - or 1. for a list. A blank line starts a new paragraph, and the buttons above the text write the marks for you. Every plan with the page builder has it.

Pages made before these settings keep their exact look. Use every setting in the inspector turns on the ones that change it: Step style on the Configurator steps block, gaps that follow the spacing in Colours and type, Show on, which hides any block on mobile, tablet or desktop, and custom CSS (set over the API) that stays inside the page. It changes your draft, and shoppers see it when you publish. New pages have every setting on. Over the API this is the page's rev: a page without one renders as before, and new pages are rev: 2.

Steps on their own

Under the One page and One step flows, a page can place the configurator's steps where you want them, for example the metal beside the viewer and the ring size under the price. Add a Single step block and pick its step: Setting, Metal, Shape, Centre stone, Ring size, Engraving or Complete the set. Each step goes on the page once, and the Configurator steps block shows every step you haven't placed, without numbers. A step the builder doesn't offer on the page shows nothing to shoppers: engraving that is switched off, or Complete the set, which designed pages don't show.

The Design gallery block shows the designs to choose from, either as the bar that opens the gallery or as the gallery itself on the page. It needs more than one design and a builder that opens on the gallery.

Under Three step both blocks stay off and the Configurator steps block shows every step, so a page never loses its options.

Themes and versions

Edit on a Ring Builder opens its editor. Every change waits in a draft, and the editor saves it as you go; shoppers see nothing until you press Publish, which lists what will change first. The Themes button holds the builder's looks: start one from the live look, the defaults, one of six ready-made looks, or Match my store, and preview any of them on the editor's stage. Preview link shows a theme on your own store page before it goes live, and Versions keeps every publish, so you can load an earlier one back as a draft.

Changes wait in drafts. A theme's draft holds its look and page, and the settings draft holds the rest of the builder's settings. Publish makes a theme and the settings draft live together and keeps a release, so any earlier version can be loaded back as a draft and published again. A dry run lists what a publish would change (for example "Layout: One page → Guided steps"). If the live builder changed after the draft started, a publish stops and asks you to publish anyway. A builder holds up to 20 themes.

A new theme can start from the live look, the builder's defaults, another theme, a release or one of six ready-made looks: Classic, Luxe, Minimal, Modern, Bold and Editorial. They use the built-in fonts and keep your accent colour; Luxe, Modern, Bold and Editorial also come with a designed page.

These are on the API now: /api/public/ring-builder/embeds/{id}/themes, /draft, /publish and /releases over REST, ringBuilderThemes and publishRingBuilderTheme in GraphQL, and ringBuilder.themes, .draft and .releases in the SDK.

Match my store

With ring-builder.js 2.16 or later on your store, the builder notes the colours and fonts of the store pages it runs on: the page and text colours, the font of your text and headings, the font files your pages load for them, a button's colour and corners, and font stylesheets from Google Fonts, Adobe Fonts or Shopify (from 2.17, the button's label too: its colour, capitals, letter spacing and weight). It keeps one look per store address, the latest it saw, and only from your allowed domains when you have set any. Nothing is applied by itself unless Look like my store is on.

GET /api/public/ring-builder/embeds/{id}/host-looks lists each one (ringBuilderHostLooks in GraphQL, ringBuilder.hostLooks in the SDK), and a theme created with from: { hostLook: origin } takes that look on the Classic layout, keeping your accent colour when you have one. The theme editor's Themes dialog offers the same as Match my store. The theme loads your store's font files inside the builder, and a font the browser can't fetch falls back to the next one in the list.

Preview a theme on your store

A preview link shows a theme as drafted, together with the settings draft, to anyone who has the link, for 7 days. Nothing goes live. Open the link on the builder's own page, or add its 3jd_theme=… part to the address of any page on your store that shows the builder (the install script 2.15 or later reads it). A small "Previewing … · not live" label sits at the top, nothing counts in your analytics, and the builder's cover picture stays as it is. Revoking a theme's links stops every link made for it.

Over the API: POST (make) and DELETE (revoke) on /api/public/ring-builder/embeds/{id}/themes/{themeId}/preview, createRingBuilderThemePreviewLink and revokeRingBuilderThemePreviewLinks in GraphQL, and ringBuilder.themes.previewLink and .revokePreviewLinks in the SDK.

Related

Put your own design in the studio

Upload a file and see it rendered photoreal, ready to embed and, for a ring, to try on.