דלגו לתוכן

חבילת npm

חבילת ה-@wink/elements ב-npm היא הדרך המהירה ביותר להוסיף רכיבי ווב של 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',
};

שימוש ב-CDN של סביבה ניסיונית

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

API

`load(options)`

אפשרות	סוג	חובה	ברירת מחדל	תיאור
`clientId`	`string`	כן	—	מזהה הלקוח OAuth2 של Wink שלך
`configurationId`	`string`	לא	—	מזהה התאמה אישית אופציונלי
`cdnBaseUrl`	`string`	לא	`https://elements.wink.travel`	כתובת URL ל-CDN להחלפה

קריאה נוספת