Vue 3
Vue 3 reikia vienos kompiliatoriaus užuominos, kad <wink-*> žymos būtų traktuojamos kaip natūralūs pasirinktinių elementų vietoje neišspręsti Vue komponentai. Po to jie veikia kaip bet kuris kitas HTML elementas.
@wink/elements npm paketas Įdiekite ir įkelkite CDN paketą su TypeScript tipais.
Įdiegimas
Section titled “Įdiegimas”npm install @wink/elementsKompiliatoriaus konfigūravimas
Section titled “Kompiliatoriaus konfigūravimas”Vite + Vue (vite.config.ts)
Section titled “Vite + Vue (vite.config.ts)”import { defineConfig } from 'vite';import vue from '@vitejs/plugin-vue';
export default defineConfig({ plugins: [ vue({ template: { compilerOptions: { // Traktuokite visas žymas, prasidedančias "wink-", kaip pasirinktinius elementus isCustomElement: (tag) => tag.startsWith('wink-'), }, }, }), ],});Vue CLI (vue.config.js)
Section titled “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-'), }, })); },};CDN įkėlimas vieną kartą programos paleidimo metu
Section titled “CDN įkėlimas vieną kartą programos paleidimo metu”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');Naudojimas šablonuose
Section titled “Naudojimas šablonuose”<template> <main> <wink-content-loader layout="HOTEL" :id="layoutId" /> <wink-lookup /> </main></template>
<script setup lang="ts">const layoutId = 'YOUR_LAYOUT_ID';</script>TypeScript — globalių elementų tipų papildymas
Section titled “TypeScript — globalių elementų tipų papildymas”Vue 3 + TypeScript skaito pasirinktinių elementų tipus iš globalios HTMLElementTagNameMap. Pridėkite deklaracijos failą:
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; }}Aplinkos kintamieji
Section titled “Aplinkos kintamieji”Pridėkite į .env.local:
VITE_WINK_CLIENT_ID=your-client-idVite klientų paketui atskleidžia tik kintamuosius, prasidedančius VITE_.