SolidJS

SolidJS 具備原生自訂元素支援 — 它會直接將屬性傳遞到 DOM，無需虛擬 DOM 層。無需額外的編譯器設定。

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

安裝

npm install @wink/elements

在應用程式啟動時載入一次

import { onMount } from 'solid-js';
import { load } from '@wink/elements';

export default function App() {
  onMount(() => {
    load({ clientId: import.meta.env.VITE_WINK_CLIENT_ID });
  });

  return <YourRoutes />;
}

onMount 僅在瀏覽器中初次渲染後執行 — 它是 SolidJS 中相當於 React 的 useEffect(() => {}, [])。

在 JSX 中使用

import { createSignal } from 'solid-js';

export default function HotelsPage() {
  const [layoutId] = createSignal('YOUR_LAYOUT_ID');

  return (
    <main>
      <wink-content-loader layout="HOTEL" id={layoutId()} />
      <wink-lookup />
    </main>
  );
}

TypeScript — 宣告 JSX 內建元素

SolidJS 使用自己的 JSX 命名空間。擴充 solid-js 的 JSX 型別：

import type {
  WinkContentLoaderAttributes,
  WinkLookupAttributes,
  WinkSearchButtonAttributes,
  WinkAccountButtonAttributes,
  WinkItineraryButtonAttributes,
  WinkShoppingCartButtonAttributes,
  WinkAppLoaderAttributes,
} from '@wink/elements';

declare module 'solid-js' {
  namespace JSX {
    interface IntrinsicElements {
      'wink-content-loader': WinkContentLoaderAttributes & JSX.DOMAttributes<HTMLElement>;
      'wink-lookup': WinkLookupAttributes & JSX.DOMAttributes<HTMLElement>;
      'wink-search-button': WinkSearchButtonAttributes & JSX.DOMAttributes<HTMLElement>;
      'wink-account-button': WinkAccountButtonAttributes & JSX.DOMAttributes<HTMLElement>;
      'wink-itinerary-button': WinkItineraryButtonAttributes & JSX.DOMAttributes<HTMLElement>;
      'wink-shopping-cart-button': WinkShoppingCartButtonAttributes & JSX.DOMAttributes<HTMLElement>;
      'wink-app-loader': WinkAppLoaderAttributes & JSX.DOMAttributes<HTMLElement>;
    }
  }
}

SolidStart (SSR)

對於使用伺服器端渲染的 SolidStart 應用程式，請用 isServer 來保護 load() 呼叫：

import { onMount } from 'solid-js';
import { isServer } from 'solid-js/web';
import { load } from '@wink/elements';

export default function App() {
  if (!isServer) {
    onMount(() => {
      load({ clientId: import.meta.env.VITE_WINK_CLIENT_ID });
    });
  }

  return <YourRoutes />;
}

延伸閱讀