kql
nuxt-kirby

Kirbyのクエリ言語API用Nuxtモジュール
6ダウンロード47スターv3.0.2
johannschopplichjohannschopplich

Nuxt Kirby module

Nuxt Kirby

Nuxtモジュールで、Kirby CMSと連携し、Kirbyのクエリ言語APIをサポートします。

機能

  • 🔒 クエリ送信時のKirby認証情報を保護
  • 🪢 Kirby Headlessプラグインによるトークンベース認証をサポート（推奨）
  • 🍱 useFetchコンポーザブルと同様にリクエストを処理
  • 🦦 複数のスターターキットが利用可能
  • 🗃 キャッシュされたクエリ応答
  • 🤹 CORS問題なし！
  • 🦾 強力な型付け

セットアップ

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

npx nuxi@latest module add kirby

基本的な使い方

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

Nuxt KirbyモジュールをNuxtの設定に追加してください

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

そしてテンプレートでクエリを送信してください

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

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

💻 開発

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

ライセンス

MITライセンス © 2022-PRESENT Johann Schopplich