Перейти до вмісту

npm пакет

Пакет @wink/elements — це найшвидший спосіб додати веб-компоненти 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, шаблонних рядках або типізованих словниках:

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`	Перевизначення URL CDN

Додаткова інформація