https://github.com/lassehaslev/restful-vue
https://github.com/lassehaslev/restful-vue
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/lassehaslev/restful-vue
- Owner: LasseHaslev
- License: mit
- Created: 2016-07-05T14:50:03.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-08T13:52:29.000Z (about 10 years ago)
- Last Synced: 2025-02-23T18:17:02.658Z (over 1 year ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# @lassehaslev/restful-vue
> Helpers for showing, update and delete elements
## Install
Run ```npm install @lassehaslev/restful-vue --save``` in your project folder
This class contains mixins for making the use of restful apis easier.
We help you to add new items, update items and remove them from index with simple steps.
## Usage
To get any of the mixins just get what you want from the ```@lassehaslev/restful-vue```
``` js
import Vue from 'vue'
// Install plugin and dependencies
import RestfulVue from '@lassehaslev/restful-vue';
Vue.use( RestfulVue );
// Import everything
import { container, create, update, remove } from '@lassehaslev/restful-vue'
// If you only want the container
import { container } from '@lassehaslev/restful-vue'
```
#### Container
The container mixin is to handle list of items and index. This is also where we add newly created models, and remove them on delete.
The container is also the home of the objects that uses the [Create mixin](###Create ) and [Edit mixin](###Edit).
``` html
import { container } from '@lassehaslev/restful-vue'
module.exports = {
mixins: [ container ],
components: {
Create,
Edit,
}
}
```
#### Create
Create is the mixin thats create an elements an push it in to the container
``` html
Create
import { create } from '@lassehaslev/restful-vue'
module.exports = {
mixins: [ create ],
}
```
#### Update and Delete
The update mixin is for updating items. When updated the new items goes into the container index list.
The Delete sends out that the item should be deleted and it gets removed from the container.
``` html
Update
X
import { update, remove } from '@lassehaslev/restful-vue'
module.exports = {
mixins: [ update, remove ],
}
```
## Development
``` bash
# install dependencies
npm install
# serve with hot reload at localhost:8080
npm run dev
```