Tovább a tartalomhoz

npm csomag

Az @wink/elements npm csomag a leggyorsabb módja, hogy Wink webkomponenseket adj bármely JavaScript vagy TypeScript projekthez. Tartalmaz egy load() függvényt, amely betölti a CDN erőforrásokat és teljes TypeScript típusdefiníciókat biztosít az összes komponens attribútumhoz.

wink-travel/wink-elements a GitHubon Forráskód, API referencia és hozzájárulási útmutató.

Telepítés

npm install @wink/elements

Gyors kezdés

Hívd meg egyszer a load()-ot az alkalmazás indításakor. Idempotens — biztonságosan hívható többször is.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Ezután használj bármilyen Wink komponenst a HTML-ben vagy JSX-ben:

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

Keretrendszer példák

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 típusok

Az összes komponens attribútum interfész exportálva van, hogy használható legyen JSX-ben, template literalokban vagy típusos szótárakban:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // A TypeScript elkapja az érvénytelen layout értékeket
  id: 'abc123',
  sort: 'POPULARITY',
};

Staging CDN használata

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

API

`load(options)`

Opció	Típus	Kötelező	Alapértelmezett	Leírás
`clientId`	`string`	Igen	—	A Wink OAuth2 kliensazonosítód
`configurationId`	`string`	Nem	—	Opcionális testreszabási azonosító
`cdnBaseUrl`	`string`	Nem	`https://elements.wink.travel`	CDN URL felülírása

További olvasnivaló