Preskočiť na obsah

balík npm

Balík @wink/elements npm je najrýchlejší spôsob, ako pridať Wink webové komponenty do akéhokoľvek JavaScriptového alebo TypeScriptového projektu. Poskytuje funkciu load(), ktorá injektuje CDN zdroje a kompletné TypeScriptové typové deklarácie pre všetky atribúty komponentov.

wink-travel/wink-elements na GitHub Zdrojový kód, API referencia a pokyny na prispievanie.

Inštalácia

npm install @wink/elements

Rýchly štart

Funkciu load() zavolajte raz pri spustení aplikácie. Je idempotentná — bezpečné ju volať viackrát.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Potom použite akýkoľvek Wink komponent vo vašom HTML alebo JSX:

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

Príklady pre frameworky

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 typy

Všetky rozhrania atribútov komponentov sú exportované na použitie v JSX, template literals alebo typovaných slovníkoch:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript zachytí neplatné hodnoty layoutu
  id: 'abc123',
  sort: 'POPULARITY',
};

Použitie staging CDN

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

API

`load(options)`

Možnosť	Typ	Povinné	Predvolené	Popis
`clientId`	`string`	Áno	—	Váš Wink OAuth2 Client ID
`configurationId`	`string`	Nie	—	Voliteľné ID prispôsobenia
`cdnBaseUrl`	`string`	Nie	`https://elements.wink.travel`	Prepíše URL CDN

Ďalšie čítanie