Vue 3

Vue 3 需要一個編譯器提示，將 <wink-*> 標籤視為原生自訂元素，而非未解析的 Vue 元件。之後，它們就像其他 HTML 元素一樣運作。

@wink/elements npm package 安裝並載入帶有 TypeScript 型別的 CDN 套件。

安裝

npm install @wink/elements

設定編譯器

Vite + Vue (`vite.config.ts`)

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          // 將所有以 "wink-" 開頭的標籤視為自訂元素
          isCustomElement: (tag) => tag.startsWith('wink-'),
        },
      },
    }),
  ],
});

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

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');

在模板中使用

<template>
  <main>
    <wink-content-loader layout="HOTEL" :id="layoutId" />
    <wink-lookup />
  </main>
</template>

<script setup lang="ts">
const layoutId = 'YOUR_LAYOUT_ID';
</script>

TypeScript — 擴充全域元素型別

Vue 3 + TypeScript 從全域的 HTMLElementTagNameMap 讀取自訂元素型別。新增一個宣告檔：

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;
  }
}

環境變數

新增至 .env.local：

VITE_WINK_CLIENT_ID=your-client-id

Vite 僅會將前綴為 VITE_ 的變數暴露給客戶端套件。

延伸閱讀