@commercetools-frontend-extensions/export-resources-modal 3.5.0-next.3 → 3.5.0-next.4
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 +4 -7
- package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.dev.js +0 -2
- package/dist/commercetools-frontend-extensions-export-resources-modal.cjs.prod.js +0 -2
- package/dist/commercetools-frontend-extensions-export-resources-modal.esm.js +0 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -44,13 +44,12 @@ import { ExportResourcesModal } from '@commercetools-frontend-extensions/export-
|
|
|
44
44
|
},
|
|
45
45
|
{ name: 'createdAt', label: 'Created at' },
|
|
46
46
|
{ name: 'lastModifiedAt', label: 'Last modified at' },
|
|
47
|
-
{ name: 'name',
|
|
47
|
+
{ name: 'name', label: 'Name' },
|
|
48
48
|
{
|
|
49
49
|
name: 'parent',
|
|
50
50
|
fields: [
|
|
51
51
|
{
|
|
52
52
|
name: 'name',
|
|
53
|
-
isLocalized: true,
|
|
54
53
|
label: 'Parent name',
|
|
55
54
|
},
|
|
56
55
|
{
|
|
@@ -129,13 +128,12 @@ import { ExportResourcesModal } from '@commercetools-frontend-extensions/export-
|
|
|
129
128
|
},
|
|
130
129
|
{ name: 'createdAt', label: 'Created at' },
|
|
131
130
|
{ name: 'lastModifiedAt', label: 'Last modified at' },
|
|
132
|
-
{ name: 'name',
|
|
131
|
+
{ name: 'name', label: 'Name' },
|
|
133
132
|
{
|
|
134
133
|
name: 'parent',
|
|
135
134
|
fields: [
|
|
136
135
|
{
|
|
137
136
|
name: 'name',
|
|
138
|
-
isLocalized: true,
|
|
139
137
|
label: 'Parent name',
|
|
140
138
|
},
|
|
141
139
|
{
|
|
@@ -198,7 +196,7 @@ import { ExportResourcesModal } from '@commercetools-frontend-extensions/export-
|
|
|
198
196
|
## Properties
|
|
199
197
|
|
|
200
198
|
| Props | Type | Required | Default | Description |
|
|
201
|
-
| ------------------------------- | ------------------------------------------------------- | :--------------------------------------------------: | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
199
|
+
| ------------------------------- | ------------------------------------------------------- | :--------------------------------------------------: | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
|
|
202
200
|
| `isOpen` | `boolean` | | `false` | Controls whether the export modal is open or closed |
|
|
203
201
|
| `outputFormat` | `string`<br/>Possible values: `csv`, `json` | | `csv` | The file format to export |
|
|
204
202
|
| `onExportSuccess` | `function` | | | Callback function that is called when the export operation is successful |
|
|
@@ -211,8 +209,7 @@ import { ExportResourcesModal } from '@commercetools-frontend-extensions/export-
|
|
|
211
209
|
| `fields[].name` | `string` | ✅ | | A string that represents the unique identifier for each field |
|
|
212
210
|
| `fields[].label` | `string` | ✅ | | The label of the field to be shown in the export modal |
|
|
213
211
|
| `fields[].isRequired` | `boolean` | | `false` | `isRequired` field indicates whether a field is required for the export process. If `true` the field will be selected by default and cannot be deselected by the user. This is useful for fields that are essential for the export process. Fields marked as required will have a `*` appended to their label in the UI |
|
|
214
|
-
| `fields[].isSelectedByDefault` | `boolean` | | `true` | This field is a part of the `fields` array is used to control the default state of the corresponding checkbox in the UI. If `isSelectedByDefault` is set to true, the checkbox for that particular field will be checked by default when the component loads. The default value of this attribute is `true` which means unless explicitly set to `false`, the checkbox for the field will be checked on initial load. |
|
|
215
|
-
| `fields[].isLocalized` | `boolean` | | `false` | The field is a localized field |
|
|
212
|
+
| `fields[].isSelectedByDefault` | `boolean` | | `true` | This field is a part of the `fields` array is used to control the default state of the corresponding checkbox in the UI. If `isSelectedByDefault` is set to true, the checkbox for that particular field will be checked by default when the component loads. The default value of this attribute is `true` which means unless explicitly set to `false`, the checkbox for the field will be checked on initial load. | |
|
|
216
213
|
| `customFields` | `array` | | | Array of objects, each representing a group of custom fields defined under a specific type. |
|
|
217
214
|
| `customFields[].type` | `string` | | | The type object. |
|
|
218
215
|
| `customFields[].type.key` | `string` | | | The unique identifier for the type. |
|
|
@@ -1033,11 +1033,9 @@ const ExportResourcesModalShape = PropTypes__default["default"].shape({
|
|
|
1033
1033
|
fields: PropTypes__default["default"].arrayOf(PropTypes__default["default"].shape({
|
|
1034
1034
|
name: PropTypes__default["default"].string.isRequired,
|
|
1035
1035
|
label: PropTypes__default["default"].string,
|
|
1036
|
-
isLocalized: PropTypes__default["default"].bool,
|
|
1037
1036
|
fields: PropTypes__default["default"].arrayOf(PropTypes__default["default"].shape({
|
|
1038
1037
|
name: PropTypes__default["default"].string.isRequired,
|
|
1039
1038
|
label: PropTypes__default["default"].string,
|
|
1040
|
-
isLocalized: PropTypes__default["default"].bool,
|
|
1041
1039
|
isSelectedByDefault: PropTypes__default["default"].bool,
|
|
1042
1040
|
isRequired: PropTypes__default["default"].bool
|
|
1043
1041
|
}))
|
|
@@ -1023,11 +1023,9 @@ PropTypes__default["default"].shape({
|
|
|
1023
1023
|
fields: PropTypes__default["default"].arrayOf(PropTypes__default["default"].shape({
|
|
1024
1024
|
name: PropTypes__default["default"].string.isRequired,
|
|
1025
1025
|
label: PropTypes__default["default"].string,
|
|
1026
|
-
isLocalized: PropTypes__default["default"].bool,
|
|
1027
1026
|
fields: PropTypes__default["default"].arrayOf(PropTypes__default["default"].shape({
|
|
1028
1027
|
name: PropTypes__default["default"].string.isRequired,
|
|
1029
1028
|
label: PropTypes__default["default"].string,
|
|
1030
|
-
isLocalized: PropTypes__default["default"].bool,
|
|
1031
1029
|
isSelectedByDefault: PropTypes__default["default"].bool,
|
|
1032
1030
|
isRequired: PropTypes__default["default"].bool
|
|
1033
1031
|
}))
|
|
@@ -1000,11 +1000,9 @@ const ExportResourcesModalShape = PropTypes.shape({
|
|
|
1000
1000
|
fields: PropTypes.arrayOf(PropTypes.shape({
|
|
1001
1001
|
name: PropTypes.string.isRequired,
|
|
1002
1002
|
label: PropTypes.string,
|
|
1003
|
-
isLocalized: PropTypes.bool,
|
|
1004
1003
|
fields: PropTypes.arrayOf(PropTypes.shape({
|
|
1005
1004
|
name: PropTypes.string.isRequired,
|
|
1006
1005
|
label: PropTypes.string,
|
|
1007
|
-
isLocalized: PropTypes.bool,
|
|
1008
1006
|
isSelectedByDefault: PropTypes.bool,
|
|
1009
1007
|
isRequired: PropTypes.bool
|
|
1010
1008
|
}))
|
package/package.json
CHANGED