Skip to content

Commit

Permalink
docs: use externalResources instead of previous register resource
Browse files Browse the repository at this point in the history
  • Loading branch information
ghiscoding committed Sep 16, 2024
1 parent 9554c44 commit b7c2061
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 10 deletions.
5 changes: 3 additions & 2 deletions docs/grid-functionalities/Export-to-Excel.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
- [UI Sample](#ui-sample)

### Description
You can Export to Excel, it will create an Excel file with the `.xlsx` default extension (you can also change it to be `.xls`). If you wish to export to CSV or other delimiter like Tab Delimited, you can refer to the other [Wiki - Export to File](Export-to-Text-File.md).

**NOTE:** this is an opt-in Service, you must download the necessary Service from `@slickgrid-universal/excel-export` and instantiate it in your grid options via `registerExternalResources`, see multiple examples below.
You can optionally install the Export to Excel resource, it will give you the flexibility of export your grid data to an Excel file with the `.xlsx` default extension (or `.xls`). If you wish to export to CSV or other delimiter like Tab Delimited, then you will want to take a look at the other [Wiki - Export to File](Export-to-Text-File.md).

**NOTE:** this is an opt-in Service, you must download the necessary Service from `@slickgrid-universal/excel-export` and instantiate it in your grid options via `externalResources`, see multiple examples below.

### Demo
[Demo Page](https://ghiscoding.github.io/slickgrid-universal/#/example02) / [Demo Component](https://github.com/ghiscoding/slickgrid-universal/blob/master/examples/webpack-demo-vanilla-bundle/src/examples/example02.ts)
Expand Down
2 changes: 1 addition & 1 deletion docs/grid-functionalities/Export-to-Text-File.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ You can Export to File in 2 formats (csv/txt), the following formats are current
- Export to CSV format (`.csv`)
- Export to Text file (`.txt`) with a delimiter of your choice (Tab delimited is a good one to use)

**NOTE:** this is an opt-in Service, you must download the necessary Service from `@slickgrid-universal/text-export` and instantiate it in your grid options via `registerExternalResources`, see multiple examples below.
**NOTE:** this is an opt-in Service, you must download the necessary Service from `@slickgrid-universal/text-export` and instantiate it in your grid options via `externalResources`, see multiple examples below.

### Demo
[Demo Page](https://ghiscoding.github.io/slickgrid-universal/#/example02) / [Demo Component](https://github.com/ghiscoding/slickgrid-universal/blob/master/examples/webpack-demo-vanilla-bundle/src/examples/example02.ts)
Expand Down
2 changes: 1 addition & 1 deletion docs/grid-functionalities/custom-tooltip.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A plugin to add Custom Tooltip when hovering a cell, it subscribes to the cell `
The `customTooltip` is defined in the Column Definition OR Grid Options (the first found will have priority over the second)
To specify a tooltip when hovering a cell

**NOTE:** this is an opt-in plugin, you must import the necessary plugin from `@slickgrid-universal/custom-tooltip-plugin` and instantiate it in your grid options via `registerExternalResources`, see multiple examples below.
**NOTE:** this is an opt-in plugin, you must import the necessary plugin from `@slickgrid-universal/custom-tooltip-plugin` and instantiate it in your grid options via `externalResources`, see multiple examples below.

### Demo
[Demo Page](https://ghiscoding.github.io/slickgrid-universal/#/example16) / [Demo Component](https://github.com/ghiscoding/slickgrid-universal/blob/master/examples/webpack-demo-vanilla-bundle/src/examples/example16.ts)
Expand Down
2 changes: 1 addition & 1 deletion packages/custom-tooltip-plugin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To specify a tooltip when hovering a cell, extend the column definition like so:
Available plugin options (same options are available in both column definition and/or grid options)

#### Register the plugin
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown in the Example 2 below.
In order to use the Service, you will need to register it in your grid options via the `externalResources` as shown in the Example 2 below.

##### Example 1 - via Column Definition
```ts
Expand Down
9 changes: 6 additions & 3 deletions packages/excel-export/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
## Excel Export Service
#### @slickgrid-universal/excel-export

Simple Export to Excel Service that allows to exporting as `.xls` or `.xlsx`.
Simple Export to Excel Service, which requires [`excel-builder-vanilla`](https://github.com/ghiscoding/excel-builder-vanilla) external dependency, which allows exporting your grid data as `.xls` or `.xlsx` files.

### Internal Dependencies
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
Expand All @@ -28,7 +28,7 @@ Follow the instruction provided in the main [README](https://github.com/ghiscodi
You can also use nearly all Excel-Builder-Vanilla options, see their [Excel-Builder-Vanilla - Documentation](https://ghiscoding.gitbook.io/excel-builder-vanilla/) and also take a look at Slickgrid-Universal [Excel Export - Documentation](https://ghiscoding.gitbook.io/slickgrid-universal/grid-functionalities/export-to-excel) on how to use both.

### Usage
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below.
In order to use the Service, you will need to register it in your grid options via the `externalResources` as shown below.

##### ViewModel
```ts
Expand All @@ -38,10 +38,13 @@ export class MyExample {
initializeGrid {
this.gridOptions = {
enableExcelExport: true,
// you need to register it as an external resource
externalResources: [new ExcelExportService()],

// set any options
excelExportOptions: {
sanitizeDataExport: true
},
externalResources: [new ExcelExportService()],
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion packages/rxjs-observable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This package is simply a bridge, a facade, to make it possible to use RxJS witho
Follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation), you can see a demo by looking at the [GitHub Demo](https://ghiscoding.github.io/slickgrid-universal) page.

### Usage
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below and of course install RxJS itself (this package requires [RxJS 7](https://github.com/ReactiveX/RxJS)).
In order to use the Service, you will need to register it in your grid options via the `externalResources` as shown below and of course install RxJS itself (this package requires [RxJS 7](https://github.com/ReactiveX/RxJS)).

##### ViewModel
```ts
Expand Down
2 changes: 1 addition & 1 deletion packages/text-export/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This package requires [text-encoding-utf-8](https://www.npmjs.com/package/text-e
Follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation), you can see a demo by looking at the [GitHub Demo](https://ghiscoding.github.io/slickgrid-universal) page and click on "Export to CSV" from the Grid Menu (aka hamburger menu).

### Usage
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below.
In order to use the Service, you will need to register it in your grid options via the `externalResources` as shown below.

##### ViewModel
```ts
Expand Down

0 comments on commit b7c2061

Please sign in to comment.