npm.io
0.1.33 • Published 2d ago

@session-services/web-elements

Licence
MIT
Version
0.1.33
Deps
0
Size
3.3 MB
Vulns
0
Weekly
0

@session-services/web-elements

Framework-agnostic Web Components for Session Services ticketing.

Installation

npm install @session-services/web-elements

The SDK is bundled, so no additional dependencies are required.

CDN Usage

Use directly in browsers via unpkg (no build step required):

<script type="module" src="https://unpkg.com/@session-services/web-elements"></script>

<session-services-ticketing
  tenant-id="your-tenant-id"
  event-id="evt_123"
  return-url="https://yoursite.com/order/complete"
></session-services-ticketing>

Custom elements are auto-registered when the script loads.

Usage

import { defineCustomElements } from '@session-services/web-elements/loader';

// Call once at app startup
defineCustomElements();
<session-services-ticketing
  tenant-id="your-tenant-id"
  event-id="evt_123"
  return-url="https://yoursite.com/order/complete"
  theme="light"
></session-services-ticketing>

When you need the custom element constructors directly, import the short component names:

import { FormattedText } from '@session-services/web-elements/formatted-text';
import { Ticketing } from '@session-services/web-elements/ticketing';

The component barrel also exports both:

import { FormattedText, Ticketing } from '@session-services/web-elements/components';

Props

Prop Type Required Default Description
tenant-id string Yes Your Session Services tenant ID
event-id string Yes Event ID to display tickets for
api-url string No https://api.session.services API endpoint URL
locale string No en-US Locale for formatting
return-url string No URL to redirect after checkout
theme 'light' | 'dark' | 'system' No system Color theme
enable-analytics boolean No true Enable analytics tracking
debug-analytics boolean No false Log analytics events to console

Events

Listen to events using standard DOM event listeners:

const element = document.querySelector('session-services-ticketing');

element.addEventListener('cartUpdate', (e) => {
  console.log('Cart updated:', e.detail); // OrderQuote
});

element.addEventListener('checkoutInit', (e) => {
  const { orderId, checkoutUrl } = e.detail;
  window.location.href = checkoutUrl;
});

element.addEventListener('errorOccurred', (e) => {
  console.error('Error:', e.detail.error);
});

element.addEventListener('analyticsEventSkipped', (e) => {
  console.warn('Analytics skipped:', e.detail);
});
Event Detail Type Description
cartUpdate OrderQuote Fired when cart contents change
checkoutInit { orderId: string; checkoutUrl: string } Fired when checkout begins
errorOccurred { error: string } Fired on errors
analyticsEventSkipped { eventType: string; eventId: string; reason: string } Fired when analytics is enabled but an event cannot be tracked

Theming

Customize appearance with CSS variables:

<session-services-ticketing
  tenant-id="..."
  event-id="..."
  style="
    --card: #fff;
    --card-foreground: #111827;
    --border: #e5e7eb;
    --primary: #ec4899;
    --primary-foreground: #ffffff;
    --accent: #f472b6;
    --accent-foreground: #0f172a;
    --secondary: #f3f4f6;
    --secondary-foreground: #1f2937;
    --muted-foreground: #6b7280;
    --ring: #f472b6;
  "
></session-services-ticketing>

Framework Integration

Works with any framework - React, Vue, Angular, Svelte, or vanilla HTML.

For React, consider using @session-services/react-elements for better DX with typed props and event handlers.

License

MIT

Keywords