Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ratiw/vuetable-2

data table simplify! -- datatable component for Vue 2.x. See documentation at
https://github.com/ratiw/vuetable-2

component datatable pagination-components vue

Last synced: 2 months ago
JSON representation

data table simplify! -- datatable component for Vue 2.x. See documentation at

Lists

README 

        
[![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 - 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.



---



### 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.



Meanwhile, 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



    


         View  

         Edit  

    



```



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

- `npm install`

- `npm run dev`

- Open browser to `http://localhost:8080`



# Usage

## NPM



```shell

npm install vuetable-2 --save-dev

```



## Javascript via CDN

Thanks to @cristijora for providing helps on this.

```html

// vuetable-2 dependencies



// vuetable-2



Vue.use(Vuetable)

```

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);

  Vue.component("vuetable-pagination", VueTablePagination);

  Vue.component("vuetable-pagination-dropdown", VueTablePaginationDropDown);

  Vue.component("vuetable-pagination-info", VueTablePaginationInfo);

}

```



Also you have the ability to access certain components if you need them:

```javascript

VueTable: VueTable.default/VueTable.VueTable,

VueTablePagination: VueTable.VueTablePagination,

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.



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.



# License

Vuetable is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).