Skip to content

npm paket

@wink/elements npm paket je najbrži način za dodavanje Wink web komponenti u bilo koji JavaScript ili TypeScript projekt. Pruža funkciju load() koja ubacuje CDN resurse i pune TypeScript deklaracije tipova za sve atribute komponenti.

wink-travel/wink-elements na GitHubu Izvorni kod, API referenca i upute za doprinos.

Instalacija

npm install @wink/elements

Brzi početak

Pozovite load() jednom pri pokretanju aplikacije. Funkcija je idempotentna — sigurno ju je pozvati više puta.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Zatim koristite bilo koju Wink komponentu u svom HTML-u ili JSX-u:

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

Primjeri za frameworke

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 tipovi

Sve su sučelja atributa komponenti izvezena za upotrebu u JSX-u, template literalima ili tipiziranim rječnicima:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript će uhvatiti nevažeće vrijednosti layouta
  id: 'abc123',
  sort: 'POPULARITY',
};

Korištenje staging CDN-a

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

API

`load(options)`

Opcija	Tip	Obavezno	Zadano	Opis
`clientId`	`string`	Da	—	Vaš Wink OAuth2 Client ID
`configurationId`	`string`	Ne	—	Opcionalni ID za prilagodbu
`cdnBaseUrl`	`string`	Ne	`https://elements.wink.travel`	Zamjena URL-a CDN-a

Daljnje čitanje