cdk-table-exporter - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "cdk-table-exporter",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "Halit Talha Türe",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

README.md

@@ -1,19 +0,7 @@
-# Angular Table Exporter (NgxTableExporter)
+# Angular Table Exporter
 
-This project (NgxTableExporter) is mainly for making CdkTable components exportable as excel files. This is done through using a directive, however you can inject and directly use the service class responsible for data exporting. NgxTableExporter employs xlsx sheetjs, which is a great library and mature enough, for the excel creation itself.
-NgxTableExporter consists of two library projects (cdk-table-exporter, mat-table-exporter) used for exporting table component data as excel files. cdk-table-exporter facilitates the common functionalities for CdkTable implementations abstracting the behavior that can change among different CdkTable implementations, mat-table-exporter is a cdk-table-exporter subtype and provides support for angular material's cdkTable which is MatTable.
+This project is mainly for making CdkTable components exportable as excel files. cdk-table-exporter facilitates the common functionalities for CdkTable implementations abstracting the behavior that can change among different CdkTable implementations, mat-table-exporter is a cdk-table-exporter subtype and provides support for angular material's cdkTable which is MatTable.
 
 ## Getting Started
 
-### Angular Material Users
-
-If you are employing angular material in your project. Install mat-table-exporter
-```
-npm install mat-table-exporter
-```
-
-Afer installing mat-table-exporter import MatTableExporterModule in your ngModules
-
-### Other than Angular Material
-
 Install cdk-table-exporter if you are not using angular material in your project. In this case you have to implement your version of CdkTableExporter abstract class to use as your directive.
@@ -24,17 +12,8 @@
 ```
+After installing mat-table-exporter import MatTableExporterModule in your ngModules
+
 You can find more detail under the corresponding title of Usage section
 
 ## Usage
-### Angular Material Users
 
-```html
-<mat-table [dataSource]="dataSource" #mytable matSort ngxMatTableExporter [cdkTable]="mytable" [exporterButton]="exportButton" sheetName="someSheetName" fileName="someFileName">
-```
-
-```html
-<button #exportButton mat-button></button>
-```
-
-### Other than Angular Material
-
 Will be updated soon
@@ -44,17 +23,13 @@
 
-mat-table-exporter project is only about MatTableExporterDirective that extends CdkTableExporter from cdk-table-exporter.
+### CdkTableExporter
 
-Hence the below public API description for mat-table-export is inherited from CdkTableExporter.ts
-
-### MatTableExporterDirective
-
 | Input/Output | Type | Description |
 | --- | --- | --- |
-|/5. @Input | cdkTable | any | Template-referance of CdkTable that's to be exported |
-| exporterButton | any | Template-referance of the button that's used to trigger the export |
-| sheetName | string | Template-referance of CdkTable that's to be exported |
-| fileName | string | Template-referance of CdkTable that's to be exported |
-| hiddenColumns | Array<number> | The indexes of the columns that are not wanted in the excel file |
-|/2. @Output || exportStarted | EventEmitter<void> | Event that's fired when the export started |
-| exportCompleted | EventEmitter<void> | Event that's fired when the export completed |
+| @Input | cdkTable | any | Template-referance of CdkTable that's to be exported |
+| @Input | exporterButton | any | Template-referance of the button that's used to trigger the export |
+| @Input | sheetName | string | Template-referance of CdkTable that's to be exported |
+| @Input | fileName | string | Template-referance of CdkTable that's to be exported |
+| @Input | hiddenColumns | Array<number> | The indexes of the columns that are not wanted in the excel file |
+| @Output | exportStarted | EventEmitter<void> | Event that's fired when the export started |
+| @Output | exportCompleted | EventEmitter<void> | Event that's fired when the export completed |
 
@@ -61,0 +36,0 @@ ### JsonExporterService

No alert changes

Worsened metrics

Total package byte prevSize

13883

decreased by-7.4%

Number of lines in readme file

54

decreased by-31.65%

No dependency changes