Pular para o conteúdo

pacote npm

O pacote npm @wink/elements é a maneira mais rápida de adicionar componentes web Wink a qualquer projeto JavaScript ou TypeScript. Ele fornece uma função load() que injeta os recursos do CDN e declarações completas de tipos TypeScript para todos os atributos dos componentes.

wink-travel/wink-elements no GitHub Código-fonte, referência da API e instruções para contribuição.

Instalação

npm install @wink/elements

Início rápido

Chame load() uma vez na inicialização do app. É idempotente — seguro chamar várias vezes.

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

load({ clientId: 'SEU_CLIENT_ID' });

Depois, use qualquer componente Wink no seu HTML ou JSX:

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

Exemplos por framework

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

Tipos TypeScript

Todas as interfaces de atributos dos componentes são exportadas para uso em JSX, template literals ou dicionários tipados:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript detectará valores inválidos para layout
  id: 'abc123',
  sort: 'POPULARITY',
};

Usando um CDN de staging

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

API

`load(options)`

Opção	Tipo	Obrigatório	Padrão	Descrição
`clientId`	`string`	Sim	—	Seu Client ID OAuth2 do Wink
`configurationId`	`string`	Não	—	ID de customização opcional
`cdnBaseUrl`	`string`	Não	`https://elements.wink.travel`	URL do CDN para sobrescrever

Leitura adicional