Add set sheet name (#25)

* Add set sheetname

* Add property in livewire, update readme.

* Fix blank request

* Fix phpstan error

* Fix error

* refactor

* Update readme, add substring

* Update readme

* Move substr of sheetname in job.

Author: jeanne007

README.md

@@ -92,6 +92,23 @@ You can set the export type by setting the property to `csv` or `xlsx`. Default
 <livewire:export-button :table-id="$dataTable->getTableId()" type="csv" />
 ```
 
+## Set Excel Sheet Name
+
+Option 1: You can set the Excel sheet name by setting the property. 
+
+```php
+<livewire:export-button :table-id="$dataTable->getTableId()" sheet-name="Monthly Report" />
+```
+
+Option 2: You can also set the Excel sheet name by overwriting the method.
+
+```php
+protected function sheetName() : string
+{
+    return "Yearly Report";
+}
+```
+
 ## Formatting Columns
 
 You can format the column by setting it via Column definition on you DataTable service class.

src/Jobs/DataTableExportJob.php

@@ -21,6 +21,7 @@
 use OpenSpout\Common\Type;
 use OpenSpout\Writer\Common\Creator\Style\StyleBuilder;
 use OpenSpout\Writer\Common\Creator\WriterEntityFactory;
+use OpenSpout\Writer\XLSX\Writer as XLSXWriter;
 use PhpOffice\PhpSpreadsheet\Shared\Date;
 use PhpOffice\PhpSpreadsheet\Style\NumberFormat;
 use Yajra\DataTables\Html\Column;
@@ -40,6 +41,8 @@ class DataTableExportJob implements ShouldQueue, ShouldBeUnique
 
     public array $request;
 
+    public string $sheetName;
+
     /**
      * @var int|string
      */
@@ -51,13 +54,15 @@ class DataTableExportJob implements ShouldQueue, ShouldBeUnique
      * @param  array  $dataTable
      * @param  array  $request
      * @param  int|string  $user
+     * @param  string  $sheetName
      */
-    public function __construct(array $dataTable, array $request, $user)
+    public function __construct(array $dataTable, array $request, $user, string $sheetName = 'Sheet1')
     {
         $this->dataTable = $dataTable[0];
         $this->attributes = $dataTable[1];
         $this->request = $request;
         $this->user = $user;
+        $this->sheetName = $sheetName;
     }
 
     /**
@@ -99,6 +104,11 @@ public function handle()
         $writer = WriterEntityFactory::createWriter($type);
         $writer->openToFile($path);
 
+        if ($writer instanceof XLSXWriter) {
+            $sheet = $writer->getCurrentSheet();
+            $sheet->setName(substr($this->sheetName,0,31));
+        }
+
         $columns = $this->getExportableColumns($oTable);
         $writer->addRow(
             WriterEntityFactory::createRowFromArray(
@@ -166,6 +176,7 @@ public function handle()
 
             $writer->addRow(WriterEntityFactory::createRow($cells));
         }
+
         $writer->close();
     }
 

src/Livewire/ExportButtonComponent.php

@@ -23,6 +23,8 @@ class ExportButtonComponent extends Component
 
     public string $filename = '';
 
+    public string $sheetName = 'Sheet1';
+
     public bool $exporting = false;
 
     public bool $exportFinished = false;

src/WithExportQueue.php

@@ -42,11 +42,23 @@ public function exportQueue(): string
         $job = new DataTableExportJob(
             [self::class, $this->attributes],
             request()->all(),
-            Auth::id() ?? 0
+            Auth::id() ?? 0,
+            $this->sheetName(),
         );
 
         $batch = Bus::batch([$job])->name('datatables-export')->dispatch();
 
         return $batch->id;
     }
+
+    /**
+     * Default sheet name.
+     * Character limit 31.
+     *
+     * @return string
+     */
+    protected function sheetName() : string
+    {
+        return request('sheetName', 'Sheet1');
+    }
 }

src/resources/views/export-button.blade.php

@@ -3,7 +3,7 @@
           x-on:submit.prevent="
                 $refs.exportBtn.disabled = true;
                 var url = window._buildUrl(LaravelDataTables['{{ $tableId }}'], 'exportQueue');
-                $.get(url + '&exportType={{$fileType}}').then(function(exportId) {
+                $.get(url + '&exportType={{$fileType}}&sheetName={{$sheetName}}').then(function(exportId) {
                     $wire.export(exportId)
                 }).catch(function(error) {
                     $wire.exportFinished = true;