Skip to content

pakej npm

Pakej @wink/elements npm adalah cara terpantas untuk menambah komponen web Wink ke mana-mana projek JavaScript atau TypeScript. Ia menyediakan fungsi load() yang menyuntik sumber CDN dan deklarasi jenis TypeScript penuh untuk semua atribut komponen.

wink-travel/wink-elements di GitHub Kod sumber, rujukan API, dan arahan sumbangan.

Pasang

npm install @wink/elements

Mula dengan cepat

Panggil load() sekali pada permulaan aplikasi. Ia idempotent — selamat dipanggil berulang kali.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Kemudian gunakan mana-mana komponen Wink dalam HTML atau JSX anda:

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

Contoh rangka kerja

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 });
  }
}

Jenis TypeScript

Semua antara muka atribut komponen dieksport untuk digunakan dalam JSX, literal templat, atau kamus bertipe:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript akan mengesan nilai layout yang tidak sah
  id: 'abc123',
  sort: 'POPULARITY',
};

Menggunakan CDN staging

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

API

`load(options)`

Pilihan	Jenis	Wajib	Lalai	Penerangan
`clientId`	`string`	Ya	—	ID Klien OAuth2 Wink anda
`configurationId`	`string`	Tidak	—	ID penyesuaian pilihan
`cdnBaseUrl`	`string`	Tidak	`https://elements.wink.travel`	Gantikan URL CDN

Bacaan lanjut