Widget Documentation

Everything you need to embed and customize the <image-layer> widget in your application.

Quick Start

Add the widget to any HTML page in three lines:

HTML

<script type="module" src="https://cdn.imagelayer.io/widget/latest/image-layer.js"></script>

<image-layer
  api-key="il_live_your_api_key_here"
  api-url="https://api.imagelayer.io"
  session-token="SESSION_TOKEN_FROM_YOUR_SERVER"
></image-layer>

The widget renders as a self-contained UI. Users enter a prompt, generate an image, apply branding, and download the final result.

Installation

CDN (recommended)

HTML

<script type="module" src="https://cdn.imagelayer.io/widget/latest/image-layer.js"></script>

Self-hosted

Copy the built widget files to your static assets and reference the local path:

HTML

<script type="module" src="/assets/image-layer.js"></script>

Attributes

All configuration is done via HTML attributes on the <image-layer> element.

Attribute	Type	Default	Description
api-key	string	""	Required. Your organization's API key from the dashboard.
api-url	string	""	Required. Base URL of the ImageLayer API.
session-token	string	""	Required. JWT from `POST /v1/auth/session`.
theme	"light" \| "dark"	"light"	Color scheme. Dark palette when `"dark"`.
show-model-selector	boolean	false	Show AI model dropdown (Gemini Flash, Pro, Imagen 4).
demo-mode	boolean	false	Enable demo mode — bypasses session auth.
demo-google-key	string	""	Google AI API key for demo generation.
demo-google-url	string	""	Optional custom Google AI API URL.

Events

The widget emits custom events that bubble up through the DOM. Listen with addEventListener.

Event	Fires when	`event.detail`
il:generate	User submits a prompt or selects a history item.	{ prompt: string }
il:submit	User finalizes the branded image.	{ url: string, blob: Blob }
il:error	An error occurs during generation.	{ error: string }

JavaScript

const widget = document.querySelector('image-layer');

widget.addEventListener('il:generate', (e) => {
  console.log('Generating:', e.detail.prompt);
});

widget.addEventListener('il:submit', (e) => {
  console.log('Final image URL:', e.detail.url);
  // e.detail.blob contains the raw Blob for upload
});

widget.addEventListener('il:error', (e) => {
  console.error('Widget error:', e.detail.error);
});

Theming

The widget uses CSS custom properties for full visual customization. Override them on the <image-layer> element to match your brand.

CSS

image-layer {
  /* Brand colors */
  --il-primary: #6366F1;
  --il-primary-hover: #4F46E5;
  --il-accent: #10B981;
  --il-accent-hover: #059669;

  /* Backgrounds */
  --il-bg: #FFFFFF;
  --il-bg-secondary: #F8FAFC;
  --il-bg-tertiary: #F1F5F9;

  /* Text */
  --il-text: #0F172A;
  --il-text-secondary: #475569;
  --il-text-muted: #94A3B8;

  /* Borders */
  --il-border: #E2E8F0;
  --il-border-hover: #CBD5E1;

  /* Error / Success */
  --il-error: #EF4444;
  --il-success: var(--il-accent);

  /* Border radius */
  --il-radius: 10px;
  --il-radius-sm: 6px;
  --il-radius-lg: 14px;
  --il-radius-full: 9999px;

  /* Typography */
  --il-font: 'Inter', system-ui, sans-serif;

  /* Shadows */
  --il-shadow-xs: 0 1px 2px rgba(0,0,0,0.04);
  --il-shadow: 0 1px 3px rgba(0,0,0,0.08), 0 1px 2px -1px rgba(0,0,0,0.08);
  --il-shadow-md: 0 4px 6px -1px rgba(0,0,0,0.08), 0 2px 4px -2px rgba(0,0,0,0.06);
  --il-shadow-lg: 0 10px 15px -3px rgba(0,0,0,0.08), 0 4px 6px -4px rgba(0,0,0,0.04);
}

Dark Theme

Set theme="dark" on the element. Override dark-specific variables:

CSS

image-layer[theme="dark"] {
  --il-bg: #0F172A;
  --il-text: #F1F5F9;
  --il-border: #334155;
  --il-primary: #818CF8;
}

Server-Side Setup

The widget requires a session token to authenticate end users. Your server obtains this token by calling the ImageLayer API.

1. Get your API key

Go to Dashboard → API Keys and create a new key.

2. Create a session (server-side)

Call POST /v1/auth/session from your backend:

cURL

curl -X POST https://api.imagelayer.io/v1/auth/session \
  -H "X-API-Key: il_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "external_user_id": "user-123",
    "display_name": "Jane Doe"
  }'

Response:

JSON

{
  "session_token": "eyJhbG...",
  "expires_at": "2026-03-29T22:00:00.000Z",
  "user": {
    "id": "uuid",
    "external_id": "user-123",
    "display_name": "Jane Doe"
  }
}

3. Pass the token to the widget

Inject session_token into the widget's session-token attribute — server-side when rendering, or client-side after fetching from your API.

Full Integration Example

A complete HTML page with session creation and widget embedding.

HTML

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8" />
  <title>My App — Image Generator</title>
  <script type="module" src="https://cdn.imagelayer.io/widget/latest/image-layer.js"></script>
  <style>
    image-layer {
      max-width: 480px;
      margin: 40px auto;
      --il-primary: #2563EB;
      --il-radius-lg: 16px;
    }
  </style>
</head>
<body>
  <image-layer
    id="widget"
    api-key="il_live_your_api_key"
    api-url="https://api.imagelayer.io"
    theme="light"
  ></image-layer>

  <script>
    // Fetch session token from YOUR backend
    async function initWidget() {
      const res = await fetch('/api/imagelayer-session');
      const { session_token } = await res.json();
      document.getElementById('widget').setAttribute('session-token', session_token);
    }

    const widget = document.getElementById('widget');
    widget.addEventListener('il:submit', (e) => {
      // Upload the final branded image to your storage
      const formData = new FormData();
      formData.append('image', e.detail.blob, 'branded-image.png');
      fetch('/api/upload', { method: 'POST', body: formData });
    });

    initWidget();
  </script>
</body>
</html>

Demo Mode

For local development, use demo mode which bypasses session authentication:

HTML

<image-layer
  api-url="http://localhost:3001"
  demo-mode
  demo-google-key="YOUR_GOOGLE_AI_API_KEY"
  show-model-selector
  theme="dark"
></image-layer>

Note: Demo mode is for development only. In production, always use API keys and session tokens. The demo-google-key is sent directly to Google AI and should never be exposed in production.