Skip to content

Commit 5f37889

Browse files
committed
- Update readme
1 parent 88e93b6 commit 5f37889

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,12 @@
44
[![StyleCI](https://styleci.io/repos/250246992/shield?style=plastic)](https://github.styleci.io/repos/250246992)
55
[![Total Downloads](https://img.shields.io/packagist/dt/rappasoft/laravel-livewire-tables.svg?style=flat-square)](https://packagist.org/packages/rappasoft/laravel-livewire-tables)
66

7-
A Laravel Livewire component for data tables.
8-
97
**This package is currently in development and the source is constantly changing, use at your own risk.**
108

9+
A dynamic Laravel Livewire component for data tables.
10+
11+
This plugin assumes you already have [Laravel Livewire](https://laravel-livewire.com/) installed and configured in your project.
12+
1113
## Installation
1214

1315
You can install the package via composer:
@@ -80,6 +82,20 @@ public function query() : Builder;
8082
public function columns() : array;
8183
```
8284

85+
### Rendering the table
86+
87+
Place the following where you want the table to appear.
88+
89+
Laravel 6.x:
90+
91+
`@livewire('users-table')`
92+
93+
Laravel 7.x:
94+
95+
`<livewire:users-table />`
96+
97+
Obviously replace *users-table* with your component name.
98+
8399
### Defining Columns
84100

85101
You can define the columns of your table with the column class:

0 commit comments

Comments
 (0)