Перейти к содержимому

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`	Да	—	Ваш OAuth2 Client ID Wink
`configurationId`	`string`	Нет	—	Необязательный ID настройки
`cdnBaseUrl`	`string`	Нет	`https://elements.wink.travel`	Переопределение URL CDN

Дополнительные материалы