Add docs

Author: rappasoft

.gitattributes

@@ -12,3 +12,4 @@
 /psalm.xml              export-ignore
 /psalm.xml.dist         export-ignore
 /testbench.yaml         export-ignore
+/docs                   export-ignore

.gitignore

@@ -5,7 +5,6 @@
 build
 composer.lock
 coverage
-docs
 phpunit.xml
 psalm.xml
 testbench.yaml

docs/_index.md

@@ -0,0 +1,6 @@
+---
+title: v2
+slogan: A dynamic table component for Laravel Livewire.
+githubUrl: https://github.com/rappasoft/laravel-livewire-tables
+branch: master
+---

docs/bulk-actions/_index.md

@@ -0,0 +1,4 @@
+---
+title: Bulk Actions
+weight: 6
+---

docs/bulk-actions/creating-bulk-actions.md

@@ -0,0 +1,46 @@
+---
+title: Creating bulk actions
+weight: 2
+---
+
+To create bulk actions, you must specify a `method` and a `button title` in the `$bulkActions` component property.
+
+```php
+public array $bulkActions = [
+    'exportSelected' => 'Export',
+];
+```
+
+------
+
+**The following method is only available in v1.16 and above**
+
+As of v1.16 you can define bulk action with a method, so you can perform other actions to determine what your actions are or perform translations on the strings:
+
+```php
+public function bulkActions(): array
+{
+    // Figure out what actions the admin gets
+    ...
+
+    return [
+        'activate'   => __('Activate'),
+        'deactivate' => __('Deactivate'),
+    ];
+}
+```
+
+------
+
+The **key** is the Livewire method to call, and the value is the name of the item in the bulk actions dropdown.
+
+You can define your method to do whatever you want:
+
+```php
+public function exportSelected()
+{
+    // Do something with the selected rows.
+}
+```
+
+See [Getting the selected rows query](./getting-the-selected-rows-query) or [Getting the selected keys](./getting-the-selected-keys) to understand how to work with the selected data.

docs/bulk-actions/getting-the-selected-keys.md

@@ -0,0 +1,27 @@
+---
+title: Selected keys
+weight: 4
+---
+
+If you would like access to just the selected primary keys in your bulk action method, you may use the `selectedKeys` property which return an array of the selected primary keys:
+
+```php
+public function exportSelected()
+{
+    if (count($this->selectedKeys)) {
+        // Do something with the selected rows
+        dd($this->selectedKeys);
+
+//        => [
+//            1,
+//            2,
+//            3,
+//            4,
+//        ]   
+    }
+
+    // Notify there is nothing to export
+}
+```
+
+**Note:** See [The primary key](../usage/the-primary-key) about where this value comes from.

docs/bulk-actions/getting-the-selected-rows-query.md

@@ -0,0 +1,19 @@
+---
+title: Selected rows query
+weight: 3
+---
+
+In the component, you have access to `$this->selectedRowsQuery` which is a Builder instance of the selected rows.
+
+```php
+public function exportSelected()
+{
+    if ($this->selectedRowsQuery->count() > 0) {
+        // Do something with the selected rows
+    }
+
+    // Notify there is nothing to export
+}
+```
+
+See also [Getting the selected keys](../bulk-actions/getting-the-selected-keys) if you would just like access to the selected primary keys.

docs/bulk-actions/introduction.md

@@ -0,0 +1,8 @@
+---
+title: Introduction
+weight: 1
+---
+
+Bulk actions are a way for you to perform methods on selected rows, a full-page, or all rows, at the same time.
+
+By default, bulk actions are hidden. I.e. the bulk action selector, and the left-hand checkboxes do not appear until you specify at least one bulk action.

docs/bulk-actions/resetting-after-bulk-actions.md

@@ -0,0 +1,39 @@
+---
+title: Resetting after bulk actions
+weight: 5
+---
+
+If your bulk action is changing the outcome of your table, i.e. you are deleting rows or changing criteria that would alter the row set with the search criteria you have, then you may have unexpected results after the bulk action runs.
+
+There is no one good way to handle this, so there are a few options available to you:
+
+## 1. Reset all the filters and criteria.
+
+You can reset all the filters, search, page, sorts, etc. With this method, that will essentially reload the table to what it was on the first page load with your bulk changes since the query will re-run:
+
+```php
+public function deleteSelected()
+{
+    // Delete the rows
+
+    $this->resetAll();
+}
+```
+
+## 2. Reset specific criteria
+
+You may at the end of your bulk action method reset specific parts of the UI with any of the following methods:
+
+```php
+public function myBulkAction()
+{
+    // Do something with the rows
+
+    // Use any of these to reset the UI to a point that makes sense after your bulk action is run:
+    $this->resetFilters(); // Remove all the filters
+    $this->resetSearch(); // Remove the search query
+    $this->resetSorts(); // Remove the sorts
+    $this->resetBulk(); // Clear the selected rows
+    $this->resetPage(); // Go back to page 1
+}
+```

docs/columns/_index.md

@@ -0,0 +1,4 @@
+---
+title: Columns
+weight: 3
+---