Vue 3
Vue 3 potrzebuje jednej wskazówki kompilatora, aby traktować tagi <wink-*> jako natywne elementy niestandardowe zamiast nierozpoznanych komponentów Vue. Po tym działają jak każdy inny element HTML.
@wink/elements npm package Zainstaluj i załaduj pakiet CDN z typami TypeScript.
Instalacja
Dział zatytułowany „Instalacja”npm install @wink/elementsKonfiguracja kompilatora
Dział zatytułowany „Konfiguracja kompilatora”Vite + Vue (vite.config.ts)
Dział zatytułowany „Vite + Vue (vite.config.ts)”import { defineConfig } from 'vite';import vue from '@vitejs/plugin-vue';
export default defineConfig({ plugins: [ vue({ template: { compilerOptions: { // Traktuj wszystkie tagi zaczynające się od "wink-" jako elementy niestandardowe isCustomElement: (tag) => tag.startsWith('wink-'), }, }, }), ],});Vue CLI (vue.config.js)
Dział zatytułowany „Vue CLI (vue.config.js)”module.exports = { chainWebpack(config) { config.module .rule('vue') .use('vue-loader') .tap((options) => ({ ...options, compilerOptions: { isCustomElement: (tag) => tag.startsWith('wink-'), }, })); },};Załaduj CDN raz przy starcie aplikacji
Dział zatytułowany „Załaduj CDN raz przy starcie aplikacji”import { createApp } from 'vue';import App from './App.vue';import { load } from '@wink/elements';
load({ clientId: import.meta.env.VITE_WINK_CLIENT_ID });
createApp(App).mount('#app');Użycie w szablonach
Dział zatytułowany „Użycie w szablonach”<template> <main> <wink-content-loader layout="HOTEL" :id="layoutId" /> <wink-lookup /> </main></template>
<script setup lang="ts">const layoutId = 'YOUR_LAYOUT_ID';</script>TypeScript — rozszerz globalne typy elementów
Dział zatytułowany „TypeScript — rozszerz globalne typy elementów”Vue 3 + TypeScript odczytuje typy elementów niestandardowych z globalnego HTMLElementTagNameMap. Dodaj plik deklaracji:
import type { WinkContentLoaderAttributes, WinkLookupAttributes, WinkSearchButtonAttributes, WinkAccountButtonAttributes, WinkItineraryButtonAttributes, WinkShoppingCartButtonAttributes, WinkAppLoaderAttributes,} from '@wink/elements';
declare global { interface HTMLElementTagNameMap { 'wink-content-loader': HTMLElement & WinkContentLoaderAttributes; 'wink-lookup': HTMLElement & WinkLookupAttributes; 'wink-search-button': HTMLElement & WinkSearchButtonAttributes; 'wink-account-button': HTMLElement & WinkAccountButtonAttributes; 'wink-itinerary-button': HTMLElement & WinkItineraryButtonAttributes; 'wink-shopping-cart-button': HTMLElement & WinkShoppingCartButtonAttributes; 'wink-app-loader': HTMLElement & WinkAppLoaderAttributes; }}Zmienne środowiskowe
Dział zatytułowany „Zmienne środowiskowe”Dodaj do .env.local:
VITE_WINK_CLIENT_ID=your-client-idVite udostępnia klientowi tylko zmienne z prefiksem VITE_.