Siirry sisältöön

npm-paketti

@wink/elements npm-paketti on nopein tapa lisätä Wink-web-komponentit mihin tahansa JavaScript- tai TypeScript-projektiin. Se tarjoaa load()-funktion, joka lataa CDN-resurssit ja täydelliset TypeScript-tyyppimääritykset kaikille komponenttien attribuuteille.

wink-travel/wink-elements GitHubissa Lähdekoodi, API-viite ja ohjeet osallistumiseen.

Asennus

npm install @wink/elements

Nopeasti alkuun

Kutsu load()-funktiota kerran sovelluksen käynnistyessä. Se on idempotentti — turvallista kutsua useita kertoja.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Sitten voit käyttää mitä tahansa Wink-komponenttia HTML:ssä tai JSX:ssä:

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

Kehysesimerkit

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-tyypit

Kaikki komponenttien attribuuttirajapinnat on viety käytettäväksi JSX:ssä, template-litteraaleissa tai tyypitetyissä sanakirjoissa:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript havaitsee virheelliset layout-arvot
  id: 'abc123',
  sort: 'POPULARITY',
};

Käyttö staging-CDN:n kanssa

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

API

`load(options)`

Vaihtoehto	Tyyppi	Pakollinen	Oletus	Kuvaus
`clientId`	`string`	Kyllä	—	Wink OAuth2 Client ID
`configurationId`	`string`	Ei	—	Valinnainen mukautus-ID
`cdnBaseUrl`	`string`	Ei	`https://elements.wink.travel`	CDN-URL:n korvaus

Lisälukemista