Builder, table & columns docs.

Author: yajra

documentation.md

@@ -50,6 +50,7 @@
 	- [Whitelist Columns](/docs/laravel-datatables/{{version}}/whitelist)
 - HTML Builder
 	- [Builder](/docs/laravel-datatables/{{version}}/html-builder)
+	- [Table](/docs/laravel-datatables/{{version}}/html-builder-table)
 	- [Columns](/docs/laravel-datatables/{{version}}/html-builder-column)
 	- [Parameters](/docs/laravel-datatables/{{version}}/html-builder-parameters)
 	- [Events/Callbacks](/docs/laravel-datatables/{{version}}/html-builder-callbacks)

html-builder-column.md

@@ -1 +1,64 @@
-# Html Builder Column
+# Html Builder Column
+
+Builder Column represents the column to be rendered by your dataTables.
+You can use `addColumn` api to add a single column and `columns` api to add multiple columns.
+
+<a name="attributes"></a>
+## Column Attributes
+
+A DataTable `Column` accepts the following attributes:
+
+```php
+$column = [
+	'name' => 'id',
+	'data' => 'id',
+	'title' => 'Id',
+	'searchable' => true,
+	'orderable' => true,
+	'render' => 'function(){}',
+	'footer' => 'Id',
+	'exportable' => true,
+	'printable' => true,
+];
+```
+
+You also need to look at [`datatables.net`](https://datatables.net/reference/option/columns) official columns documentation for further reference.
+
+### Name (Optional)
+Name attribute represents the `column` name from your data source.
+Datatables will use this attribute when performing search and ordering functions.
+
+> {tip} If not set, `name` attribute will automatically be set to same value as `data` attribute.
+
+### Data
+Data attribute will be used when rendering the response to your table. This is the `key` from the `json` response `data` array.
+
+### Title (Optional)
+Title attribute is used as your `table` column heading `<th>{{$title}}</th>`.
+
+> {tip} If not set, `data` attribute value will be use as `title` with title case format.
+
+### Searchable (Optional)
+Searchable attribute will toggle the `searching` ability for the defined column. Default value is `true`.
+
+### Orderable (Optional)
+Orderable attribute will toggle the `ordering` ability for the defined column. Default value is `true`.
+
+### Render (Optional)
+Render attribute is a `js` script string that you can use to modify the way the column is being rendered via `javascript`.
+
+### Footer (Optional)
+Footer attribute will be as your `tables` column's `footer` content `<tfoot></tfoot>`.
+
+> {tip} To display the footer using html builder, pass `true` as 2nd argument on `$builder->table([], true)` api.
+
+
+### Exportable (Optional)
+Exportable attribute will flag the column to be included when `exporting` the table. Default value is `true`.
+
+> Exportable attribute should be used with the [Buttons Plugin](/docs/laravel-datatables/{{version}}/buttons-installation)
+
+### Printable (Optional)
+Printable attribute will flag the column to be included when `printing` the table. Default value is `true`.
+
+> Exportable attribute should be used with the [Buttons Plugin](/docs/laravel-datatables/{{version}}/buttons-installation)

html-builder-table.md

@@ -0,0 +1,43 @@
+# Html Builder Table
+
+Table api accepts two parameters: `$builder->table(array $attributes, $footer = false)`
+- `$attributes` represents an array that will be converted as your `<table></table>` attributes.
+- `$footer` will include/remove `<tfoot></tfoot>` on your `table` markup.
+
+<a name="example"></a>
+## Table Example with Footer
+
+```php
+use Datatables;
+use Yajra\Datatables\Html\Builder;
+
+Route::get('users', function(Builder $builder) {
+	if (request()->ajax()) {
+        return Datatables::of(User::query())->make(true);
+    }
+
+	$html = $builder->columns([
+	        	['data' => 'id', 'footer' => 'Id'],
+		        ['data' => 'name', 'footer' => 'Name'],
+		        ['data' => 'email', 'footer' => 'Email'],
+		        ['data' => 'created_at', 'footer' => 'Created At'],
+		        ['data' => 'updated_at', 'footer' => 'Updated At'),
+	        ]);
+
+	return view('users.index', compact('html'));
+});
+```
+
+On your `resources/views/users/index.blade.php`.
+
+```php
+@extends('app')
+
+@section('contents')
+    {!! $html->table(['class' => 'table table-bordered', true]) !!}
+@endsection
+
+@push('scripts')
+    {!! $html->scripts() !!}
+@endpush
+```

html-builder.md

@@ -1 +1,73 @@
-# Html Builder
+# Html Builder
+
+Datatables has a built-in html builder that you can use to automatically generate your table mark-up and javascripts declarations.
+
+<a name="dependency-injection"></a>
+## Html Builder via Dependency Injection
+
+You can use the `Builder` class by using Dependency Injection.
+
+```php
+use Yajra\Datatables\Html\Builder;
+
+Route::get('users', function(Builder $builder) {
+});
+```
+
+<a name="ioc"></a>
+## Html Builder via IoC
+
+```php
+Route::get('users', function() {
+	$builder = app('datatables.html');
+});
+```
+
+<a name="datatables-intance"></a>
+## Html Builder from Datatables instance
+
+```php
+use Yajra\Datatables\Datatables;
+
+Route::get('users', function(Datatables $dataTable) {
+	$builder = $dataTable->getHtmlBuilder();
+});
+```
+
+<a name="example"></a>
+## Html Builder Example
+
+```php
+use Datatables;
+use Yajra\Datatables\Html\Builder;
+
+Route::get('users', function(Builder $builder) {
+	if (request()->ajax()) {
+        return Datatables::of(User::query())->make(true);
+    }
+
+	$html = $builder->columns([
+	        	['data' => 'id', 'name' => 'id', 'title' => 'Id'],
+		        ['data' => 'name', 'name' => 'name', 'title' => 'Name'],
+		        ['data' => 'email', 'name' => 'email', 'title' => 'Email'],
+		        ['data' => 'created_at', 'name' => 'created_at', 'title' => 'Created At'],
+		        ['data' => 'updated_at', 'name' => 'updated_at', 'title' => 'Updated At']),
+	        ]);
+
+	return view('users.index', compact('html'));
+});
+```
+
+On your `resources/views/users/index.blade.php`.
+
+```php
+@extends('app')
+
+@section('contents')
+    {!! $html->table() !!}
+@endsection
+
+@push('scripts')
+    {!! $html->scripts() !!}
+@endpush
+```