Hoppa till innehåll

npm-paket

@wink/elements npm-paketet är det snabbaste sättet att lägga till Wink-webbkomponenter i vilket JavaScript- eller TypeScript-projekt som helst. Det tillhandahåller en load()-funktion som injicerar CDN-resurserna och fullständiga TypeScript-typdeklarationer för alla komponentattribut.

wink-travel/wink-elements på GitHub Källkod, API-referens och instruktioner för bidrag.

Installera

npm install @wink/elements

Kom igång snabbt

Anropa load() en gång vid appens start. Den är idempotent — säker att anropa flera gånger.

import { load } from '@wink/elements';

load({ clientId: 'YOUR_CLIENT_ID' });

Använd sedan valfri Wink-komponent i din HTML eller JSX:

<wink-content-loader layout="HOTEL" id="YOUR_LAYOUT_ID"></wink-content-loader>

Ramverksexempel

Next.js (App Router)

'use client';
import { useEffect } from 'react';
import { load } from '@wink/elements';

export default function RootLayout({ children }: { children: React.ReactNode }) {
  useEffect(() => {
    load({ clientId: process.env.NEXT_PUBLIC_WINK_CLIENT_ID! });
  }, []);
  return <html><body>{children}</body></html>;
}

Nuxt 3

import { load } from '@wink/elements';

export default defineNuxtPlugin(() => {
  load({ clientId: useRuntimeConfig().public.winkClientId });
});

Astro

---
import { load } from '@wink/elements';
---
<script>
  import { load } from '@wink/elements';
  load({ clientId: import.meta.env.PUBLIC_WINK_CLIENT_ID });
</script>

SvelteKit

import { load as loadWink } from '@wink/elements';
import { browser } from '$app/environment';

export function load() {
  if (browser) {
    loadWink({ clientId: import.meta.env.PUBLIC_WINK_CLIENT_ID });
  }
}

TypeScript-typer

Alla komponentattributsgränssnitt exporteras för användning i JSX, template literals eller typade ordböcker:

import type { WinkContentLoaderAttributes, WinkLayout } from '@wink/elements';

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript fångar ogiltiga layoutvärden
  id: 'abc123',
  sort: 'POPULARITY',
};

Använda en staging-CDN

load({
  clientId: 'YOUR_CLIENT_ID',
  cdnBaseUrl: 'https://staging-elements.wink.travel',
});

API

`load(options)`

Option	Typ	Obligatorisk	Standard	Beskrivning
`clientId`	`string`	Ja	—	Din Wink OAuth2 Client ID
`configurationId`	`string`	Nej	—	Valfritt anpassnings-ID
`cdnBaseUrl`	`string`	Nej	`https://elements.wink.travel`	Överskriv CDN-URL

Vidare läsning