forked from ratiw/vuetable-2
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from kulmann/release-1.7.6
Version bump and housekeeping for release 1.7.6
- Loading branch information
Showing
4 changed files
with
13 additions
and
155 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,19 @@ | ||
[![npm](https://img.shields.io/npm/v/vuetable-2.svg)](https://www.npmjs.com/package/vuetable-2) | ||
[![npm](https://img.shields.io/npm/dt/vuetable-2.svg)](https://www.npmjs.com/package/vuetable-2) | ||
[![npm](https://img.shields.io/npm/l/vuetable-2.svg?maxAge=2592000)](https://github.com/ratiw/vuetable-2/blob/master/LICENSE) | ||
# Vuetable-2 | ||
|
||
# Vuetable-2 - data table simplify! | ||
|
||
--- | ||
|
||
## Vuetable-2 v2.0-beta is available now! | ||
|
||
See the [`next`](https://github.com/ratiw/vuetable-2/tree/next) branch. | ||
|
||
--- | ||
|
||
### Vuetable-2 works with Vue 2.x, vuetable is for Vue 1.x | ||
|
||
If you're looking for the version that's working with Vue 1.x, please go to [`vuetable`](https://github.com/ratiw/vue-table) repo. | ||
This is a fork of version 1.7.5 of [https://ratiw.github.io/vuetable-2](https://ratiw.github.io/vuetable-2). Please open an issue or submit a PR if you want to contribute. | ||
|
||
--- | ||
|
||
### Documentation and Tutorial | ||
|
||
Documentation is still under development, but you can view it at [https://ratiw.github.io/vuetable-2](https://ratiw.github.io/vuetable-2). Thanks to @cristijora for the help. | ||
Documentation by @ratiw and @cristijora can be found at [https://ratiw.github.io/vuetable-2](https://ratiw.github.io/vuetable-2). | ||
|
||
Meanwhile, check out | ||
Check out | ||
- the [Tutorial](https://github.com/ratiw/vuetable-2-tutorial/wiki) | ||
with follow-along project [here](https://github.com/ratiw/vuetable-2-tutorial). It should be enough to get you started. | ||
|
||
- [Sample project](https://github.com/ratiw/vuetable-2-with-laravel-5.4) using Vuetable-2 with Laravel 5.4 and Laravel-Mix | ||
|
||
If you've been using Vuetable for Vue 1.x before, checkout [what's changed](https://github.com/ratiw/vuetable-2/blob/master/changes.md) for info on changes from Vuetable for Vue 1.x and the [upgrade guide](https://github.com/ratiw/vuetable-2/blob/master/upgrade-guide.md) on how you could upgrade from Vuetable for Vue 1.x. | ||
|
||
You can now make use of Vue's scoped slot using the new `__slot` special field, thanks to @sjmarve. That means you are able to define action buttons per instance of a data table without depending on a globally defined component. | ||
|
||
Use scoped slot in parent when defining the actions [Vue Doc for scopped Slots](https://vuejs.org/v2/guide/components.html#Scoped-Slots) | ||
|
||
e.g. | ||
```html | ||
<template slot="actions" scope="props"> | ||
<div class="table-button-container"> | ||
<button class="btn btn-default" @click="onClick('edit-item', props.rowData)"><i class="fa fa-edit"></i> View</button> | ||
<button class="btn btn-danger" @click="onClick('delete-item', props.rowData)"><i class="fa fa-remove"></i> Edit</button> | ||
</div> | ||
</template> | ||
``` | ||
|
||
the onClick function can now be defined in the parent and the parent has Access to rowData and rowIndex via props. :) | ||
|
||
The original functionality still works | ||
|
||
# Breaking Changes | ||
## v1.6.0 | ||
- The `icons` prop of VuetablePagination is now moved into the `css` prop object. See this [codepen](https://codepen.io/ratiw/pen/GmJayw). | ||
|
||
# Example Code | ||
- Clone the project | ||
- Go into the cloned directory | ||
|
@@ -60,25 +22,12 @@ The original functionality still works | |
- Open browser to `http://localhost:8080` | ||
|
||
# Usage | ||
## NPM | ||
## NPM via Github - there is no npm release, yet. | ||
|
||
```shell | ||
npm install vuetable-2 --save-dev | ||
``` | ||
|
||
## Javascript via CDN | ||
Thanks to @cristijora for providing helps on this. | ||
```html | ||
// vuetable-2 dependencies | ||
<script src="https://cdnjs.cloudflare.com/ajax/libs/vue/2.2.6/vue.min.js"></script> | ||
<script src="https://cdnjs.cloudflare.com/ajax/libs/axios/0.16.1/axios.min.js"></script> | ||
// vuetable-2 | ||
<script src="https://unpkg.com/[email protected]"></script> | ||
Vue.use(Vuetable) | ||
npm install kulmann/vuetable-2 --save-dev | ||
``` | ||
This is demonstrated in this [jsfiddle](http://jsfiddle.net/CristiJ/z11fe07p/1318/). | ||
|
||
The `.use` from above will register all the components globally. | ||
```javascript | ||
function install(Vue){ | ||
Vue.component("vuetable", Vuetable); | ||
|
@@ -96,18 +45,17 @@ VueTablePaginationInfo: VueTable.VueTablePaginationInfo, | |
VueTablePaginationDropdown: VueTable.VueTablePaginationDropdown | ||
``` | ||
|
||
|
||
# Contributions | ||
Any contribution to the code (via pull request would be nice) or any part of the documentation and any idea and/or suggestion are very welcome. | ||
|
||
> __Note__ | ||
> For any bug fix, the PR should be forked from the `master` branch. And for any suggestion or additional feature, the PR should be forked from the `develop` branch, where it can be integrated and rolled out in the next release. | ||
> | ||
> If you are not sure, please ask by openning a new issue. | ||
> If you are not sure, please ask by opening a new issue. | ||
However, please do not feel bad if your pull requests or contributions do not get merged or implemented into Vuetable. | ||
|
||
Your contributions can, not only help make Vuetable better, but also push it away from what I intend to use it for. I just hope that you find it useful for your use or learn something useful from its source code. But remember, you can always fork it to make it work the way you want. | ||
Your contributions might not only help make Vuetable better, but also push it away from what I intend to use it for. I just hope that you find it useful for your use or learn something useful from its source code. But remember, you can always fork it to make it work the way you want. | ||
|
||
# License | ||
Vuetable is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
{ | ||
"name": "vuetable-2", | ||
"version": "1.7.5", | ||
"description": "Datatable component for Vue 2.x", | ||
"name": "@kulmann/vuetable-2", | ||
"version": "1.7.6", | ||
"description": "FORKED - Datatable component for Vue 2.x", | ||
"main": "dist/vuetable-2.js", | ||
"license": "MIT", | ||
"author": "Rati Wannapanop <[email protected]>", | ||
"author": "Benedikt Kulmann <[email protected]>", | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/ratiw/vuetable-2.git" | ||
"url": "git+https://github.com/kulmann/vuetable-2.git" | ||
}, | ||
"private": false, | ||
"keywords": [ | ||
|
This file was deleted.
Oops, something went wrong.