villus

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #llm #go #machine-learning #linux #nodejs #cli #kubernetes #openai #open-source

(★ 811)

🏎 A tiny and fast GraphQL client for Vue.js

File Explorer

Download Latest Version (.zip)

- config.json
- README.md
- config.yml
- - ci.yml
  - release.yml
- FUNDING.yml
- .gitignore
- commit-msg
- pre-commit
- - settings.json
  - types.d.ts
- - favicon.ico
  - loadTheme.js
  - logo.png
- - config.ts
  - env.d.ts
  - highlight.ts
  - light-theme.json
  - theme.json
- .gitignore
- astro.config.ts
- CHANGELOG.md
- package.json
- postcss.config.js
- tailwind.config.js
- tsconfig.json
- - CHANGELOG.md
  - package.json
- - CHANGELOG.md
  - package.json
- - README.md
- - CHANGELOG.md
  - LICENSE
  - package.json
  - README.md
- build.ts
- config.ts
- copy-mds.ts
- deploy-docs.sh
- generate-dts.ts
- info.ts
- tag-release.ts
.gitignore
.npmrc
CHANGELOG.md
commitlint.config.js
eslint.config.js
LICENSE
logo.png
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
prettier.config.js
README.md
tsconfig.json
vitest.config.js

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# villus

<h6 align="center">Villus is a finger-like structures in the small intestine. They help to absorb digested food.</h6>

<p align="center">
A small and fast GraphQL client for **Vue.js**
</p>

<br>

You can also help this this project and my other projects by donating one time or by sponsoring.

## Features

- 📦 **Minimal:** Its all you need to query GQL APIs
- 🦐 **Tiny:** Very small footprint
- 🗄 **Caching:** Simple and convenient query caching by default
- 👕 **TypeScript:** Written in Typescript and Supports GraphQL TS tooling
- 🖇 **Composable:** Built for the Composition API
- ⚡️ **Suspense:** Supports the `<Suspense>` API
- 🔌 **Plugins:** Use existing plugins and create custom ones

## Why use this

GraphQL is just a simple HTTP request. This library is meant to be a tiny client without all the bells and whistles attached to Apollo and its ecosystem which subsequently means it is faster across the board due to it's smaller bundle size and reduced overhead. `villus` offers simple strategies to cache and batch, dedup your GraphQL requests.

`villus` also supports file uploads and subscriptions without compromising bundle size through plugins.

If you are looking for a more full-featured client use [vue-apollo](https://github.com/vuejs/vue-apollo), it has everything you need.

You can read more about it in the [announcement post](https://logaretm.com/blog/2020-01-11-announcing-villus/).

## Documentation

You can find the [documentation here](https://villus.dev/)

## Quick Start

First install `villus`:

```bash
yarn add villus graphql

# or npm

npm install villus graphql --save
```

Or because villus is so simple, you can use it via CDN:

```html

<script src="https://unpkg.com/vue@3.0.2/dist/vue.global.js"></script>

<script src="https://unpkg.com/villus@latest/dist/villus.min.js"></script>
```

### Usage

Configure the GraphQL client for your root component:

```vue
<script setup>
import { useClient } from 'villus';

useClient({
  url: 'http://localhost:3002/graphql',
});
</script>
```

Then you can use `useQuery` in any child component:

```vue
<template>
  <div>
    <div v-if="data">
      <pre>{{ data }}</pre>
    </div>
  </div>
</template>

const AllPosts = `
  query AllPosts {
    posts {
      title
    }
  }
`;

const { data } = useQuery({
  query: AllPosts,
});
</script>
```

`villus` makes frequent tasks such as re-fetching, caching, deduplication, mutations, and subscriptions a breeze. It has even built-in `Suspense` support with Vue 3! Consult the [documentation](https://villus.dev) for more use-cases and examples.

## Compatibility

This library relies on the `fetch` web API to run queries, you can use [`unfetch`](https://github.com/developit/unfetch) (client-side) or [`node-fetch`](https://www.npmjs.com/package/node-fetch) (server-side) to use as a polyfill.

This library is compatible with Vue 3.0+ or 2.7+

## Examples

Live examples can be found [here](https://villus.dev/examples/basic-query)

## License

MIT

villus

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

villus

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README