0.12.2 โข Published 2 years ago
nuxt-kirbyql v0.12.2
nuxt-kql
Features
- ๐ Protect your Kirby credentials when sending queries
- ๐ชข Supports token-based authentication with kirby-headless-starter (recommended)
- ๐คน No CORS issues!
- ๐ฑ Handle request just like with the
useFetch
composable - ๐ Cached query responses
- ๐ฆพ Strongly typed
Setup
# pnpm
pnpm add -D nuxt-kql
# npm
npm i -D nuxt-kql
Basic Usage
Add nuxt-kql
to your Nuxt config:
// `nuxt.config.ts`
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
modules: ['nuxt-kql'],
})
And send queries in your template:
<script setup lang="ts">
const { data, pending, refresh, error } = await useKql({
query: 'site',
})
</script>
<template>
<div>
<h1>{{ data?.result?.title }}</h1>
<pre>{{ JSON.stringify(data?.result, undefined, 2) }}</pre>
</div>
</template>
๐ป Development
- Clone this repository
- Enable Corepack using
corepack enable
(usenpm i -g corepack
for Node.js < 16.10) - Install dependencies using
pnpm install
- Run
pnpm run dev:prepare
- Start development server using
pnpm run dev
License
MIT License ยฉ 2022 Johann Schopplich