Saltar al contingut

paquet npm

El paquet npm @wink/elements és la manera més ràpida d’afegir components web de Wink a qualsevol projecte JavaScript o TypeScript. Proporciona una funció load() que injecta els recursos CDN i les declaracions completes de tipus TypeScript per a tots els atributs dels components.

wink-travel/wink-elements a GitHub Codi font, referència API i instruccions per contribuir.

Instal·lar

npm install @wink/elements

Inici ràpid

Crida load() una vegada a l’inici de l’aplicació. És idempotent — segur de cridar diverses vegades.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Després utilitza qualsevol component Wink al teu HTML o JSX:

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

Exemples per a frameworks

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

Tipus TypeScript

Totes les interfícies d’atributs dels components s’exporten per a ús en JSX, literals de plantilla o diccionaris tipats:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript detectarà valors de layout invàlids
  id: 'abc123',
  sort: 'POPULARITY',
};

Ús d’un CDN de staging

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

API

`load(options)`

Opció	Tipus	Obligatori	Per defecte	Descripció
`clientId`	`string`	Sí	—	El teu Client ID OAuth2 de Wink
`configurationId`	`string`	No	—	ID de personalització opcional
`cdnBaseUrl`	`string`	No	`https://elements.wink.travel`	Sobrescriu la URL del CDN

Més informació