@cauca-911/datagrid 22.2.6-beta1 → 22.2.6

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2018 CAUCA 9-1-1 inc
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2018 CAUCA 9-1-1 inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/README.md

@@ -1,27 +1,57 @@
-# @cauca-911/datagrid
-
-Run `npm install @cauca-911/datagrid --save` to add this library to your project
-
-## To use this library, you need to import the module with specific configuration
-
-## Grid export (optional)
-
-`[allowExport]="true"` adds an Excel / PDF button to a grid's header. The
-libraries that write those files are declared as **optional** peer dependencies,
-so they are not installed with this package. Install them in the consuming
-application before enabling export:
-
-```bash
-npm install exceljs jspdf jspdf-autotable --save
-```
-
-Both formats are offered by default. Narrow them with `exportFormats`, and the
-button disappears entirely if the list is empty:
-
-```html
-<cauca-data-grid [allowExport]="true" [exportFormats]="['excel']" />
-```
-
-They are loaded with a dynamic `import()`, so an application that never enables
-export pays nothing for them in its bundle. Skipping the install is only a
-problem the moment a user clicks the button.
+# @cauca-911/datagrid
+
+Run `npm install @cauca-911/datagrid --save` to add this library to your project
+
+## To use this library, you need to import the module with specific configuration
+
+## Grid export (optional)
+
+`[allowExport]="true"` adds an Excel / PDF button to a grid's header. The
+libraries that write those files are declared as **optional** peer dependencies,
+so they are not installed with this package. Install them in the consuming
+application before enabling export:
+
+```bash
+npm install exceljs jspdf jspdf-autotable --save
+```
+
+Both formats are offered by default. Narrow them with `exportFormats`, and the
+button disappears entirely if the list is empty:
+
+```html
+<cauca-data-grid [allowExport]="true" [exportFormats]="['excel']" />
+```
+
+### Title row
+
+`exportTitle` becomes the first row of the spreadsheet (merged across the
+columns) and is drawn above the table in the PDF. Pass it already translated,
+the same way column labels are passed:
+
+```html
+<cauca-data-grid [allowExport]="true"
+                 [exportTitle]="'userList.exportTitle' | translate" />
+```
+
+Exported column headers need nothing extra: they reuse each column's `label`,
+so binding `[label]="'key' | translate"` is already enough. Dates follow
+`LOCALE_ID`, and boolean cells are written as text from the library's own
+`dataGrid.export.true` / `dataGrid.export.false` keys (`Vrai` / `Faux` in
+French).
+
+### Custom menu items
+
+Project your own entries into the export menu with the `exportItem` attribute.
+They render below the built-in ones, and setting `[exportFormats]="[]"` gives a
+menu of only your items:
+
+```html
+<cauca-data-grid [allowExport]="true">
+    <cauca-menu-item exportItem icon="send" label="user.sendToPartner"
+                     [translateLabel]="true" (buttonClick)="send()" />
+</cauca-data-grid>
+```
+
+They are loaded with a dynamic `import()`, so an application that never enables
+export pays nothing for them in its bundle. Skipping the install is only a
+problem the moment a user clicks the button.

package/assets/i18n/cauca/en-datagrid.json

@@ -19,7 +19,9 @@
     "export": {
       "title": "Export",
       "excel": "Export to Excel",
-      "pdf": "Export to PDF"
+      "pdf": "Export to PDF",
+      "true": "True",
+      "false": "False"
     }
   }
 }

package/assets/i18n/cauca/fr-datagrid.json

@@ -19,7 +19,9 @@
     "export": {
       "title": "Exporter",
       "excel": "Exporter vers Excel",
-      "pdf": "Exporter vers PDF"
+      "pdf": "Exporter vers PDF",
+      "true": "Vrai",
+      "false": "Faux"
     }
   }
 }