Skip to content
This repository was archived by the owner on Apr 1, 2022. It is now read-only.

Commit a702543

Browse files
author
Ken Berkeley
committed
Release v2.0.0
1 parent 1d133da commit a702543

File tree

162 files changed

+1445
-18373
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+1445
-18373
lines changed

‎.npmignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
.DS_Store
12
*.log
23
.git
34
node_modules
4-
docs
5+
doc
56
examples

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Vue2 Datatable
1+
# vue2-datatable-component
22

33
[![npm version][npm-v-img]][npm-url]
44
[![npm download][npm-dl-img]][npm-url]
55

6-
> The Best Datatable for Vue.js 2.x which never sucks
6+
> The best Datatable for Vue.js 2.x which never sucks
77
> `npm i -S vue2-datatable-component`
88
9-
[Documentation](https://OneWayTech.github.io/vue2-datatable/docs/_book) |
9+
[Documentation](https://OneWayTech.github.io/vue2-datatable/doc) |
1010
[Online examples](https://OneWayTech.github.io/vue2-datatable/examples/dist)
1111

1212
[npm-url]: https://www.npmjs.com/package/vue2-datatable-component

‎doc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
> Choose a language · 请选择语言
2+
3+
- [English](en/)
4+
- [中文](zh-cn/)

‎doc/_coverpage.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# vue2-datatable-component
2+
3+
> The best Datatable for Vue.js 2.x which never sucks
4+
5+
[GitHub](https://github.com/OneWayTech/vue2-datatable)
6+
[Online examples](https://onewaytech.github.io/vue2-datatable/examples/dist)

‎doc/_images/structure.png‎

93.3 KB
Loading

‎doc/_sidebar.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- Languages · 语言
2+
- [English](en/)
3+
- [中文](zh-cn/)

‎docs/en/DIY.md‎ renamed to ‎doc/en/DIY.md‎

File renamed without changes.

‎doc/en/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# § Summary
2+
3+
> This Datatable is only for Vue 2.x.
4+
> But you can downgrade it according to [Migration from Vue 1.x](https://vuejs.org/v2/guide/migration.html).
5+
> (In most of the time, you just have to replace `ref / key / <hooks>`)
6+
7+
There are plenty of open-source Datatables, but none of them could meet all the scenarios.
8+
(if there is, this project has no meanings at all)
9+
10+
This documentation is dedicated to letting you comprehend the design and the source code.
11+
Under this premise, you could build the most suitable Datatable for your own scenario.
12+
13+
The dependencies of this project are shown as below:
14+
15+
* BootStrap 3.x + Font Awesome 4.x（must available globally）
16+
* [lodash.orderBy](https://lodash.com/docs/4.17.4#orderBy)
17+
* [replace-with](https://github.com/kenberkeley/replace-with)
18+
19+
P.S. *BootStrap* and *Font Awesome* can be replaced with other popular libraries.
20+
(It seems to me that you just have to replace some classes / styles)

‎doc/en/_sidebar.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
- [Summary](en/README)
2+
- [Preparation](en/preparation)
3+
- [Getting started](en/getting-started)
4+
- [Details (click me)](en/details/README)
5+
- [`props` of Datatable](en/details/datatable-props)
6+
- [`:columns`](en/details/props-columns)
7+
- [`:data`](en/details/props-data)
8+
- [`:query`](en/details/props-query)
9+
- [`:selection`](en/details/props-selection)
10+
- [`:xprops`](en/details/props-xprops)
11+
- [Dynamic Components](en/details/dynamic-comps)
12+
- [I18N](en/i18n)
13+
- [DIY](en/DIY)
14+
- [Q & A (issues)](https://github.com/OneWayTech/vue2-datatable/issues)
15+
- [Changelog (releases)](https://github.com/OneWayTech/vue2-datatable/releases)

‎doc/en/details/README.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# § Details
2+
3+
It would be better for you to understand the structure of this Datatable before the details.
4+
5+
The source tree [`lib/`](https://github.com/OneWayTech/vue2-datatable/tree/master/lib) is shown as below:
6+
7+
```
8+
lib/
9+
├─ HeaderSettings/
10+
│   ├─ ColumnGroup.vue
11+
│   └─ index.vue
12+
├── MainTable
13+
│   ├─ _SCROLLBAR_WIDTH.js
14+
│   ├─ _syncScroll.js
15+
│   ├─ HeadSort.vue
16+
│   ├─ index.vue
17+
│   ├─ MultiSelect.vue
18+
│   ├─ TableBody.vue
19+
│   ├─ TableFooter.vue
20+
│   ├─ TableFrame.vue
21+
│   └─ TableHeader.vue
22+
├─ index.vue
23+
├─ LimitSelect.vue
24+
├─ Pagination.vue
25+
└─ props.mixin.js
26+
```
27+
28+
Here is the illustration for the tree above, which is captured from the advanced example (source: [`examples/src/Advanced/index.vue`](https://github.com/OneWayTech/vue2-datatable/blob/master/examples/src/Advanced/index.vue), demo: [examples#advanced](https://OneWayTech.github.io/vue2-datatable/examples/dist#advanced)):
29+
30+
<a href="_images/structure.png" target="_blank" title="Click to enlarge">
31+
<img src="_images/structure.png" alt="Structure">
32+
</a>

0 commit comments

Comments
 (0)