Skip to content

Commit d6a7199

Browse files
update docs
1 parent 1186e82 commit d6a7199

File tree

5 files changed

+84
-186
lines changed

5 files changed

+84
-186
lines changed

README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,9 @@ public function all(Request $request)
6363
```html
6464
// resources/posts/index.blade.php
6565

66-
<x-app-layout>
67-
68-
69-
70-
7166
<data-table
7267
:config="{
73-
url: `/{{app()->getLocale()}}/admin/posts/all?page=1`,
68+
url: `posts/all?page=1`,
7469
},
7570
}"
7671
:columns="[
@@ -119,12 +114,4 @@ public function all(Request $request)
119114
"
120115

121116
></data-table>
122-
123-
124-
125-
126-
127-
</x-app-layout>
128-
}
129-
130117
```

_docs/1-introduction.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,9 @@ public function all(Request $request)
6262

6363
```html
6464
// resources/posts/index.blade.php
65-
66-
<x-app-layout>
67-
68-
69-
70-
7165
<data-table
7266
:config="{
73-
url: `/{{app()->getLocale()}}/admin/posts/all?page=1`,
67+
url: `posts/all?page=1`,
7468
},
7569
}"
7670
:columns="[
@@ -119,12 +113,4 @@ public function all(Request $request)
119113
"
120114

121115
></data-table>
122-
123-
124-
125-
126-
127-
</x-app-layout>
128-
}
129-
130116
```

_docs/2-Installation-and-Setup.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,20 @@
1010

1111
## Installation
1212

13-
There is two-step to install packages
13+
## Requirements
1414

15+
* [Vue.js](https://vuejs.org/) => 2.x
16+
* [Laravel](http://laravel.com/docs/) => 7.x
17+
* [Tailwind](https://tailwindcss.com/) => 1.*
18+
19+
for install and setup them we will work on the server-side and client-side , using few steps
1520
## server side
1621

17-
step 1
22+
#### step 1
1823
```bash
1924
composer require yazan/laravel-datatable
2025
```
21-
step 2
26+
#### step 2
2227

2328
create grid class
2429
```bash
@@ -27,11 +32,11 @@ php artisan make:grid-class exampleGrid
2732

2833
## clint side
2934

30-
step 1
35+
#### step 1
3136
```bash
3237
npm i @yazan.alnughnugh/vue-datatable
3338
```
34-
step 2
39+
#### step 2
3540
```javascript
3641
// app/resources/js/app.js
3742

_docs/3-Configuration.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,14 @@
9191

9292
| Name | Type | Default | Description
9393
| --- | --- | --- | --- |
94-
| `filter` | Object | {} | Add filters data |
95-
| `filter.selection` | Object | {} | the object contains all filter selection data |
96-
| `filter.selection.show` | Bool | true | to disable or enable selection filter |
97-
| `filter.selection.data` | Object | {} | the object is array contains all select input options |
98-
| `filter.selection.data.label` | String | '' | name appears beside select input |
99-
| `filter.selection.data.relation` | String | '' | relation name you will get it |
100-
| `filter.selection.data.column` | String | '' | column name you will get it |
101-
| `filter.selection.data.rows` | Json | [{}] | all rows from the database as JSON |
94+
| `filters` | Object | {} | Add filters data |
95+
| `filters.selection` | Object | {} | the object contains all filter selection data |
96+
| `filters.selection.show` | Bool | true | to disable or enable selection filter |
97+
| `filters.selection.data` | Object | {} | the object is array contains all select input options |
98+
| `filters.selection.data.label` | String | '' | name appears beside select input |
99+
| `filters.selection.data.relation` | String | '' | relation name you will get it |
100+
| `filters.selection.data.column` | String | '' | column name you will get it |
101+
| `filters.selection.data.rows` | Json | [{}] | all rows from the database as JSON |
102102

103103

104104

@@ -123,7 +123,6 @@
123123
"
124124
></data-table>
125125
```
126-
|
127126

128127
| Name | Type | Default | Description
129128
| --- | --- | --- | --- |

0 commit comments

Comments
 (0)