Pinia Colada logo


npm package build status


# Pinia Colada > The missing data fetching layer for Vue. Built on top of [Pinia](https://pinia.vuejs.org) Pinia Colada makes data fetching in Vue applications a breeze. It's built on top of [Pinia](https://pinia.vuejs.org) and takes away all of the complexity and boilerplate that comes with fetching data. It's fully typed and tree-shakeable, and it's built with the same principles as Pinia and Vue: It's approachable, flexible, powerful and can be progressively adopted. > [!TIP] > This is a feature-complete version of the exercises from [Mastering Pinia](https://masteringpinia.com/?utm=pinia-colada-readme). If you would like to learn how it started and become an expert in Vue state management, check it out! > > > Mastering Pinia banner > ## Features - ⚡️ **Automatic caching**: Smart client-side caching with request deduplication - 🗄️ **Async State**: Simplified async state management - 🔌 **Plugins**: Powerful plugin system - ✨ **Optimistic Updates**: UI that updates before the server responds - 💡 **Sensible defaults**: Works well out of the box while remaining fully configurable - 🧩 **Out-of-the box plugins**: Auto refetch, delay loading, and more - 📚 **Typescript Support**: Best-in-class TypeScript support - 💨 **Small Bundle Size**: A baseline of ~2kb and fully tree-shakeable - 📦 **Zero Dependencies**: No dependencies other than Pinia - ⚙️ **SSR**: Out of the box server-side rendering support > [!NOTE] > Pinia Colada is always trying to improve and evolve. > Feedback regarding new and existing options and features is very welcome! > Contribution to documentation, issues, and pull requests are highly appreciated. ## Installation ```sh npm install pinia @pinia/colada ``` Install the plugins for the features you need: ```ts import { createPinia } from 'pinia' import { PiniaColada } from '@pinia/colada' app.use(createPinia()) // install after pinia app.use(PiniaColada, { // optional options }) ``` ## Usage The core of Pinia Colada is the `useQuery` and `useMutation` functions. They are used to read data and write it respectively. Here's a simple example: ```vue ``` Learn more about the core concepts and how to use them in the [documentation](https://pinia-colada.esm.dev). ## License [MIT](http://opensource.org/licenses/MIT)