Skip to content

npm paket

@wink/elements npm paket je najhitrejši način za dodajanje Wink spletnih komponent v kateri koli JavaScript ali TypeScript projekt. Ponuja funkcijo load(), ki vključi CDN vire in popolne TypeScript deklaracije tipov za vse atribute komponent.

wink-travel/wink-elements na GitHubu Izvorna koda, API referenca in navodila za prispevanje.

Namestitev

npm install @wink/elements

Hiter začetek

Pokličite load() enkrat ob zagonu aplikacije. Je idempotentna — varno jo je klicati večkrat.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Nato uporabite katero koli Wink komponento v svojem HTML ali JSX:

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

Primeri za ogrodja

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 tipi

Vse vmesnike atributov komponent izvažamo za uporabo v JSX, predlogah ali tipiziranih slovarjih:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript bo zaznal neveljavne vrednosti layouta
  id: 'abc123',
  sort: 'POPULARITY',
};

Uporaba staging CDN

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

API

`load(options)`

Možnost	Tip	Obvezno	Privzeto	Opis
`clientId`	`string`	Da	—	Vaš Wink OAuth2 Client ID
`configurationId`	`string`	Ne	—	Izbirni ID za prilagoditev
`cdnBaseUrl`	`string`	Ne	`https://elements.wink.travel`	Prepišite URL CDN

Nadaljnje branje