3.3.0 - Docs Update (#1768)

* Adjust column documentation (#1767) --------- Co-authored-by: lrljoe <[email protected]>
rappasoft · Jul 11, 2024 · d614186 · d614186
1 parent f642ce0
commit d614186
Show file tree

Hide file tree

Showing 18 changed files with 301 additions and 31 deletions.
diff --git a/docs/column-types/array_column.md b/docs/column-types/array_column.md
@@ -1,6 +1,6 @@
 ---
 title: Array Columns (beta)
-weight: 1
+weight: 2
 ---
 
 Array columns provide an easy way to work with and display an array of data from a field.
@@ -19,4 +19,20 @@ You may define the default/empty value using the "emptyValue" method
 ```
 ArrayColumn::make('notes', 'name')
     ->emptyValue('Unknown'),
-```
+```
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/avg_column.md b/docs/column-types/avg_column.md
@@ -1,6 +1,6 @@
 ---
 title: Avg Columns (beta)
-weight: 2
+weight: 3
 ---
 
 Avg columns provide an easy way to display the "Average" of a field on a relation.
@@ -11,4 +11,20 @@ Avg columns provide an easy way to display the "Average" of a field on a relatio
         ->sortable(),
 ```
 
-The "sortable()" callback can accept a callback, or you can use the default behaviour, which calculates the correct field to sort on.
+The "sortable()" callback can accept a callback, or you can use the default behaviour, which calculates the correct field to sort on.
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/boolean_columns.md b/docs/column-types/boolean_columns.md
@@ -1,6 +1,6 @@
 ---
 title: Boolean Columns
-weight: 3
+weight: 4
 ---
 
 Boolean columns are good if you have a column type that is a true/false, or 0/1 value.
@@ -79,3 +79,19 @@ If you would like the BooleanColumn to display a plain Yes/No, you can set:
 BooleanColumn::make('Active')
     ->yesNo()
 ```
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/button_group_column.md b/docs/column-types/button_group_column.md
@@ -1,6 +1,6 @@
 ---
 title: Button Group Columns
-weight: 4
+weight: 5
 ---
 
 Button group columns let you provide an array of LinkColumns to display in a single cell.
@@ -32,3 +32,10 @@ ButtonGroupColumn::make('Actions')
             }),
     ]),
 ```
+
+
+Please also see the following for other available methods:
+- [https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods](Available Methods)
+- [https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection](Column Selection)
+- [https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header](Secondary Header)
+- [https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer](Footer)
diff --git a/docs/column-types/color_columns.md b/docs/column-types/color_columns.md
@@ -1,6 +1,6 @@
 ---
 title: Color Columns
-weight: 5
+weight: 6
 ---
 
 Color columns provide an easy way to a Color in a Column
@@ -39,3 +39,19 @@ You may also specify attributes to use on the div displaying the color, to adjus
                 ];
             }),
 ```
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/component_column.md b/docs/column-types/component_column.md
@@ -1,6 +1,6 @@
 ---
 title: Component Columns
-weight: 6
+weight: 7
 ---
 
 Component columns let you specify a component name and attributes and provides the column value to the slot.
@@ -26,3 +26,18 @@ ComponentColumn::make('E-mail', 'email')
     ]),
 ```
 
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/count_column.md b/docs/column-types/count_column.md
@@ -1,6 +1,6 @@
 ---
 title: Count Columns (beta)
-weight: 7
+weight: 8
 ---
 
 Count columns provide an easy way to display the "Count" of a relation.
@@ -11,4 +11,20 @@ Count columns provide an easy way to display the "Count" of a relation.
         ->sortable(),
 ```
 
-The "sortable()" callback can accept a callback, or you can use the default behaviour, which calculates the correct field to sort on.
+The "sortable()" callback can accept a callback, or you can use the default behaviour, which calculates the correct field to sort on.
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/date_columns.md b/docs/column-types/date_columns.md
@@ -1,6 +1,6 @@
 ---
 title: Date Columns
-weight: 8
+weight: 9
 ---
 
 Date columns provide an easy way to display dates in a given format, without having to use repetitive format() methods or partial views.
@@ -26,3 +26,18 @@ DateColumn::make('Last Charged', 'last_charged_at')
     ->emptyValue('Not Found'),
 ```
 
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/image_columns.md b/docs/column-types/image_columns.md
@@ -1,6 +1,6 @@
 ---
 title: Image Columns
-weight: 9
+weight: 10
 ---
 
 Image columns provide a way to display images in your table without having to use `format()` or partial views:
@@ -24,3 +24,19 @@ ImageColumn::make('Avatar')
         'alt' => $row->name . ' Avatar',
     ]),
 ```
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/link_columns.md b/docs/column-types/link_columns.md
@@ -1,6 +1,6 @@
 ---
 title: Link Columns
-weight: 10
+weight: 11
 ---
 
 Link columns provide a way to display HTML links in your table without having to use `format()` or partial views:
@@ -22,3 +22,19 @@ LinkColumn::make('Action')
         'alt' => $row->name . ' Avatar',
     ]),
 ```
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/livewire_component_column.md b/docs/column-types/livewire_component_column.md
@@ -1,5 +1,32 @@
 ---
 title: Livewire Component (beta)
-weight: 11
+weight: 12
 ---
 
+Livewire Component Columns allow for the use of a Livewire Component as a Column.
+
+This is **not recommended** as due to the nature of Livewire, it becomes inefficient at scale.
+
+## component
+```
+LivewireComponentColumn::make('Action')
+    ->title(fn($row) => 'Edit')
+    ->component('PathToLivewireComponent'),
+
+```
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>
diff --git a/docs/column-types/standard_column.md b/docs/column-types/standard_column.md
@@ -0,0 +1,31 @@
+---
+title: Standard Column
+weight: 1
+---
+
+A standard Column has a multitude of different options, making it simple for you to display your data, as documented below:
+
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/creating-columns">Creating Columns</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/relationships">Relationships</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+        <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/anonymous_columns">Anonymous Columns</a>
+    </li>
+
+</ul>
diff --git a/docs/column-types/sum_column.md b/docs/column-types/sum_column.md
@@ -1,6 +1,6 @@
 ---
 title: Sum Columns (beta)
-weight: 12
+weight: 13
 ---
 
 Sum columns provide an easy way to display the "Sum" of a field on a relation.
@@ -11,4 +11,20 @@ Sum columns provide an easy way to display the "Sum" of a field on a relation.
         ->sortable(),
 ```
 
-The "sortable()" callback can accept a callback, or you can use the default behaviour, which calculates the correct field to sort on.
+The "sortable()" callback can accept a callback, or you can use the default behaviour, which calculates the correct field to sort on.
+
+Please also see the following for other available methods:
+<ul>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/available-methods">Available Methods</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/column-selection">Column Selection</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/secondary-header">Secondary Header</a>
+    </li>
+    <li>
+        <a href="https://rappasoft.com/docs/laravel-livewire-tables/v3/columns/footer">Footer</a>
+    </li>
+</ul>