@commercetools-frontend-extensions/export-resources-modal 4.0.4 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -5
- package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.dev.js +279 -180
- package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.prod.js +276 -177
- package/dist/commercetools-frontend-extensions-export-resources-modal.esm.js +278 -179
- package/dist/declarations/src/@constants/misc.d.ts +1 -0
- package/dist/declarations/src/@types/export-resources-modal-shape.d.ts +0 -1
- package/dist/declarations/src/export-resources-modal.d.ts +0 -1
- package/package.json +6 -5
package/README.md
CHANGED
|
@@ -27,7 +27,6 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
27
27
|
// Use case: Exporting all resources
|
|
28
28
|
<ExportResourcesModal
|
|
29
29
|
isOpen={true}
|
|
30
|
-
exportType="all"
|
|
31
30
|
outputFormat="csv"
|
|
32
31
|
resourceType="category"
|
|
33
32
|
totalResourcesCount={143}
|
|
@@ -130,7 +129,6 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
130
129
|
// Use case: Exporting only selected resources by their IDs
|
|
131
130
|
<ExportResourcesModal
|
|
132
131
|
isOpen={true}
|
|
133
|
-
exportType="selected"
|
|
134
132
|
outputFormat="csv"
|
|
135
133
|
resourceType="category"
|
|
136
134
|
selectedResourceIds={['02ed9a7d-7c1f-40da-b2b7-4cca6752bf29', '04051276-1641-4e01-a03e-d4de16b7e4eb', 'ac7d9f7b-5c7d-4dd3-b82b-8555ab4a2a6e']}
|
|
@@ -235,9 +233,8 @@ import ExportResourcesModal from '@commercetools-frontend-extensions/export-reso
|
|
|
235
233
|
| `onExportSuccess` | `function` | | | Callback function that is called when the export operation is successful |
|
|
236
234
|
| `onClose` | `function` | | | Callback function invoked when the modal is requested to close (on overlay click, close button click or `ESC` press). This function is also called after an export operation regardless of its success or failure |
|
|
237
235
|
| `resourceType` | `string` | ✅ | | The type of the resource, example: `category`, `product`... |
|
|
238
|
-
| `totalResourcesCount` | `number` |
|
|
239
|
-
| `
|
|
240
|
-
| `selectedResourceIds` | `array` | (✅) Required only if the `exportType` is `selected` | | Array of Ids of the selected resources |
|
|
236
|
+
| `totalResourcesCount` | `number` | ✅ | | The count of all resources of identified `resourceType` |
|
|
237
|
+
| `selectedResourceIds` | `array` | | | Array of Ids of the selected resources |
|
|
241
238
|
| `fieldGroups` | `array` | ✅ | | Array of the grouped `fields` to export. |
|
|
242
239
|
| `fieldGroups[].groupLabel` | `array` | ✅ | | Array of the grouped `fields` to export. |
|
|
243
240
|
| `fieldGroups[].fields` | `array` | ✅ | | Array of the fields to export. The fields must align with the [commercetools API schema](https://docs.commercetools.com/api/). Field can have nested `fields` array. |
|