vue-composable

vue-composable

Vue 3

This version is alpha with support for the vue3 (vue-next)

Check webpack vue3 example or CodeSandbox

Introduction

vue-composable is out-of-box ready to use the brand new Vue 3 composition-api generic components.

100% typescript based composable components and full type support out-of-box.

Installing

# install with yarn
yarn add @vue/composition-api vue-composable

# install with npm
npm install @vue/composition-api vue-composable

Documentation

NOTE documentation might be slightly wrong, because it was built for the v2

Check our documentation

Event

• Event - Attach event listener to a DOM element
• Mouse Move - Attach mousemove listener to a DOM element
• Resize - Attach resize listener to a DOM element
• Scroll - Attach scroll listener to a DOM element

MISC

• localStorage - Reactive access to a localStorage
• matchMedia - Reactive matchMedia
• breakpoint - reactive breakpoints based on window.innerWidth

Pagination

• Pagination - Generic reactive pagination controls
• Array Pagination - Array pagination

Promise

• Promise - Promise reactive resolve and reject
• Cancellable Promise - Allow to cancel promises
• Retry - Provides functionality to retry promise

Web

• Fetch - reactive fetch wrapper
• WebSocket - reactive WebSocket wrapper
• IntersectionObserver - reactive IntersectionObserver

External

New packages needed

• Axios - @vue-composable/axios reactive axios wrapper client

Examples

Check out the examples folder or start hacking on codesandbox.

NOTE

Currently only works with composition-api, when Vue3 gets release I will update to use the new reactive system (using @vue/reactivity)

Usage

<template>
  <div>
    <p>page {{ currentPage }} of {{ lastPage }}</p>
    <p>
      <button @click="prev">prev</button>
      <button @click="next">next</button>
    </p>
    <ul>
      <li v-for="n in result" :key="n">
        {{ n }}
      </li>
    </ul>
  </div>
</template>

<script>
import { useArrayPagination } from "vue-composable";

export default {
  setup() {
    const array = new Array(1000).fill(0).map((_, i) => i);
    const { result, next, prev, currentPage, lastPage } = useArrayPagination(
      array,
      {
        pageSize: 3
      }
    );

    return { result, next, prev, currentPage, lastPage };
  }
};
</script>

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b feat/new-composable
3. Commit your changes: git commit -am 'feat(composable): add a new composable'
4. Push to the branch: git push origin feat/new-composable
5. Submit a pull request

License

MIT