Skip to content

npm пакет

@wink/elements npm пакетът е най-бързият начин да добавите Wink уеб компоненти към всеки JavaScript или TypeScript проект. Той предоставя функция load(), която инжектира CDN ресурсите и пълните TypeScript декларации за типове за всички атрибути на компонентите.

wink-travel/wink-elements в GitHub Изходен код, API справочник и инструкции за принос.

Инсталиране

npm install @wink/elements

Бърз старт

Извикайте load() веднъж при стартиране на приложението. Функцията е идемпотентна — безопасно е да се извиква многократно.

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

load({ clientId: 'YOUR_CLIENT_ID' });

След това използвайте всеки Wink компонент в HTML или JSX:

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

Примери за фреймуъркове

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 типове

Всички интерфейси за атрибути на компонентите са експортирани за използване в JSX, template literals или типизирани речници:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript ще засече невалидни стойности за layout
  id: 'abc123',
  sort: 'POPULARITY',
};

Използване на staging CDN

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

API

`load(options)`

Опция	Тип	Задължително	По подразбиране	Описание
`clientId`	`string`	Да	—	Вашият Wink OAuth2 Client ID
`configurationId`	`string`	Не	—	Опционален ID за персонализация
`cdnBaseUrl`	`string`	Не	`https://elements.wink.travel`	Презаписване на CDN URL

Допълнително четене