Widget Types

Choose the widget package based on your frontend stack:

Search Widgets: LiveSearch & GlobalSearch

Search widgets support searchVersion="v1" or "v2". LiveSearch browses the catalog when the query is empty (public HMAC on GET /catalog/items).

<!-- Header typeahead -->
<div
  data-recomnext-global-search
  data-base-url="https://api.recomnext.com"
  data-tenant-id="YOUR_TENANT"
  data-public-token="rnx_pub_..."
  data-search-version="v2"
  data-shop-url="/search?q={query}"
></div>
<script src="/assets/recomnext-global-search.js"></script>

<!-- Full-page shop search -->
<div
  data-recomnext-live-search
  data-base-url="https://api.recomnext.com"
  data-tenant-id="YOUR_TENANT"
  data-public-token="rnx_pub_..."
  data-search-version="v2"
  data-sync-url="true"
></div>
<script src="/assets/recomnext-live-search.js"></script>

Vanilla Widget: Quick Start

The vanilla widget auto-initializes every element with data-recomnext-carousel on page load. You only need HTML data attributes and the widget script.

<div
  data-recomnext-carousel
  data-base-url="https://api.recomnext.com"
  data-tenant-id="demo-ecommerce"
  data-logic="similar-products"
  data-item-id="prod-001"
  data-scenario="pdp-similar"
  data-country="IN"
  data-count="8"
  data-return-properties="true"
  data-included-properties="attributes.name,attributes.price,attributes.image,category"
  data-title="You Might Also Like"
  data-item-url="/products/{itemId}"
></div>
<script src="/assets/recomnext-carousel.js"></script>

Vanilla Widget Parameters

User identity

The engine never assigns user IDs server-side. You control the identifier sent on recommendation, impression, and interaction calls.

Anonymous → logged-in flow

// 1) Anonymous: omit userId — widget uses sess_<timestamp>_<random> in sessionStorage
// 2) After login: pass your account ID and merge prior anonymous history (Browser SDK)
await recomnext.mergeIdentity(loggedInUserId);
recomnext.setUserId(loggedInUserId);
// 3) Re-render React widget with userId={loggedInUserId} (or update data-user-id)

Vanilla Widget: Programmatic Initialization

Use constructor-based initialization for dynamic pages, custom lifecycle handling, or SPA route transitions.

import { RecomnextCarousel } from '@recomnext/carousel';

const el = document.getElementById('recs');
const carousel = new RecomnextCarousel(el, {
  baseUrl: 'https://api.recomnext.com',
  tenantId: 'demo-ecommerce',
  logic: 'user-to-item',
  userId: 'user-123', // your stable ID — omit for anonymous session fallback
  count: 8,
  returnProperties: true,
  includedProperties: ['attributes.name', 'attributes.price', 'attributes.image', 'category'],
  title: 'Recommended For You',
  scenario: 'homepage-for-you',
});

// On route teardown:
carousel.destroy();

React Widget: Quick Start

In React apps, use the RecomnextCarousel component and pass logic-specific props.

import { RecomnextCarousel } from '@recomnext/react-carousel';

export function ProductRecommendations({ productId }: { productId: string }) {
  return (
    <RecomnextCarousel
      baseUrl="/api"
      tenantId="demo-ecommerce"
      logic="similar-products"
      itemId={productId}
      scenario="pdp-similar"
      country="IN"
      count={8}
      returnProperties={true}
      includedProperties={['attributes.name', 'attributes.price', 'attributes.image', 'category']}
      title="Similar Products"
      onItemClick={(item) => {
        window.location.href = '/products/' + item.itemId;
      }}
    />
  );
}

React Widget Props

Strict-HMAC Projection Contract

Projection placement must match request signing scope exactly.

GET (user-to-item, item-to-item, similar-products, recently-viewed):
- returnProperties + includedProperties go in query and are included in the signed URL.

POST (items-to-items):
- returnProperties + includedProperties go in JSON body only.
- Query stays scenario/user context only.

If placement and signature scope differ, the engine rejects the request.

Customization Examples

Custom React Card Renderer

<RecomnextCarousel
  baseUrl="/api"
  tenantId="demo-ecommerce"
  logic="user-to-item"
  count={10}
  title="Top Picks"
  renderItem={(item) => (
    <a
      href={'/products/' + item.itemId}
      style={{
        display: 'block',
        width: 220,
        borderRadius: 12,
        border: '1px solid #eee',
        textDecoration: 'none',
        color: '#111',
        overflow: 'hidden',
      }}
    >
      {item.image && <img src={item.image} alt={item.name} style={{ width: '100%', aspectRatio: '1', objectFit: 'cover' }} />}
      <div style={{ padding: 12 }}>
        <p style={{ margin: 0, fontWeight: 600 }}>{item.name}</p>
        <p style={{ margin: '4px 0 0', color: '#666', fontSize: 12 }}>{item.category}</p>
      </div>
    </a>
  )}
/>

Vanilla Widget with Multiple Carousels

<div
  data-recomnext-carousel
  data-base-url="https://api.recomnext.com"
  data-tenant-id="demo-ecommerce"
  data-logic="user-to-item"
  data-user-id="user-123"
  data-scenario="homepage-for-you"
  data-title="For You"
></div>

<div
  data-recomnext-carousel
  data-base-url="https://api.recomnext.com"
  data-tenant-id="demo-ecommerce"
  data-logic="recently-viewed"
  data-user-id="user-123"
  data-title="Recently Viewed"
></div>

How Rendering Works

• Widget injects scoped carousel styles once and renders a loading skeleton immediately.
• Recommendations are fetched using the selected logic and optional scenario.
• Response items are mapped into card data fields: itemId, name, category, price, image, url.
• Lean/projection payloads are supported; widgets tolerate missing attributes, image, category, and price without throwing.
• Cards render in a horizontal track with snap scrolling for touch and desktop trackpads.
• If no items are returned, the widget renders an empty state message.
• Each card includes data-item-id for analytics tracking and custom hooks.

Projection Behavior Guide

Tracking and Analytics

Widgets track both click interactions and impressions automatically.

Logic Selection Guide

Troubleshooting

• No cards rendered: verify baseUrl, tenantId, and logic-specific inputs (itemId or itemIds).
• Empty recommendations: ensure catalog and interactions are ingested and the selected scenario is valid. If the scenario filter is strict, opt-in autoRelaxFilters (durable clauses left, soft right) — see Query planning for filter auto-relax. Widgets inherit scenario flags; no new widget attributes.
• Only ID links show (no name/image/price): check if returnProperties=false is enabled or if includedProperties paths do not match raw item paths from /catalog/items.
• HTTP 400 on recommendations: verify includedProperties has no unsafe segments (for example __proto__, constructor) and stays within GET path/length limits.
• Broken links: check data-item-url or custom click navigation handlers.
• No impression events: confirm cards are in viewport and browser supports IntersectionObserver.
• 401/403 errors: verify tenant auth setup and pass publicToken when browser signing is required.

Next Steps

After adding widgets, continue with:

• Integration Guides — run the local stack and seed test data.
• nextQL Guide — build filter and booster expressions for scenarios.
• API Reference — inspect recommendation and ingestion endpoint contracts.
• SDK Docs — integrate typed Browser and Node clients.