@r2u/javascript-ar-sdk

JavaScript AR SDK

JavaScript SDK for Augmented Reality on the web.

Methods

Defines a global R2U variable with the following methods

interface R2U {
  init: (params: { customerId: string }) => Promise<void>
  isActive: (sku: string) => Promise<boolean>
  openAR: (params: { sku: string; resize?: boolean }) => Promise<void>
  getOpenARLink: (sku: string) => Promise<string>
  create3DViewer: (params: {
    element: HTMLElement
    sku: string
    name: string
    popup?: boolean
    progressBarPosition?: 'top' | 'middle' | 'bottom'
    poster?: string | null
  }) => Promise<void>
  analytics: {
    send: (event: Record<string, string | number>) => Promise<void>
  }
  customizer: {
    open: () => Promise<void>
  }
}

Integration

Please refer to the documentation repository for more information.