Skip to content

npm pakki

@wink/elements npm pakkinn er fljótlegasta leiðin til að bæta Wink vefhlutum við hvaða JavaScript eða TypeScript verkefni sem er. Hann býður upp á load() fall sem sprautar inn CDN auðlindum og fullum TypeScript týpuyfirlýsingum fyrir alla eiginleika hluta.

wink-travel/wink-elements á GitHub Upprunakóði, API tilvísun og leiðbeiningar um framlag.

Setja upp

npm install @wink/elements

Fljótleg byrjun

Kallaðu á load() einu sinni við upphaf forritsins. Það er idempotent — öruggt að kalla á það mörgum sinnum.

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

load({ clientId: 'YOUR_CLIENT_ID' });

Notaðu svo hvaða Wink hluta sem er í HTML eða JSX:

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

Dæmi fyrir ramma

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 týpur

Allar viðmótsyfirlýsingar fyrir eiginleika hluta eru fluttar út til notkunar í JSX, sniðmátsstrengjum eða týpufestum orðabókum:

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

const attrs: WinkContentLoaderAttributes = {
  layout: 'HOTEL',    // TypeScript mun greina ógild layout gildi
  id: 'abc123',
  sort: 'POPULARITY',
};

Nota staging CDN

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

API

`load(options)`

Valkostur	Tegund	Nauðsynlegt	Sjálfgefið	Lýsing
`clientId`	`string`	Já	—	Þitt Wink OAuth2 Client ID
`configurationId`	`string`	Nei	—	Valfrjálst sérsniðna auðkenni
`cdnBaseUrl`	`string`	Nei	`https://elements.wink.travel`	Yfirskrifa CDN slóð

Frekari lesning