Giter Club home page Giter Club logo

vue-reactive-collection's Introduction

vue-reactive-collection

Installation

Reactive Map and Set for Vue 2.7

NPM

npm i vue-reactive-collection

Yarn

yarn add vue-reactive-collection

Usage

import { defineComponent } from '@vue/composition-api'
import { useReactiveSet, useReactiveMap } from 'vue-reactive-collection'

export default defineComponent({
  // ...
  setup() {
    const set = useReactiveSet()
    const map = useReactiveMap()

    return {
      set,
      map,
    }
  },
})

set and map will have the same methods as native Set and Map. They can be accessed via .value as you would do it with ref. The beauty of it is that they are completely reactive, so calling set.value.add/delete/clear or map.value.set/delete/clear will cause a template rerender.

Motivation

One of the Vue 2 drawbacks is the lack of a first class support for Map and Set. Though it has been recently implemented in Vue 3. The purpose of this library is to allow the usage of Map and Set in Vue 2 as you would use them in Vue 3.

During Vue 3 migration useReactiveSet and useReactiveMap will be replaced with Vue ref.

const set = useReactiveSet()

will become

const set = ref(new Set())

That's it, that simple.

The idea was adopted from @inca comment in this issue.

Q&A

How to pass an initial value

You can pass an initial value as you would it with native Map and Set.

const fruits = useReactiveSet(new Set(['apple', 'pear']))
const vegetables = useReactiveSet(['cabbage', 'onion'])
const fruits = useReactiveMap(
  new Map([
    ['apple', true],
    ['pear', true],
  ])
)
const vegetables = useReactiveMap([
  ['cabbage', true],
  ['onion', true],
])

Tests

npm test

Build

npm run build

License

MIT

vue-reactive-collection's People

Contributors

andrewvasilchuk avatar dutchgerman avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.