Ideal House
Naar inhoud gaan

Ontwikkelaarsintegratie voor Shopify#

Voeg de ideal.house-knop toe aan een Shopify-thema en koppel deze aan de SKU van de geselecteerde variant.

<!-- DASHBOARD_READINESS -->

Voordat je de SDK laadt: Open Dashboard → Instellingen, voeg de oorsprong van je webshop toe aan Allowed Origins (CORS) en klik op Opslaan. Neem de gepubliceerde hostnaam en alle gebruikte oorsprongen van voorbeeld- of testomgevingen op; scheid meerdere oorsprongen met komma's. Zie de configuratiestappen.

1. Vereisten controleren#

  • Je kunt de code van het live thema of een veilige kopie daarvan bewerken.
  • Minstens één testproduct is geïmporteerd en actief in de catalogus.
  • De SKU van de geselecteerde variant is dezelfde opgeslagen productCode die de catalogus voor deze winkel gebruikt.

2. Het knopfragment maken#

snippets/idealhouse-view-button.liquid#

liquid
{%- comment -%}
  Renders an ideal.house authored visualizer button.

  Accepts:
  - product_code: {String} Variant SKU used by the ideal.house Catalog mapping.
  - placement: {String} "card", "pdp-desktop", or "pdp-mobile".
{%- endcomment -%}

{%- liquid
  assign button_code = product_code | strip
  assign button_placement = placement | default: 'card'
-%}

<button
  type="button"
  class="idealhouse-view-button idealhouse-view-button--{{ button_placement | escape }}"
  data-idealhouse-authored-button
  data-active="false"
  {% if button_code != blank %}
    data-product-code="{{ button_code | escape }}"
  {% else %}
    disabled
  {% endif %}
  style="visibility: hidden;"
>
  <span>View in my room</span>
</button>

Houd de knop verborgen totdat de SDK bevestigt dat het product geschikt is.

3. De knop weergeven in het thema#

Collectie- en zoekkaarten#

liquid
{%- render 'idealhouse-view-button',
  product_code: card_product.selected_or_first_available_variant.sku,
  placement: 'card'
-%}

Veelgebruikte bestanden zijn snippets/card-product.liquid, snippets/product-card.liquid of snippets/product-grid-item.liquid. Pas card_product aan de productvariabele van het thema aan.

Productdetailpagina#

liquid
{%- render 'idealhouse-view-button',
  product_code: product.selected_or_first_available_variant.sku,
  placement: 'pdp-desktop'
-%}

{%- render 'idealhouse-view-button',
  product_code: product.selected_or_first_available_variant.sku,
  placement: 'pdp-mobile'
-%}

Veelgebruikte bestanden zijn sections/main-product.liquid of snippets/product.liquid. Plaats alleen afzonderlijke desktop- en mobiele weergaven als het thema afzonderlijke lay-outs heeft.

4. De SDK laden en varianten synchroniseren#

assets/idealhouse-room-visualizer.js#

js
(function () {
  'use strict';

  var buttonSelector = '[data-idealhouse-authored-button]';
  var sdkRequested = false;
  var buttonObserver = null;

  function resetButton(button) {
    button.dataset.active = 'false';
    button.style.visibility = 'hidden';
    delete button.dataset.rvProductCode;
    delete button.dataset.rvProductType;
    delete button.dataset.rvProductId;
    delete button.dataset.rvProductIds;
  }

  function syncButton(button, productCode) {
    if (!button) return false;
    var code = typeof productCode === 'string' ? productCode.trim() : '';
    resetButton(button);
    delete button.dataset.productCode;

    if (!code) {
      button.disabled = true;
      return false;
    }

    button.disabled = false;
    button.dataset.productCode = code;
    return true;
  }

  function syncButtons(container, productCode) {
    (container || document).querySelectorAll(buttonSelector).forEach(function (button) {
      syncButton(button, productCode);
    });
  }

  function loadSdk() {
    if (sdkRequested || !document.querySelector(buttonSelector)) return false;
    sdkRequested = true;
    if (buttonObserver) buttonObserver.disconnect();

    var script = document.createElement('script');
    script.src = 'https://sdk.ideal.house/sdk.js';
    script.async = true;
    script.dataset.shopId = '<SHOP_ID>';
    script.dataset.publishableKey = '<PUBLISHABLE_KEY>';
    script.dataset.authoredButtonSelector = buttonSelector;
    document.head.appendChild(script);
    return true;
  }

  function startSdkLoader() {
    if (loadSdk() || typeof MutationObserver === 'undefined') return;
    buttonObserver = new MutationObserver(loadSdk);
    buttonObserver.observe(document.documentElement, { childList: true, subtree: true });
  }

  // Dispatch this event from your theme's variant-change callback.
  document.addEventListener('idealhouse:variant-change', function (event) {
    var detail = event.detail || {};
    syncButtons(detail.container || document, event.detail && event.detail.sku);
  });

  window.IdealhouseShopify = {
    syncButton: syncButton,
    syncButtons: syncButtons
  };

  if (document.readyState === 'loading') {
    document.addEventListener('DOMContentLoaded', startSdkLoader);
  } else {
    startSdkLoader();
  }
}());

Shopify definieert geen universele themagebeurtenis voor varianten. Verbind de kleine adapter hieronder met de gebeurtenis of callback die het actieve thema beschikbaar stelt.

Voorbeeld van een adapter voor themagebeurtenissen#

Vervang de voorbeeldgebeurtenis door de API van het actieve thema. Sommige thema's publiceren via window.subscribe; andere sturen een DOM-gebeurtenis uit of werken product-info bij.

js
// Example only: replace "variant:change" with your theme's event.
document.addEventListener('variant:change', function (event) {
  var variant = event.detail && event.detail.variant;
  var productContainer = event.target.closest('product-info') || document;

  document.dispatchEvent(new CustomEvent('idealhouse:variant-change', {
    detail: {
      container: productContainer,
      sku: variant && variant.sku
    }
  }));
});

5. Themastijlen toevoegen#

assets/idealhouse-room-visualizer.css#

css
.idealhouse-view-button {
  align-items: center;
  justify-content: center;
  width: 100%;
  min-height: 44px;
  padding: 0.75rem 1rem;
  border: 1px solid currentColor;
  border-radius: 6px;
  background: transparent;
  color: inherit;
  cursor: pointer;
  font: inherit;
}

.idealhouse-view-button[data-active="true"] {
  display: inline-flex;
  visibility: visible;
}

.idealhouse-view-button:disabled {
  cursor: not-allowed;
  opacity: 0.5;
}

Het thema kan deze visuele stijlen overschrijven.

6. Bestanden opnemen in theme.liquid#

Neem het visualisatiestijlblad en -script op in layout/theme.liquid om stijlen toe te passen en de SDK-loader te activeren.

Stijlblad opnemen binnen <head>#

liquid
{{ 'idealhouse-room-visualizer.css' | asset_url | stylesheet_tag }}

Plaats dit binnen de <head>-tag van layout/theme.liquid zodat de stijlen correct worden geladen.

Script opnemen vóór </body>#

liquid
<script src="{{ 'idealhouse-room-visualizer.js' | asset_url }}" defer="defer"></script>

Gebruik defer en plaats dit vlak vóór de afsluitende </body>-tag in layout/theme.liquid om paginaweergave niet te blokkeren.

De knop 'Bekijken in mijn kamer' blijft verborgen totdat dit loaderscript in theme.liquid is opgenomen.

7. Controleren in de live webshop#

  1. Het netwerkpaneel toont dat sdk.js is geladen met HTTP 200.
  2. De data-product-code van de zelfgemaakte knop komt exact overeen met de productCode in de catalogus.
  3. Geschikte producten tonen een knop; ongeschikte producten houden deze verborgen.
  4. Een variantwisseling werkt data-product-code bij en valideert de knop opnieuw.
  5. Plaatsingen in collecties/zoekresultaten en productdetailpagina's op desktop en mobiel werken waar ze aanwezig zijn.
  6. Een klik op de knop opent de ideal.house Viewer met het geselecteerde product.