Vue 3
Vue 3 nepieciešama viena kompilatora norāde, lai apstrādātu <wink-*> tagus kā vietējos pielāgotos elementus, nevis kā neatpazītus Vue komponentus. Pēc tam tie darbojas kā jebkurš cits HTML elements.
@wink/elements npm package Instalējiet un ielādējiet CDN pakotni ar TypeScript tipiem.
Instalēšana
Section titled “Instalēšana”npm install @wink/elementsKompilatora konfigurēšana
Section titled “Kompilatora konfigurēšana”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: { // Apstrādā visus tagus, kas sākas ar "wink-", kā pielāgotus 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 ielāde vienreiz lietotnes startēšanas laikā
Section titled “CDN ielāde vienreiz lietotnes startēšanas laikā”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');Lietošana šablonos
Section titled “Lietošana šablonos”<template> <main> <wink-content-loader layout="HOTEL" :id="layoutId" /> <wink-lookup /> </main></template>
<script setup lang="ts">const layoutId = 'YOUR_LAYOUT_ID';</script>TypeScript — globālo elementu tipu papildināšana
Section titled “TypeScript — globālo elementu tipu papildināšana”Vue 3 + TypeScript nolasa pielāgoto elementu tipus no globālā HTMLElementTagNameMap. Pievienojiet deklarācijas failu:
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; }}Vides mainīgie
Section titled “Vides mainīgie”Pievienojiet .env.local:
VITE_WINK_CLIENT_ID=your-client-idVite klienta pakotnei atklāj tikai mainīgos, kas sākas ar VITE_.