Ideal House
Pular para o conteúdo

Integração para desenvolvedores Shopify#

Adicione o botão ideal.house a um tema Shopify e vincule-o à Variant SKU selecionada.

<!-- DASHBOARD_READINESS -->

Antes de carregar o SDK: Abra Dashboard → Settings, adicione a origem do seu storefront em Allowed Origins (CORS) e clique em Save. Inclua o hostname publicado e quaisquer origens de pré-visualização ou staging que você use; separe várias origens com vírgulas. Veja as etapas de configuração.

1. Confirmar pré-requisitos#

  • Você pode editar o código do tema ativo ou uma cópia segura do tema.
  • Pelo menos um produto de teste está importado e ativo no Catalog.
  • A Variant SKU selecionada é o mesmo productCode persistente usado pelo Catalog para esta Shop.

2. Criar o snippet do botão#

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>

Mantenha o botão oculto até que o SDK confirme a elegibilidade do produto.

3. Renderizar o botão nas superfícies do tema#

Cards de coleção e pesquisa#

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

Os arquivos comuns incluem snippets/card-product.liquid, snippets/product-card.liquid ou snippets/product-grid-item.liquid. Ajuste card_product à variável product usada pelo tema.

Página de detalhes do produto#

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'
-%}

Os arquivos comuns incluem sections/main-product.liquid ou snippets/product.liquid. Insira renders separados para desktop e mobile apenas quando o tema possuir layouts distintos.

4. Carregar o SDK e sincronizar variants#

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 não define um evento universal de variant de tema. Conecte o adaptador abaixo ao evento ou callback exposto pelo tema ativo.

Exemplo de adaptador de evento do tema#

Substitua o evento de exemplo pela API do tema ativo. Alguns temas publicam por meio de window.subscribe; outros dispatcham um evento DOM ou atualizam product-info.

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. Adicionar estilos do tema#

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;
}

O tema pode sobrescrever estes estilos visuais.

6. Incluir assets em theme.liquid#

Inclua a folha de estilos e o script do visualizer em layout/theme.liquid para aplicar os estilos e ativar o loader do SDK.

Incluir folha de estilos (dentro de <head>)#

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

Posicione dentro da tag <head> de layout/theme.liquid para que os estilos sejam carregados de forma limpa.

Incluir script (antes de </body>)#

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

Use defer e posicione logo antes da tag de fechamento </body> em layout/theme.liquid para evitar bloquear o render da página.

O botão 'View in my room' permanece oculto até que este script de loader seja incluído em theme.liquid.

7. Verificar no storefront ativo#

  1. O painel Network mostra sdk.js carregado com HTTP 200.
  2. O data-product-code do botão desenvolvido deve corresponder exatamente ao productCode do Catalog.
  3. Produtos elegíveis revelam o botão; produtos inelegíveis o mantêm oculto.
  4. Trocar a Variant atualiza o data-product-code e revalida o botão.
  5. As ocorrências em coleções e pesquisas, nas páginas de produto para computador e nas páginas de produto para dispositivos móveis funcionam onde estiverem presentes.
  6. Clicar no botão abre o ideal.house Viewer com o produto selecionado.