Nuxt Nationカンファレンス開催!11月12日~13日

kql
nuxt-kql

Kirbyのクエリ言語APIのためのNuxtモジュール

nuxt-kql

Nuxt KQL

npm version

Nuxtモジュール for Kirbyのクエリ言語 API。

機能

  • 🔒 クエリ送信時のKirby認証情報の保護
  • 🪢 Kirby Headless Starter(推奨)によるトークンベース認証をサポート
  • 🤹 CORSの問題なし!
  • 🍱 useFetchコンポーザブルと同様にリクエストを処理
  • 🗃 クエリ応答のキャッシュ
  • 🦦 複数のスターターキットを用意
  • 🦾 ストロングタイプ

設定

!TIP📖 ドキュメントを読む

npx nuxi@latest module add kql

基本的な使用方法

!TIP📖 ドキュメントを読む

Nuxt KQLモジュールをNuxtの設定に追加

// `nuxt.config.ts`
export default defineNuxtConfig({
  modules: ['nuxt-kql']
})

そして、テンプレートでクエリを送信

<script setup lang="ts">
const { data, refresh, error, status, clear } = await useKql({
  query: 'site'
})
</script>

<template>
  <div>
    <h1>{{ data?.result?.title }}</h1>
    <pre>{{ JSON.stringify(data?.result, undefined, 2) }}</pre>
  </div>
</template>

💻 開発

  1. このリポジトリをクローンする
  2. Corepackcorepack enableを使用して有効にする
  3. pnpm installを使用して依存関係をインストールする
  4. pnpm run dev:prepareを実行する
  5. pnpm run devを使用して開発サーバーを起動する

ライセンス

MIT License © 2022-PRESENT Johann Schopplich