datocms-plugin-sdk 2.0.2 → 2.0.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/dist/cjs/hooks/renderItemCollectionOutlet.js.map +1 -1
- package/dist/cjs/manifest.js +266 -255
- package/dist/cjs/manifest.js.map +1 -1
- package/dist/esm/ctx/base.d.ts +1 -1
- package/dist/esm/hooks/renderItemCollectionOutlet.d.ts +6 -1
- package/dist/esm/hooks/renderItemCollectionOutlet.js.map +1 -1
- package/dist/esm/hooks/renderItemFormSidebar.d.ts +1 -1
- package/dist/esm/hooks/renderItemFormSidebarPanel.d.ts +1 -1
- package/dist/esm/hooks/renderManualFieldExtensionConfigScreen.d.ts +2 -2
- package/dist/esm/hooks/renderModal.d.ts +1 -1
- package/dist/esm/hooks/renderUploadSidebar.d.ts +1 -1
- package/dist/esm/hooks/renderUploadSidebarPanel.d.ts +1 -1
- package/dist/esm/manifest.js +266 -255
- package/dist/esm/manifest.js.map +1 -1
- package/dist/esm/manifestTypes.d.ts +39 -91
- package/dist/types/ctx/base.d.ts +1 -1
- package/dist/types/hooks/renderItemCollectionOutlet.d.ts +6 -1
- package/dist/types/hooks/renderItemFormSidebar.d.ts +1 -1
- package/dist/types/hooks/renderItemFormSidebarPanel.d.ts +1 -1
- package/dist/types/hooks/renderManualFieldExtensionConfigScreen.d.ts +2 -2
- package/dist/types/hooks/renderModal.d.ts +1 -1
- package/dist/types/hooks/renderUploadSidebar.d.ts +1 -1
- package/dist/types/hooks/renderUploadSidebarPanel.d.ts +1 -1
- package/dist/types/manifestTypes.d.ts +39 -91
- package/manifest.json +266 -255
- package/package.json +2 -2
- package/src/ctx/base.ts +1 -1
- package/src/hooks/renderItemCollectionOutlet.ts +6 -1
- package/src/hooks/renderItemFormSidebar.ts +1 -1
- package/src/hooks/renderItemFormSidebarPanel.ts +1 -1
- package/src/hooks/renderManualFieldExtensionConfigScreen.ts +2 -2
- package/src/hooks/renderModal.ts +1 -1
- package/src/hooks/renderUploadSidebar.ts +1 -1
- package/src/hooks/renderUploadSidebarPanel.ts +1 -1
- package/src/manifest.ts +422 -377
- package/src/manifestTypes.ts +39 -91
package/dist/cjs/manifest.js
CHANGED
|
@@ -6,7 +6,7 @@ exports.manifest = {
|
|
|
6
6
|
validateManualFieldExtensionParameters: {
|
|
7
7
|
name: 'validateManualFieldExtensionParameters',
|
|
8
8
|
comment: {
|
|
9
|
-
|
|
9
|
+
markdownText: 'This function will be called each time the configuration object changes. It\nmust return an object containing possible validation errors.',
|
|
10
10
|
tag: 'manualFieldExtensions',
|
|
11
11
|
},
|
|
12
12
|
nonCtxArguments: [
|
|
@@ -28,7 +28,7 @@ exports.manifest = {
|
|
|
28
28
|
uploadsDropdownActions: {
|
|
29
29
|
name: 'uploadsDropdownActions',
|
|
30
30
|
comment: {
|
|
31
|
-
|
|
31
|
+
markdownText: 'This function lets you set up custom actions (or groups of actions) that\nshow up when the user:\n\n* selects multiple assets in the Media Area for batch operations, or\n* opens up a specific asset from the Media Area.\n\nThe `executeUploadsDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
|
|
32
32
|
tag: 'dropdownActions',
|
|
33
33
|
},
|
|
34
34
|
nonCtxArguments: [],
|
|
@@ -46,7 +46,7 @@ exports.manifest = {
|
|
|
46
46
|
uploadSidebars: {
|
|
47
47
|
name: 'uploadSidebars',
|
|
48
48
|
comment: {
|
|
49
|
-
|
|
49
|
+
markdownText: 'Use this function to declare new sidebar to be shown when the user opens\nup an asset in the Media Area.',
|
|
50
50
|
tag: 'sidebarPanels',
|
|
51
51
|
},
|
|
52
52
|
nonCtxArguments: [],
|
|
@@ -64,7 +64,7 @@ exports.manifest = {
|
|
|
64
64
|
uploadSidebarPanels: {
|
|
65
65
|
name: 'uploadSidebarPanels',
|
|
66
66
|
comment: {
|
|
67
|
-
|
|
67
|
+
markdownText: 'Use this function to declare new sidebar panels to be shown when the user\nopens up an asset in the Media Area.',
|
|
68
68
|
tag: 'sidebarPanels',
|
|
69
69
|
},
|
|
70
70
|
nonCtxArguments: [],
|
|
@@ -82,7 +82,7 @@ exports.manifest = {
|
|
|
82
82
|
settingsAreaSidebarItemGroups: {
|
|
83
83
|
name: 'settingsAreaSidebarItemGroups',
|
|
84
84
|
comment: {
|
|
85
|
-
|
|
85
|
+
markdownText: 'Use this function to declare new navigation sections in the Settings Area\nsidebar.',
|
|
86
86
|
tag: 'pages',
|
|
87
87
|
},
|
|
88
88
|
nonCtxArguments: [],
|
|
@@ -100,7 +100,7 @@ exports.manifest = {
|
|
|
100
100
|
renderUploadSidebarPanel: {
|
|
101
101
|
name: 'renderUploadSidebarPanel',
|
|
102
102
|
comment: {
|
|
103
|
-
|
|
103
|
+
markdownText: 'This function will be called when the plugin needs to render a sidebar panel\n(see the `uploadSidebarPanels` hook).',
|
|
104
104
|
tag: 'sidebarPanels',
|
|
105
105
|
},
|
|
106
106
|
nonCtxArguments: [
|
|
@@ -116,7 +116,7 @@ exports.manifest = {
|
|
|
116
116
|
items: {
|
|
117
117
|
sidebarPaneId: {
|
|
118
118
|
comment: {
|
|
119
|
-
|
|
119
|
+
markdownText: 'The ID of the sidebar panel that needs to be rendered.',
|
|
120
120
|
},
|
|
121
121
|
location: {
|
|
122
122
|
filePath: 'src/hooks/renderUploadSidebarPanel.ts',
|
|
@@ -126,7 +126,7 @@ exports.manifest = {
|
|
|
126
126
|
},
|
|
127
127
|
parameters: {
|
|
128
128
|
comment: {
|
|
129
|
-
|
|
129
|
+
markdownText: 'The arbitrary `parameters` of the panel declared in the\n`uploadSidebarPanels` function.',
|
|
130
130
|
},
|
|
131
131
|
location: {
|
|
132
132
|
filePath: 'src/hooks/renderUploadSidebarPanel.ts',
|
|
@@ -136,7 +136,7 @@ exports.manifest = {
|
|
|
136
136
|
},
|
|
137
137
|
upload: {
|
|
138
138
|
comment: {
|
|
139
|
-
|
|
139
|
+
markdownText: 'The active asset.',
|
|
140
140
|
},
|
|
141
141
|
location: {
|
|
142
142
|
filePath: 'src/hooks/renderUploadSidebarPanel.ts',
|
|
@@ -158,7 +158,7 @@ exports.manifest = {
|
|
|
158
158
|
renderUploadSidebar: {
|
|
159
159
|
name: 'renderUploadSidebar',
|
|
160
160
|
comment: {
|
|
161
|
-
|
|
161
|
+
markdownText: 'This function will be called when the plugin needs to render a sidebar (see\nthe `uploadSidebars` hook).',
|
|
162
162
|
tag: 'sidebarPanels',
|
|
163
163
|
},
|
|
164
164
|
nonCtxArguments: [
|
|
@@ -174,7 +174,7 @@ exports.manifest = {
|
|
|
174
174
|
items: {
|
|
175
175
|
sidebarId: {
|
|
176
176
|
comment: {
|
|
177
|
-
|
|
177
|
+
markdownText: 'The ID of the sidebar that needs to be rendered.',
|
|
178
178
|
},
|
|
179
179
|
location: {
|
|
180
180
|
filePath: 'src/hooks/renderUploadSidebar.ts',
|
|
@@ -184,7 +184,7 @@ exports.manifest = {
|
|
|
184
184
|
},
|
|
185
185
|
parameters: {
|
|
186
186
|
comment: {
|
|
187
|
-
|
|
187
|
+
markdownText: 'The arbitrary `parameters` of the declared in the `uploadSidebars`\nfunction.',
|
|
188
188
|
},
|
|
189
189
|
location: {
|
|
190
190
|
filePath: 'src/hooks/renderUploadSidebar.ts',
|
|
@@ -194,7 +194,7 @@ exports.manifest = {
|
|
|
194
194
|
},
|
|
195
195
|
upload: {
|
|
196
196
|
comment: {
|
|
197
|
-
|
|
197
|
+
markdownText: 'The active asset.',
|
|
198
198
|
},
|
|
199
199
|
location: {
|
|
200
200
|
filePath: 'src/hooks/renderUploadSidebar.ts',
|
|
@@ -216,7 +216,7 @@ exports.manifest = {
|
|
|
216
216
|
renderPage: {
|
|
217
217
|
name: 'renderPage',
|
|
218
218
|
comment: {
|
|
219
|
-
|
|
219
|
+
markdownText: 'This function will be called when the plugin needs to render a specific\npage (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and\n`contentAreaSidebarItems` functions).',
|
|
220
220
|
tag: 'pages',
|
|
221
221
|
},
|
|
222
222
|
nonCtxArguments: [
|
|
@@ -232,7 +232,7 @@ exports.manifest = {
|
|
|
232
232
|
items: {
|
|
233
233
|
pageId: {
|
|
234
234
|
comment: {
|
|
235
|
-
|
|
235
|
+
markdownText: 'The ID of the page that needs to be rendered.',
|
|
236
236
|
},
|
|
237
237
|
location: {
|
|
238
238
|
filePath: 'src/hooks/renderPage.ts',
|
|
@@ -254,7 +254,7 @@ exports.manifest = {
|
|
|
254
254
|
renderModal: {
|
|
255
255
|
name: 'renderModal',
|
|
256
256
|
comment: {
|
|
257
|
-
|
|
257
|
+
markdownText: 'This function will be called when the plugin requested to open a modal (see\nthe `openModal` hook).',
|
|
258
258
|
tag: 'modals',
|
|
259
259
|
},
|
|
260
260
|
nonCtxArguments: [
|
|
@@ -270,7 +270,7 @@ exports.manifest = {
|
|
|
270
270
|
items: {
|
|
271
271
|
modalId: {
|
|
272
272
|
comment: {
|
|
273
|
-
|
|
273
|
+
markdownText: 'The ID of the modal that needs to be rendered.',
|
|
274
274
|
},
|
|
275
275
|
location: {
|
|
276
276
|
filePath: 'src/hooks/renderModal.ts',
|
|
@@ -280,7 +280,7 @@ exports.manifest = {
|
|
|
280
280
|
},
|
|
281
281
|
parameters: {
|
|
282
282
|
comment: {
|
|
283
|
-
|
|
283
|
+
markdownText: 'The arbitrary `parameters` of the modal declared in the `openModal`\nfunction.',
|
|
284
284
|
},
|
|
285
285
|
location: {
|
|
286
286
|
filePath: 'src/hooks/renderModal.ts',
|
|
@@ -296,7 +296,7 @@ exports.manifest = {
|
|
|
296
296
|
items: {
|
|
297
297
|
resolve: {
|
|
298
298
|
comment: {
|
|
299
|
-
|
|
299
|
+
markdownText: 'A function to be called by the plugin to close the modal. The `openModal`\ncall will be resolved with the passed return value.',
|
|
300
300
|
example: "const returnValue = prompt(\n 'Please specify the value to return to the caller:',\n 'success',\n);\n\nawait ctx.resolve(returnValue);",
|
|
301
301
|
},
|
|
302
302
|
location: {
|
|
@@ -330,7 +330,7 @@ exports.manifest = {
|
|
|
330
330
|
items: {
|
|
331
331
|
fieldExtensionId: {
|
|
332
332
|
comment: {
|
|
333
|
-
|
|
333
|
+
markdownText: 'The ID of the field extension for which we need to render the parameters\nform.',
|
|
334
334
|
},
|
|
335
335
|
location: {
|
|
336
336
|
filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
|
|
@@ -340,7 +340,7 @@ exports.manifest = {
|
|
|
340
340
|
},
|
|
341
341
|
parameters: {
|
|
342
342
|
comment: {
|
|
343
|
-
|
|
343
|
+
markdownText: 'The current value of the parameters (you can change the value with the\n`setParameters` hook).',
|
|
344
344
|
},
|
|
345
345
|
location: {
|
|
346
346
|
filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
|
|
@@ -350,7 +350,7 @@ exports.manifest = {
|
|
|
350
350
|
},
|
|
351
351
|
errors: {
|
|
352
352
|
comment: {
|
|
353
|
-
|
|
353
|
+
markdownText: 'The current validation errors for the parameters (you can set them\nimplementing the `validateManualFieldExtensionParameters` hook).',
|
|
354
354
|
},
|
|
355
355
|
location: {
|
|
356
356
|
filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
|
|
@@ -360,7 +360,7 @@ exports.manifest = {
|
|
|
360
360
|
},
|
|
361
361
|
pendingField: {
|
|
362
362
|
comment: {
|
|
363
|
-
|
|
363
|
+
markdownText: 'The field entity that is being edited in the form.',
|
|
364
364
|
},
|
|
365
365
|
location: {
|
|
366
366
|
filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
|
|
@@ -370,7 +370,7 @@ exports.manifest = {
|
|
|
370
370
|
},
|
|
371
371
|
itemType: {
|
|
372
372
|
comment: {
|
|
373
|
-
|
|
373
|
+
markdownText: 'The model for the field being edited.',
|
|
374
374
|
},
|
|
375
375
|
location: {
|
|
376
376
|
filePath: 'src/hooks/renderManualFieldExtensionConfigScreen.ts',
|
|
@@ -386,7 +386,7 @@ exports.manifest = {
|
|
|
386
386
|
items: {
|
|
387
387
|
setParameters: {
|
|
388
388
|
comment: {
|
|
389
|
-
|
|
389
|
+
markdownText: 'Sets a new value for the parameters.',
|
|
390
390
|
example: "await ctx.setParameters({ color: '#ff0000' });",
|
|
391
391
|
},
|
|
392
392
|
location: {
|
|
@@ -408,7 +408,7 @@ exports.manifest = {
|
|
|
408
408
|
renderItemFormSidebarPanel: {
|
|
409
409
|
name: 'renderItemFormSidebarPanel',
|
|
410
410
|
comment: {
|
|
411
|
-
|
|
411
|
+
markdownText: 'This function will be called when the plugin needs to render a sidebar panel\n(see the `itemFormSidebarPanels` hook).',
|
|
412
412
|
tag: 'sidebarPanels',
|
|
413
413
|
},
|
|
414
414
|
nonCtxArguments: [
|
|
@@ -423,12 +423,12 @@ exports.manifest = {
|
|
|
423
423
|
{
|
|
424
424
|
name: 'ItemFormAdditionalProperties',
|
|
425
425
|
comment: {
|
|
426
|
-
|
|
426
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
427
427
|
},
|
|
428
428
|
items: {
|
|
429
429
|
locale: {
|
|
430
430
|
comment: {
|
|
431
|
-
|
|
431
|
+
markdownText: 'The currently active locale for the record.',
|
|
432
432
|
},
|
|
433
433
|
location: {
|
|
434
434
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -438,7 +438,7 @@ exports.manifest = {
|
|
|
438
438
|
},
|
|
439
439
|
item: {
|
|
440
440
|
comment: {
|
|
441
|
-
|
|
441
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
442
442
|
},
|
|
443
443
|
location: {
|
|
444
444
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -448,7 +448,7 @@ exports.manifest = {
|
|
|
448
448
|
},
|
|
449
449
|
itemType: {
|
|
450
450
|
comment: {
|
|
451
|
-
|
|
451
|
+
markdownText: 'The model for the record being edited.',
|
|
452
452
|
},
|
|
453
453
|
location: {
|
|
454
454
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -458,7 +458,7 @@ exports.manifest = {
|
|
|
458
458
|
},
|
|
459
459
|
formValues: {
|
|
460
460
|
comment: {
|
|
461
|
-
|
|
461
|
+
markdownText: 'The complete internal form state.',
|
|
462
462
|
},
|
|
463
463
|
location: {
|
|
464
464
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -468,7 +468,7 @@ exports.manifest = {
|
|
|
468
468
|
},
|
|
469
469
|
itemStatus: {
|
|
470
470
|
comment: {
|
|
471
|
-
|
|
471
|
+
markdownText: 'The current status of the record being edited.',
|
|
472
472
|
},
|
|
473
473
|
location: {
|
|
474
474
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -478,7 +478,7 @@ exports.manifest = {
|
|
|
478
478
|
},
|
|
479
479
|
isSubmitting: {
|
|
480
480
|
comment: {
|
|
481
|
-
|
|
481
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
482
482
|
},
|
|
483
483
|
location: {
|
|
484
484
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -488,7 +488,7 @@ exports.manifest = {
|
|
|
488
488
|
},
|
|
489
489
|
isFormDirty: {
|
|
490
490
|
comment: {
|
|
491
|
-
|
|
491
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
492
492
|
},
|
|
493
493
|
location: {
|
|
494
494
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -498,7 +498,7 @@ exports.manifest = {
|
|
|
498
498
|
},
|
|
499
499
|
blocksAnalysis: {
|
|
500
500
|
comment: {
|
|
501
|
-
|
|
501
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
502
502
|
},
|
|
503
503
|
location: {
|
|
504
504
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -512,7 +512,7 @@ exports.manifest = {
|
|
|
512
512
|
items: {
|
|
513
513
|
sidebarPaneId: {
|
|
514
514
|
comment: {
|
|
515
|
-
|
|
515
|
+
markdownText: 'The ID of the sidebar panel that needs to be rendered.',
|
|
516
516
|
},
|
|
517
517
|
location: {
|
|
518
518
|
filePath: 'src/hooks/renderItemFormSidebarPanel.ts',
|
|
@@ -522,7 +522,7 @@ exports.manifest = {
|
|
|
522
522
|
},
|
|
523
523
|
parameters: {
|
|
524
524
|
comment: {
|
|
525
|
-
|
|
525
|
+
markdownText: 'The arbitrary `parameters` of the panel declared in the\n`itemFormSidebarPanels` function.',
|
|
526
526
|
},
|
|
527
527
|
location: {
|
|
528
528
|
filePath: 'src/hooks/renderItemFormSidebarPanel.ts',
|
|
@@ -537,12 +537,12 @@ exports.manifest = {
|
|
|
537
537
|
{
|
|
538
538
|
name: 'ItemFormAdditionalMethods',
|
|
539
539
|
comment: {
|
|
540
|
-
|
|
540
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
541
541
|
},
|
|
542
542
|
items: {
|
|
543
543
|
toggleField: {
|
|
544
544
|
comment: {
|
|
545
|
-
|
|
545
|
+
markdownText: 'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
|
|
546
546
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
|
|
547
547
|
},
|
|
548
548
|
location: {
|
|
@@ -553,7 +553,7 @@ exports.manifest = {
|
|
|
553
553
|
},
|
|
554
554
|
disableField: {
|
|
555
555
|
comment: {
|
|
556
|
-
|
|
556
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
557
557
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
|
|
558
558
|
},
|
|
559
559
|
location: {
|
|
@@ -564,7 +564,7 @@ exports.manifest = {
|
|
|
564
564
|
},
|
|
565
565
|
scrollToField: {
|
|
566
566
|
comment: {
|
|
567
|
-
|
|
567
|
+
markdownText: 'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
|
|
568
568
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
|
|
569
569
|
},
|
|
570
570
|
location: {
|
|
@@ -575,7 +575,7 @@ exports.manifest = {
|
|
|
575
575
|
},
|
|
576
576
|
setFieldValue: {
|
|
577
577
|
comment: {
|
|
578
|
-
|
|
578
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
579
579
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
|
|
580
580
|
},
|
|
581
581
|
location: {
|
|
@@ -586,7 +586,7 @@ exports.manifest = {
|
|
|
586
586
|
},
|
|
587
587
|
formValuesToItem: {
|
|
588
588
|
comment: {
|
|
589
|
-
|
|
589
|
+
markdownText: 'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
|
|
590
590
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
591
591
|
},
|
|
592
592
|
location: {
|
|
@@ -597,7 +597,7 @@ exports.manifest = {
|
|
|
597
597
|
},
|
|
598
598
|
itemToFormValues: {
|
|
599
599
|
comment: {
|
|
600
|
-
|
|
600
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
601
601
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
602
602
|
},
|
|
603
603
|
location: {
|
|
@@ -608,7 +608,7 @@ exports.manifest = {
|
|
|
608
608
|
},
|
|
609
609
|
saveCurrentItem: {
|
|
610
610
|
comment: {
|
|
611
|
-
|
|
611
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
612
612
|
example: 'await ctx.saveCurrentItem();',
|
|
613
613
|
},
|
|
614
614
|
location: {
|
|
@@ -630,7 +630,7 @@ exports.manifest = {
|
|
|
630
630
|
renderItemFormSidebar: {
|
|
631
631
|
name: 'renderItemFormSidebar',
|
|
632
632
|
comment: {
|
|
633
|
-
|
|
633
|
+
markdownText: 'This function will be called when the plugin needs to render a sidebar (see\nthe `itemFormSidebars` hook).',
|
|
634
634
|
tag: 'sidebarPanels',
|
|
635
635
|
},
|
|
636
636
|
nonCtxArguments: [
|
|
@@ -645,12 +645,12 @@ exports.manifest = {
|
|
|
645
645
|
{
|
|
646
646
|
name: 'ItemFormAdditionalProperties',
|
|
647
647
|
comment: {
|
|
648
|
-
|
|
648
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
649
649
|
},
|
|
650
650
|
items: {
|
|
651
651
|
locale: {
|
|
652
652
|
comment: {
|
|
653
|
-
|
|
653
|
+
markdownText: 'The currently active locale for the record.',
|
|
654
654
|
},
|
|
655
655
|
location: {
|
|
656
656
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -660,7 +660,7 @@ exports.manifest = {
|
|
|
660
660
|
},
|
|
661
661
|
item: {
|
|
662
662
|
comment: {
|
|
663
|
-
|
|
663
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
664
664
|
},
|
|
665
665
|
location: {
|
|
666
666
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -670,7 +670,7 @@ exports.manifest = {
|
|
|
670
670
|
},
|
|
671
671
|
itemType: {
|
|
672
672
|
comment: {
|
|
673
|
-
|
|
673
|
+
markdownText: 'The model for the record being edited.',
|
|
674
674
|
},
|
|
675
675
|
location: {
|
|
676
676
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -680,7 +680,7 @@ exports.manifest = {
|
|
|
680
680
|
},
|
|
681
681
|
formValues: {
|
|
682
682
|
comment: {
|
|
683
|
-
|
|
683
|
+
markdownText: 'The complete internal form state.',
|
|
684
684
|
},
|
|
685
685
|
location: {
|
|
686
686
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -690,7 +690,7 @@ exports.manifest = {
|
|
|
690
690
|
},
|
|
691
691
|
itemStatus: {
|
|
692
692
|
comment: {
|
|
693
|
-
|
|
693
|
+
markdownText: 'The current status of the record being edited.',
|
|
694
694
|
},
|
|
695
695
|
location: {
|
|
696
696
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -700,7 +700,7 @@ exports.manifest = {
|
|
|
700
700
|
},
|
|
701
701
|
isSubmitting: {
|
|
702
702
|
comment: {
|
|
703
|
-
|
|
703
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
704
704
|
},
|
|
705
705
|
location: {
|
|
706
706
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -710,7 +710,7 @@ exports.manifest = {
|
|
|
710
710
|
},
|
|
711
711
|
isFormDirty: {
|
|
712
712
|
comment: {
|
|
713
|
-
|
|
713
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
714
714
|
},
|
|
715
715
|
location: {
|
|
716
716
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -720,7 +720,7 @@ exports.manifest = {
|
|
|
720
720
|
},
|
|
721
721
|
blocksAnalysis: {
|
|
722
722
|
comment: {
|
|
723
|
-
|
|
723
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
724
724
|
},
|
|
725
725
|
location: {
|
|
726
726
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -734,7 +734,7 @@ exports.manifest = {
|
|
|
734
734
|
items: {
|
|
735
735
|
sidebarId: {
|
|
736
736
|
comment: {
|
|
737
|
-
|
|
737
|
+
markdownText: 'The ID of the sidebar that needs to be rendered.',
|
|
738
738
|
},
|
|
739
739
|
location: {
|
|
740
740
|
filePath: 'src/hooks/renderItemFormSidebar.ts',
|
|
@@ -744,7 +744,7 @@ exports.manifest = {
|
|
|
744
744
|
},
|
|
745
745
|
parameters: {
|
|
746
746
|
comment: {
|
|
747
|
-
|
|
747
|
+
markdownText: 'The arbitrary `parameters` of the declared in the `itemFormSidebars`\nfunction.',
|
|
748
748
|
},
|
|
749
749
|
location: {
|
|
750
750
|
filePath: 'src/hooks/renderItemFormSidebar.ts',
|
|
@@ -759,12 +759,12 @@ exports.manifest = {
|
|
|
759
759
|
{
|
|
760
760
|
name: 'ItemFormAdditionalMethods',
|
|
761
761
|
comment: {
|
|
762
|
-
|
|
762
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
763
763
|
},
|
|
764
764
|
items: {
|
|
765
765
|
toggleField: {
|
|
766
766
|
comment: {
|
|
767
|
-
|
|
767
|
+
markdownText: 'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
|
|
768
768
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
|
|
769
769
|
},
|
|
770
770
|
location: {
|
|
@@ -775,7 +775,7 @@ exports.manifest = {
|
|
|
775
775
|
},
|
|
776
776
|
disableField: {
|
|
777
777
|
comment: {
|
|
778
|
-
|
|
778
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
779
779
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
|
|
780
780
|
},
|
|
781
781
|
location: {
|
|
@@ -786,7 +786,7 @@ exports.manifest = {
|
|
|
786
786
|
},
|
|
787
787
|
scrollToField: {
|
|
788
788
|
comment: {
|
|
789
|
-
|
|
789
|
+
markdownText: 'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
|
|
790
790
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
|
|
791
791
|
},
|
|
792
792
|
location: {
|
|
@@ -797,7 +797,7 @@ exports.manifest = {
|
|
|
797
797
|
},
|
|
798
798
|
setFieldValue: {
|
|
799
799
|
comment: {
|
|
800
|
-
|
|
800
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
801
801
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
|
|
802
802
|
},
|
|
803
803
|
location: {
|
|
@@ -808,7 +808,7 @@ exports.manifest = {
|
|
|
808
808
|
},
|
|
809
809
|
formValuesToItem: {
|
|
810
810
|
comment: {
|
|
811
|
-
|
|
811
|
+
markdownText: 'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
|
|
812
812
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
813
813
|
},
|
|
814
814
|
location: {
|
|
@@ -819,7 +819,7 @@ exports.manifest = {
|
|
|
819
819
|
},
|
|
820
820
|
itemToFormValues: {
|
|
821
821
|
comment: {
|
|
822
|
-
|
|
822
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
823
823
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
824
824
|
},
|
|
825
825
|
location: {
|
|
@@ -830,7 +830,7 @@ exports.manifest = {
|
|
|
830
830
|
},
|
|
831
831
|
saveCurrentItem: {
|
|
832
832
|
comment: {
|
|
833
|
-
|
|
833
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
834
834
|
example: 'await ctx.saveCurrentItem();',
|
|
835
835
|
},
|
|
836
836
|
location: {
|
|
@@ -852,7 +852,7 @@ exports.manifest = {
|
|
|
852
852
|
renderItemFormOutlet: {
|
|
853
853
|
name: 'renderItemFormOutlet',
|
|
854
854
|
comment: {
|
|
855
|
-
|
|
855
|
+
markdownText: 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemFormOutlets()` hook.',
|
|
856
856
|
tag: 'outlets',
|
|
857
857
|
},
|
|
858
858
|
nonCtxArguments: [
|
|
@@ -867,12 +867,12 @@ exports.manifest = {
|
|
|
867
867
|
{
|
|
868
868
|
name: 'ItemFormAdditionalProperties',
|
|
869
869
|
comment: {
|
|
870
|
-
|
|
870
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
871
871
|
},
|
|
872
872
|
items: {
|
|
873
873
|
locale: {
|
|
874
874
|
comment: {
|
|
875
|
-
|
|
875
|
+
markdownText: 'The currently active locale for the record.',
|
|
876
876
|
},
|
|
877
877
|
location: {
|
|
878
878
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -882,7 +882,7 @@ exports.manifest = {
|
|
|
882
882
|
},
|
|
883
883
|
item: {
|
|
884
884
|
comment: {
|
|
885
|
-
|
|
885
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
886
886
|
},
|
|
887
887
|
location: {
|
|
888
888
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -892,7 +892,7 @@ exports.manifest = {
|
|
|
892
892
|
},
|
|
893
893
|
itemType: {
|
|
894
894
|
comment: {
|
|
895
|
-
|
|
895
|
+
markdownText: 'The model for the record being edited.',
|
|
896
896
|
},
|
|
897
897
|
location: {
|
|
898
898
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -902,7 +902,7 @@ exports.manifest = {
|
|
|
902
902
|
},
|
|
903
903
|
formValues: {
|
|
904
904
|
comment: {
|
|
905
|
-
|
|
905
|
+
markdownText: 'The complete internal form state.',
|
|
906
906
|
},
|
|
907
907
|
location: {
|
|
908
908
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -912,7 +912,7 @@ exports.manifest = {
|
|
|
912
912
|
},
|
|
913
913
|
itemStatus: {
|
|
914
914
|
comment: {
|
|
915
|
-
|
|
915
|
+
markdownText: 'The current status of the record being edited.',
|
|
916
916
|
},
|
|
917
917
|
location: {
|
|
918
918
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -922,7 +922,7 @@ exports.manifest = {
|
|
|
922
922
|
},
|
|
923
923
|
isSubmitting: {
|
|
924
924
|
comment: {
|
|
925
|
-
|
|
925
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
926
926
|
},
|
|
927
927
|
location: {
|
|
928
928
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -932,7 +932,7 @@ exports.manifest = {
|
|
|
932
932
|
},
|
|
933
933
|
isFormDirty: {
|
|
934
934
|
comment: {
|
|
935
|
-
|
|
935
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
936
936
|
},
|
|
937
937
|
location: {
|
|
938
938
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -942,7 +942,7 @@ exports.manifest = {
|
|
|
942
942
|
},
|
|
943
943
|
blocksAnalysis: {
|
|
944
944
|
comment: {
|
|
945
|
-
|
|
945
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
946
946
|
},
|
|
947
947
|
location: {
|
|
948
948
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -956,7 +956,7 @@ exports.manifest = {
|
|
|
956
956
|
items: {
|
|
957
957
|
itemFormOutletId: {
|
|
958
958
|
comment: {
|
|
959
|
-
|
|
959
|
+
markdownText: 'The ID of the outlet that needs to be rendered.',
|
|
960
960
|
},
|
|
961
961
|
location: {
|
|
962
962
|
filePath: 'src/hooks/renderItemFormOutlet.ts',
|
|
@@ -971,12 +971,12 @@ exports.manifest = {
|
|
|
971
971
|
{
|
|
972
972
|
name: 'ItemFormAdditionalMethods',
|
|
973
973
|
comment: {
|
|
974
|
-
|
|
974
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
975
975
|
},
|
|
976
976
|
items: {
|
|
977
977
|
toggleField: {
|
|
978
978
|
comment: {
|
|
979
|
-
|
|
979
|
+
markdownText: 'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
|
|
980
980
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
|
|
981
981
|
},
|
|
982
982
|
location: {
|
|
@@ -987,7 +987,7 @@ exports.manifest = {
|
|
|
987
987
|
},
|
|
988
988
|
disableField: {
|
|
989
989
|
comment: {
|
|
990
|
-
|
|
990
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
991
991
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
|
|
992
992
|
},
|
|
993
993
|
location: {
|
|
@@ -998,7 +998,7 @@ exports.manifest = {
|
|
|
998
998
|
},
|
|
999
999
|
scrollToField: {
|
|
1000
1000
|
comment: {
|
|
1001
|
-
|
|
1001
|
+
markdownText: 'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
|
|
1002
1002
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
|
|
1003
1003
|
},
|
|
1004
1004
|
location: {
|
|
@@ -1009,7 +1009,7 @@ exports.manifest = {
|
|
|
1009
1009
|
},
|
|
1010
1010
|
setFieldValue: {
|
|
1011
1011
|
comment: {
|
|
1012
|
-
|
|
1012
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
1013
1013
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
|
|
1014
1014
|
},
|
|
1015
1015
|
location: {
|
|
@@ -1020,7 +1020,7 @@ exports.manifest = {
|
|
|
1020
1020
|
},
|
|
1021
1021
|
formValuesToItem: {
|
|
1022
1022
|
comment: {
|
|
1023
|
-
|
|
1023
|
+
markdownText: 'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
|
|
1024
1024
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
1025
1025
|
},
|
|
1026
1026
|
location: {
|
|
@@ -1031,7 +1031,7 @@ exports.manifest = {
|
|
|
1031
1031
|
},
|
|
1032
1032
|
itemToFormValues: {
|
|
1033
1033
|
comment: {
|
|
1034
|
-
|
|
1034
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
1035
1035
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
1036
1036
|
},
|
|
1037
1037
|
location: {
|
|
@@ -1042,7 +1042,7 @@ exports.manifest = {
|
|
|
1042
1042
|
},
|
|
1043
1043
|
saveCurrentItem: {
|
|
1044
1044
|
comment: {
|
|
1045
|
-
|
|
1045
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
1046
1046
|
example: 'await ctx.saveCurrentItem();',
|
|
1047
1047
|
},
|
|
1048
1048
|
location: {
|
|
@@ -1064,7 +1064,7 @@ exports.manifest = {
|
|
|
1064
1064
|
renderItemCollectionOutlet: {
|
|
1065
1065
|
name: 'renderItemCollectionOutlet',
|
|
1066
1066
|
comment: {
|
|
1067
|
-
|
|
1067
|
+
markdownText: 'This function will be called when the plugin needs to render an outlet\ndefined by the `itemCollectionOutlets()` hook.',
|
|
1068
1068
|
tag: 'outlets',
|
|
1069
1069
|
},
|
|
1070
1070
|
nonCtxArguments: [
|
|
@@ -1080,14 +1080,24 @@ exports.manifest = {
|
|
|
1080
1080
|
items: {
|
|
1081
1081
|
itemCollectionOutletId: {
|
|
1082
1082
|
comment: {
|
|
1083
|
-
|
|
1083
|
+
markdownText: 'The ID of the outlet that needs to be rendered.',
|
|
1084
1084
|
},
|
|
1085
1085
|
location: {
|
|
1086
1086
|
filePath: 'src/hooks/renderItemCollectionOutlet.ts',
|
|
1087
|
-
lineNumber:
|
|
1087
|
+
lineNumber: 24,
|
|
1088
1088
|
},
|
|
1089
1089
|
type: 'string',
|
|
1090
1090
|
},
|
|
1091
|
+
itemType: {
|
|
1092
|
+
comment: {
|
|
1093
|
+
markdownText: 'The model for which the outlet is being rendered.',
|
|
1094
|
+
},
|
|
1095
|
+
location: {
|
|
1096
|
+
filePath: 'src/hooks/renderItemCollectionOutlet.ts',
|
|
1097
|
+
lineNumber: 26,
|
|
1098
|
+
},
|
|
1099
|
+
type: 'ItemType',
|
|
1100
|
+
},
|
|
1091
1101
|
},
|
|
1092
1102
|
},
|
|
1093
1103
|
],
|
|
@@ -1096,13 +1106,13 @@ exports.manifest = {
|
|
|
1096
1106
|
returnType: 'void',
|
|
1097
1107
|
location: {
|
|
1098
1108
|
filePath: 'src/hooks/renderItemCollectionOutlet.ts',
|
|
1099
|
-
lineNumber:
|
|
1109
|
+
lineNumber: 14,
|
|
1100
1110
|
},
|
|
1101
1111
|
},
|
|
1102
1112
|
renderFieldExtension: {
|
|
1103
1113
|
name: 'renderFieldExtension',
|
|
1104
1114
|
comment: {
|
|
1105
|
-
|
|
1115
|
+
markdownText: 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions).',
|
|
1106
1116
|
tag: 'forcedFieldExtensions',
|
|
1107
1117
|
},
|
|
1108
1118
|
nonCtxArguments: [
|
|
@@ -1117,12 +1127,12 @@ exports.manifest = {
|
|
|
1117
1127
|
{
|
|
1118
1128
|
name: 'ItemFormAdditionalProperties',
|
|
1119
1129
|
comment: {
|
|
1120
|
-
|
|
1130
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
1121
1131
|
},
|
|
1122
1132
|
items: {
|
|
1123
1133
|
locale: {
|
|
1124
1134
|
comment: {
|
|
1125
|
-
|
|
1135
|
+
markdownText: 'The currently active locale for the record.',
|
|
1126
1136
|
},
|
|
1127
1137
|
location: {
|
|
1128
1138
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1132,7 +1142,7 @@ exports.manifest = {
|
|
|
1132
1142
|
},
|
|
1133
1143
|
item: {
|
|
1134
1144
|
comment: {
|
|
1135
|
-
|
|
1145
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
1136
1146
|
},
|
|
1137
1147
|
location: {
|
|
1138
1148
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1142,7 +1152,7 @@ exports.manifest = {
|
|
|
1142
1152
|
},
|
|
1143
1153
|
itemType: {
|
|
1144
1154
|
comment: {
|
|
1145
|
-
|
|
1155
|
+
markdownText: 'The model for the record being edited.',
|
|
1146
1156
|
},
|
|
1147
1157
|
location: {
|
|
1148
1158
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1152,7 +1162,7 @@ exports.manifest = {
|
|
|
1152
1162
|
},
|
|
1153
1163
|
formValues: {
|
|
1154
1164
|
comment: {
|
|
1155
|
-
|
|
1165
|
+
markdownText: 'The complete internal form state.',
|
|
1156
1166
|
},
|
|
1157
1167
|
location: {
|
|
1158
1168
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1162,7 +1172,7 @@ exports.manifest = {
|
|
|
1162
1172
|
},
|
|
1163
1173
|
itemStatus: {
|
|
1164
1174
|
comment: {
|
|
1165
|
-
|
|
1175
|
+
markdownText: 'The current status of the record being edited.',
|
|
1166
1176
|
},
|
|
1167
1177
|
location: {
|
|
1168
1178
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1172,7 +1182,7 @@ exports.manifest = {
|
|
|
1172
1182
|
},
|
|
1173
1183
|
isSubmitting: {
|
|
1174
1184
|
comment: {
|
|
1175
|
-
|
|
1185
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
1176
1186
|
},
|
|
1177
1187
|
location: {
|
|
1178
1188
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1182,7 +1192,7 @@ exports.manifest = {
|
|
|
1182
1192
|
},
|
|
1183
1193
|
isFormDirty: {
|
|
1184
1194
|
comment: {
|
|
1185
|
-
|
|
1195
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
1186
1196
|
},
|
|
1187
1197
|
location: {
|
|
1188
1198
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1192,7 +1202,7 @@ exports.manifest = {
|
|
|
1192
1202
|
},
|
|
1193
1203
|
blocksAnalysis: {
|
|
1194
1204
|
comment: {
|
|
1195
|
-
|
|
1205
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
1196
1206
|
},
|
|
1197
1207
|
location: {
|
|
1198
1208
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1205,12 +1215,12 @@ exports.manifest = {
|
|
|
1205
1215
|
{
|
|
1206
1216
|
name: 'FieldAdditionalProperties',
|
|
1207
1217
|
comment: {
|
|
1208
|
-
|
|
1218
|
+
markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
|
|
1209
1219
|
},
|
|
1210
1220
|
items: {
|
|
1211
1221
|
disabled: {
|
|
1212
1222
|
comment: {
|
|
1213
|
-
|
|
1223
|
+
markdownText: 'Whether the field is currently disabled or not.',
|
|
1214
1224
|
},
|
|
1215
1225
|
location: {
|
|
1216
1226
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1220,7 +1230,7 @@ exports.manifest = {
|
|
|
1220
1230
|
},
|
|
1221
1231
|
fieldPath: {
|
|
1222
1232
|
comment: {
|
|
1223
|
-
|
|
1233
|
+
markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
|
|
1224
1234
|
},
|
|
1225
1235
|
location: {
|
|
1226
1236
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1230,7 +1240,7 @@ exports.manifest = {
|
|
|
1230
1240
|
},
|
|
1231
1241
|
field: {
|
|
1232
1242
|
comment: {
|
|
1233
|
-
|
|
1243
|
+
markdownText: 'The field where the field extension is installed to.',
|
|
1234
1244
|
},
|
|
1235
1245
|
location: {
|
|
1236
1246
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1240,7 +1250,7 @@ exports.manifest = {
|
|
|
1240
1250
|
},
|
|
1241
1251
|
parentField: {
|
|
1242
1252
|
comment: {
|
|
1243
|
-
|
|
1253
|
+
markdownText: 'If the field extension is installed in a field of a block, returns the top\nlevel Modular Content/Structured Text field containing the block itself.',
|
|
1244
1254
|
},
|
|
1245
1255
|
location: {
|
|
1246
1256
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1250,7 +1260,7 @@ exports.manifest = {
|
|
|
1250
1260
|
},
|
|
1251
1261
|
block: {
|
|
1252
1262
|
comment: {
|
|
1253
|
-
|
|
1263
|
+
markdownText: 'If the field extension is installed in a field of a block, returns the ID\nof the block — or `undefined` if the block is still not persisted — and the\nblock model.',
|
|
1254
1264
|
},
|
|
1255
1265
|
location: {
|
|
1256
1266
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1264,7 +1274,7 @@ exports.manifest = {
|
|
|
1264
1274
|
items: {
|
|
1265
1275
|
fieldExtensionId: {
|
|
1266
1276
|
comment: {
|
|
1267
|
-
|
|
1277
|
+
markdownText: 'The ID of the field extension that needs to be rendered.',
|
|
1268
1278
|
},
|
|
1269
1279
|
location: {
|
|
1270
1280
|
filePath: 'src/hooks/renderFieldExtension.ts',
|
|
@@ -1274,7 +1284,7 @@ exports.manifest = {
|
|
|
1274
1284
|
},
|
|
1275
1285
|
parameters: {
|
|
1276
1286
|
comment: {
|
|
1277
|
-
|
|
1287
|
+
markdownText: 'The arbitrary `parameters` of the field extension.',
|
|
1278
1288
|
},
|
|
1279
1289
|
location: {
|
|
1280
1290
|
filePath: 'src/hooks/renderFieldExtension.ts',
|
|
@@ -1289,12 +1299,12 @@ exports.manifest = {
|
|
|
1289
1299
|
{
|
|
1290
1300
|
name: 'ItemFormAdditionalMethods',
|
|
1291
1301
|
comment: {
|
|
1292
|
-
|
|
1302
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
1293
1303
|
},
|
|
1294
1304
|
items: {
|
|
1295
1305
|
toggleField: {
|
|
1296
1306
|
comment: {
|
|
1297
|
-
|
|
1307
|
+
markdownText: 'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
|
|
1298
1308
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
|
|
1299
1309
|
},
|
|
1300
1310
|
location: {
|
|
@@ -1305,7 +1315,7 @@ exports.manifest = {
|
|
|
1305
1315
|
},
|
|
1306
1316
|
disableField: {
|
|
1307
1317
|
comment: {
|
|
1308
|
-
|
|
1318
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
1309
1319
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
|
|
1310
1320
|
},
|
|
1311
1321
|
location: {
|
|
@@ -1316,7 +1326,7 @@ exports.manifest = {
|
|
|
1316
1326
|
},
|
|
1317
1327
|
scrollToField: {
|
|
1318
1328
|
comment: {
|
|
1319
|
-
|
|
1329
|
+
markdownText: 'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
|
|
1320
1330
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
|
|
1321
1331
|
},
|
|
1322
1332
|
location: {
|
|
@@ -1327,7 +1337,7 @@ exports.manifest = {
|
|
|
1327
1337
|
},
|
|
1328
1338
|
setFieldValue: {
|
|
1329
1339
|
comment: {
|
|
1330
|
-
|
|
1340
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
1331
1341
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
|
|
1332
1342
|
},
|
|
1333
1343
|
location: {
|
|
@@ -1338,7 +1348,7 @@ exports.manifest = {
|
|
|
1338
1348
|
},
|
|
1339
1349
|
formValuesToItem: {
|
|
1340
1350
|
comment: {
|
|
1341
|
-
|
|
1351
|
+
markdownText: 'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
|
|
1342
1352
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
1343
1353
|
},
|
|
1344
1354
|
location: {
|
|
@@ -1349,7 +1359,7 @@ exports.manifest = {
|
|
|
1349
1359
|
},
|
|
1350
1360
|
itemToFormValues: {
|
|
1351
1361
|
comment: {
|
|
1352
|
-
|
|
1362
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
1353
1363
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
1354
1364
|
},
|
|
1355
1365
|
location: {
|
|
@@ -1360,7 +1370,7 @@ exports.manifest = {
|
|
|
1360
1370
|
},
|
|
1361
1371
|
saveCurrentItem: {
|
|
1362
1372
|
comment: {
|
|
1363
|
-
|
|
1373
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
1364
1374
|
example: 'await ctx.saveCurrentItem();',
|
|
1365
1375
|
},
|
|
1366
1376
|
location: {
|
|
@@ -1382,7 +1392,7 @@ exports.manifest = {
|
|
|
1382
1392
|
renderConfigScreen: {
|
|
1383
1393
|
name: 'renderConfigScreen',
|
|
1384
1394
|
comment: {
|
|
1385
|
-
|
|
1395
|
+
markdownText: "This function will be called when the plugin needs to render the plugin's\nconfiguration form.",
|
|
1386
1396
|
tag: 'configScreen',
|
|
1387
1397
|
},
|
|
1388
1398
|
nonCtxArguments: [],
|
|
@@ -1400,7 +1410,7 @@ exports.manifest = {
|
|
|
1400
1410
|
renderAssetSource: {
|
|
1401
1411
|
name: 'renderAssetSource',
|
|
1402
1412
|
comment: {
|
|
1403
|
-
|
|
1413
|
+
markdownText: "This function will be called when the user selects one of the plugin's\nasset sources to upload a new media file.",
|
|
1404
1414
|
tag: 'assetSources',
|
|
1405
1415
|
},
|
|
1406
1416
|
nonCtxArguments: [
|
|
@@ -1416,7 +1426,7 @@ exports.manifest = {
|
|
|
1416
1426
|
items: {
|
|
1417
1427
|
assetSourceId: {
|
|
1418
1428
|
comment: {
|
|
1419
|
-
|
|
1429
|
+
markdownText: 'The ID of the assetSource that needs to be rendered.',
|
|
1420
1430
|
},
|
|
1421
1431
|
location: {
|
|
1422
1432
|
filePath: 'src/hooks/renderAssetSource.ts',
|
|
@@ -1432,7 +1442,7 @@ exports.manifest = {
|
|
|
1432
1442
|
items: {
|
|
1433
1443
|
select: {
|
|
1434
1444
|
comment: {
|
|
1435
|
-
|
|
1445
|
+
markdownText: 'Function to be called when the user selects the asset: it will trigger the\ncreation of a new `Upload` that will be added in the Media Area.',
|
|
1436
1446
|
example: "await ctx.select({\n resource: {\n url: 'https://images.unsplash.com/photo-1416339306562-f3d12fefd36f',\n filename: 'man-drinking-coffee.jpg',\n },\n copyright: 'Royalty free (Unsplash)',\n author: 'Jeff Sheldon',\n notes: 'A man drinking a coffee',\n tags: ['man', 'coffee'],\n});",
|
|
1437
1447
|
},
|
|
1438
1448
|
location: {
|
|
@@ -1454,7 +1464,7 @@ exports.manifest = {
|
|
|
1454
1464
|
overrideFieldExtensions: {
|
|
1455
1465
|
name: 'overrideFieldExtensions',
|
|
1456
1466
|
comment: {
|
|
1457
|
-
|
|
1467
|
+
markdownText: 'Use this function to automatically force one or more field extensions to a\nparticular field.',
|
|
1458
1468
|
tag: 'forcedFieldExtensions',
|
|
1459
1469
|
},
|
|
1460
1470
|
nonCtxArguments: [
|
|
@@ -1489,7 +1499,7 @@ exports.manifest = {
|
|
|
1489
1499
|
onBoot: {
|
|
1490
1500
|
name: 'onBoot',
|
|
1491
1501
|
comment: {
|
|
1492
|
-
|
|
1502
|
+
markdownText: 'This function will be called once at boot time and can be used to perform\nie. some initial integrity checks on the configuration.',
|
|
1493
1503
|
tag: 'boot',
|
|
1494
1504
|
},
|
|
1495
1505
|
nonCtxArguments: [],
|
|
@@ -1507,7 +1517,7 @@ exports.manifest = {
|
|
|
1507
1517
|
onBeforeItemsUnpublish: {
|
|
1508
1518
|
name: 'onBeforeItemsUnpublish',
|
|
1509
1519
|
comment: {
|
|
1510
|
-
|
|
1520
|
+
markdownText: 'This function will be called before unpublishing records. You can stop the\naction by returning `false`.',
|
|
1511
1521
|
tag: 'beforeHooks',
|
|
1512
1522
|
},
|
|
1513
1523
|
nonCtxArguments: [
|
|
@@ -1530,7 +1540,7 @@ exports.manifest = {
|
|
|
1530
1540
|
onBeforeItemsPublish: {
|
|
1531
1541
|
name: 'onBeforeItemsPublish',
|
|
1532
1542
|
comment: {
|
|
1533
|
-
|
|
1543
|
+
markdownText: 'This function will be called before publishing records. You can stop the\naction by returning `false`.',
|
|
1534
1544
|
tag: 'beforeHooks',
|
|
1535
1545
|
},
|
|
1536
1546
|
nonCtxArguments: [
|
|
@@ -1553,7 +1563,7 @@ exports.manifest = {
|
|
|
1553
1563
|
onBeforeItemsDestroy: {
|
|
1554
1564
|
name: 'onBeforeItemsDestroy',
|
|
1555
1565
|
comment: {
|
|
1556
|
-
|
|
1566
|
+
markdownText: 'This function will be called before destroying records. You can stop the\naction by returning `false`.',
|
|
1557
1567
|
tag: 'beforeHooks',
|
|
1558
1568
|
},
|
|
1559
1569
|
nonCtxArguments: [
|
|
@@ -1576,7 +1586,7 @@ exports.manifest = {
|
|
|
1576
1586
|
onBeforeItemUpsert: {
|
|
1577
1587
|
name: 'onBeforeItemUpsert',
|
|
1578
1588
|
comment: {
|
|
1579
|
-
|
|
1589
|
+
markdownText: 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`.',
|
|
1580
1590
|
tag: 'beforeHooks',
|
|
1581
1591
|
},
|
|
1582
1592
|
nonCtxArguments: [
|
|
@@ -1599,7 +1609,7 @@ exports.manifest = {
|
|
|
1599
1609
|
manualFieldExtensions: {
|
|
1600
1610
|
name: 'manualFieldExtensions',
|
|
1601
1611
|
comment: {
|
|
1602
|
-
|
|
1612
|
+
markdownText: 'Use this function to declare new field extensions that users will be able\nto install manually in some field.',
|
|
1603
1613
|
tag: 'manualFieldExtensions',
|
|
1604
1614
|
},
|
|
1605
1615
|
nonCtxArguments: [],
|
|
@@ -1617,7 +1627,7 @@ exports.manifest = {
|
|
|
1617
1627
|
mainNavigationTabs: {
|
|
1618
1628
|
name: 'mainNavigationTabs',
|
|
1619
1629
|
comment: {
|
|
1620
|
-
|
|
1630
|
+
markdownText: 'Use this function to declare new tabs you want to add in the top-bar of the\nUI.',
|
|
1621
1631
|
tag: 'pages',
|
|
1622
1632
|
},
|
|
1623
1633
|
nonCtxArguments: [],
|
|
@@ -1635,7 +1645,7 @@ exports.manifest = {
|
|
|
1635
1645
|
itemsDropdownActions: {
|
|
1636
1646
|
name: 'itemsDropdownActions',
|
|
1637
1647
|
comment: {
|
|
1638
|
-
|
|
1648
|
+
markdownText: 'This function lets you set up custom actions (or groups of actions) that\nshow up when the user:\n\n* selects multiple records in the collection view for batch operations, or\n* starts editing a specific record.\n\nThe `executeItemsDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
|
|
1639
1649
|
tag: 'dropdownActions',
|
|
1640
1650
|
},
|
|
1641
1651
|
nonCtxArguments: [
|
|
@@ -1670,7 +1680,7 @@ exports.manifest = {
|
|
|
1670
1680
|
itemFormSidebars: {
|
|
1671
1681
|
name: 'itemFormSidebars',
|
|
1672
1682
|
comment: {
|
|
1673
|
-
|
|
1683
|
+
markdownText: 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model.',
|
|
1674
1684
|
tag: 'sidebarPanels',
|
|
1675
1685
|
},
|
|
1676
1686
|
nonCtxArguments: [
|
|
@@ -1693,7 +1703,7 @@ exports.manifest = {
|
|
|
1693
1703
|
itemFormSidebarPanels: {
|
|
1694
1704
|
name: 'itemFormSidebarPanels',
|
|
1695
1705
|
comment: {
|
|
1696
|
-
|
|
1706
|
+
markdownText: 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model.',
|
|
1697
1707
|
tag: 'sidebarPanels',
|
|
1698
1708
|
},
|
|
1699
1709
|
nonCtxArguments: [
|
|
@@ -1716,7 +1726,7 @@ exports.manifest = {
|
|
|
1716
1726
|
itemFormOutlets: {
|
|
1717
1727
|
name: 'itemFormOutlets',
|
|
1718
1728
|
comment: {
|
|
1719
|
-
|
|
1729
|
+
markdownText: "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page.",
|
|
1720
1730
|
tag: 'outlets',
|
|
1721
1731
|
},
|
|
1722
1732
|
nonCtxArguments: [
|
|
@@ -1739,7 +1749,7 @@ exports.manifest = {
|
|
|
1739
1749
|
itemFormDropdownActions: {
|
|
1740
1750
|
name: 'itemFormDropdownActions',
|
|
1741
1751
|
comment: {
|
|
1742
|
-
|
|
1752
|
+
markdownText: 'Use this function to define custom actions (or groups of actions) to be\ndisplayed at when editing a particular record.\n\nThe `executeItemFormDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
|
|
1743
1753
|
tag: 'dropdownActions',
|
|
1744
1754
|
},
|
|
1745
1755
|
nonCtxArguments: [
|
|
@@ -1754,12 +1764,12 @@ exports.manifest = {
|
|
|
1754
1764
|
{
|
|
1755
1765
|
name: 'ItemFormAdditionalProperties',
|
|
1756
1766
|
comment: {
|
|
1757
|
-
|
|
1767
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
1758
1768
|
},
|
|
1759
1769
|
items: {
|
|
1760
1770
|
locale: {
|
|
1761
1771
|
comment: {
|
|
1762
|
-
|
|
1772
|
+
markdownText: 'The currently active locale for the record.',
|
|
1763
1773
|
},
|
|
1764
1774
|
location: {
|
|
1765
1775
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1769,7 +1779,7 @@ exports.manifest = {
|
|
|
1769
1779
|
},
|
|
1770
1780
|
item: {
|
|
1771
1781
|
comment: {
|
|
1772
|
-
|
|
1782
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
1773
1783
|
},
|
|
1774
1784
|
location: {
|
|
1775
1785
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1779,7 +1789,7 @@ exports.manifest = {
|
|
|
1779
1789
|
},
|
|
1780
1790
|
itemType: {
|
|
1781
1791
|
comment: {
|
|
1782
|
-
|
|
1792
|
+
markdownText: 'The model for the record being edited.',
|
|
1783
1793
|
},
|
|
1784
1794
|
location: {
|
|
1785
1795
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1789,7 +1799,7 @@ exports.manifest = {
|
|
|
1789
1799
|
},
|
|
1790
1800
|
formValues: {
|
|
1791
1801
|
comment: {
|
|
1792
|
-
|
|
1802
|
+
markdownText: 'The complete internal form state.',
|
|
1793
1803
|
},
|
|
1794
1804
|
location: {
|
|
1795
1805
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1799,7 +1809,7 @@ exports.manifest = {
|
|
|
1799
1809
|
},
|
|
1800
1810
|
itemStatus: {
|
|
1801
1811
|
comment: {
|
|
1802
|
-
|
|
1812
|
+
markdownText: 'The current status of the record being edited.',
|
|
1803
1813
|
},
|
|
1804
1814
|
location: {
|
|
1805
1815
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1809,7 +1819,7 @@ exports.manifest = {
|
|
|
1809
1819
|
},
|
|
1810
1820
|
isSubmitting: {
|
|
1811
1821
|
comment: {
|
|
1812
|
-
|
|
1822
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
1813
1823
|
},
|
|
1814
1824
|
location: {
|
|
1815
1825
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1819,7 +1829,7 @@ exports.manifest = {
|
|
|
1819
1829
|
},
|
|
1820
1830
|
isFormDirty: {
|
|
1821
1831
|
comment: {
|
|
1822
|
-
|
|
1832
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
1823
1833
|
},
|
|
1824
1834
|
location: {
|
|
1825
1835
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1829,7 +1839,7 @@ exports.manifest = {
|
|
|
1829
1839
|
},
|
|
1830
1840
|
blocksAnalysis: {
|
|
1831
1841
|
comment: {
|
|
1832
|
-
|
|
1842
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
1833
1843
|
},
|
|
1834
1844
|
location: {
|
|
1835
1845
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1851,7 +1861,7 @@ exports.manifest = {
|
|
|
1851
1861
|
itemCollectionOutlets: {
|
|
1852
1862
|
name: 'itemCollectionOutlets',
|
|
1853
1863
|
comment: {
|
|
1854
|
-
|
|
1864
|
+
markdownText: 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model.',
|
|
1855
1865
|
tag: 'outlets',
|
|
1856
1866
|
},
|
|
1857
1867
|
nonCtxArguments: [
|
|
@@ -1874,7 +1884,7 @@ exports.manifest = {
|
|
|
1874
1884
|
initialLocationQueryForItemSelector: {
|
|
1875
1885
|
name: 'initialLocationQueryForItemSelector',
|
|
1876
1886
|
comment: {
|
|
1877
|
-
|
|
1887
|
+
markdownText: 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field.',
|
|
1878
1888
|
tag: 'locationQuery',
|
|
1879
1889
|
},
|
|
1880
1890
|
nonCtxArguments: [
|
|
@@ -1901,7 +1911,7 @@ exports.manifest = {
|
|
|
1901
1911
|
fieldDropdownActions: {
|
|
1902
1912
|
name: 'fieldDropdownActions',
|
|
1903
1913
|
comment: {
|
|
1904
|
-
|
|
1914
|
+
markdownText: 'Use this function to define custom actions (or groups of actions) to be\ndisplayed at the individual field level in the record editing form.\n\nThe `executeFieldDropdownAction()` hook will be triggered once the user\nclicks on one of the defined actions.',
|
|
1905
1915
|
tag: 'dropdownActions',
|
|
1906
1916
|
},
|
|
1907
1917
|
nonCtxArguments: [
|
|
@@ -1916,12 +1926,12 @@ exports.manifest = {
|
|
|
1916
1926
|
{
|
|
1917
1927
|
name: 'ItemFormAdditionalProperties',
|
|
1918
1928
|
comment: {
|
|
1919
|
-
|
|
1929
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
1920
1930
|
},
|
|
1921
1931
|
items: {
|
|
1922
1932
|
locale: {
|
|
1923
1933
|
comment: {
|
|
1924
|
-
|
|
1934
|
+
markdownText: 'The currently active locale for the record.',
|
|
1925
1935
|
},
|
|
1926
1936
|
location: {
|
|
1927
1937
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1931,7 +1941,7 @@ exports.manifest = {
|
|
|
1931
1941
|
},
|
|
1932
1942
|
item: {
|
|
1933
1943
|
comment: {
|
|
1934
|
-
|
|
1944
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
1935
1945
|
},
|
|
1936
1946
|
location: {
|
|
1937
1947
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1941,7 +1951,7 @@ exports.manifest = {
|
|
|
1941
1951
|
},
|
|
1942
1952
|
itemType: {
|
|
1943
1953
|
comment: {
|
|
1944
|
-
|
|
1954
|
+
markdownText: 'The model for the record being edited.',
|
|
1945
1955
|
},
|
|
1946
1956
|
location: {
|
|
1947
1957
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1951,7 +1961,7 @@ exports.manifest = {
|
|
|
1951
1961
|
},
|
|
1952
1962
|
formValues: {
|
|
1953
1963
|
comment: {
|
|
1954
|
-
|
|
1964
|
+
markdownText: 'The complete internal form state.',
|
|
1955
1965
|
},
|
|
1956
1966
|
location: {
|
|
1957
1967
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1961,7 +1971,7 @@ exports.manifest = {
|
|
|
1961
1971
|
},
|
|
1962
1972
|
itemStatus: {
|
|
1963
1973
|
comment: {
|
|
1964
|
-
|
|
1974
|
+
markdownText: 'The current status of the record being edited.',
|
|
1965
1975
|
},
|
|
1966
1976
|
location: {
|
|
1967
1977
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1971,7 +1981,7 @@ exports.manifest = {
|
|
|
1971
1981
|
},
|
|
1972
1982
|
isSubmitting: {
|
|
1973
1983
|
comment: {
|
|
1974
|
-
|
|
1984
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
1975
1985
|
},
|
|
1976
1986
|
location: {
|
|
1977
1987
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1981,7 +1991,7 @@ exports.manifest = {
|
|
|
1981
1991
|
},
|
|
1982
1992
|
isFormDirty: {
|
|
1983
1993
|
comment: {
|
|
1984
|
-
|
|
1994
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
1985
1995
|
},
|
|
1986
1996
|
location: {
|
|
1987
1997
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1991,7 +2001,7 @@ exports.manifest = {
|
|
|
1991
2001
|
},
|
|
1992
2002
|
blocksAnalysis: {
|
|
1993
2003
|
comment: {
|
|
1994
|
-
|
|
2004
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
1995
2005
|
},
|
|
1996
2006
|
location: {
|
|
1997
2007
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2004,12 +2014,12 @@ exports.manifest = {
|
|
|
2004
2014
|
{
|
|
2005
2015
|
name: 'FieldAdditionalProperties',
|
|
2006
2016
|
comment: {
|
|
2007
|
-
|
|
2017
|
+
markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
|
|
2008
2018
|
},
|
|
2009
2019
|
items: {
|
|
2010
2020
|
disabled: {
|
|
2011
2021
|
comment: {
|
|
2012
|
-
|
|
2022
|
+
markdownText: 'Whether the field is currently disabled or not.',
|
|
2013
2023
|
},
|
|
2014
2024
|
location: {
|
|
2015
2025
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2019,7 +2029,7 @@ exports.manifest = {
|
|
|
2019
2029
|
},
|
|
2020
2030
|
fieldPath: {
|
|
2021
2031
|
comment: {
|
|
2022
|
-
|
|
2032
|
+
markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
|
|
2023
2033
|
},
|
|
2024
2034
|
location: {
|
|
2025
2035
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2029,7 +2039,7 @@ exports.manifest = {
|
|
|
2029
2039
|
},
|
|
2030
2040
|
field: {
|
|
2031
2041
|
comment: {
|
|
2032
|
-
|
|
2042
|
+
markdownText: 'The field where the field extension is installed to.',
|
|
2033
2043
|
},
|
|
2034
2044
|
location: {
|
|
2035
2045
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2039,7 +2049,7 @@ exports.manifest = {
|
|
|
2039
2049
|
},
|
|
2040
2050
|
parentField: {
|
|
2041
2051
|
comment: {
|
|
2042
|
-
|
|
2052
|
+
markdownText: 'If the field extension is installed in a field of a block, returns the top\nlevel Modular Content/Structured Text field containing the block itself.',
|
|
2043
2053
|
},
|
|
2044
2054
|
location: {
|
|
2045
2055
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2049,7 +2059,7 @@ exports.manifest = {
|
|
|
2049
2059
|
},
|
|
2050
2060
|
block: {
|
|
2051
2061
|
comment: {
|
|
2052
|
-
|
|
2062
|
+
markdownText: 'If the field extension is installed in a field of a block, returns the ID\nof the block — or `undefined` if the block is still not persisted — and the\nblock model.',
|
|
2053
2063
|
},
|
|
2054
2064
|
location: {
|
|
2055
2065
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2071,7 +2081,7 @@ exports.manifest = {
|
|
|
2071
2081
|
executeUploadsDropdownAction: {
|
|
2072
2082
|
name: 'executeUploadsDropdownAction',
|
|
2073
2083
|
comment: {
|
|
2074
|
-
|
|
2084
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `uploadsDropdownActions()` hook.',
|
|
2075
2085
|
tag: 'dropdownActions',
|
|
2076
2086
|
},
|
|
2077
2087
|
nonCtxArguments: [
|
|
@@ -2110,7 +2120,7 @@ exports.manifest = {
|
|
|
2110
2120
|
executeItemsDropdownAction: {
|
|
2111
2121
|
name: 'executeItemsDropdownAction',
|
|
2112
2122
|
comment: {
|
|
2113
|
-
|
|
2123
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `itemsDropdownActions()` hook.',
|
|
2114
2124
|
tag: 'dropdownActions',
|
|
2115
2125
|
},
|
|
2116
2126
|
nonCtxArguments: [
|
|
@@ -2149,7 +2159,7 @@ exports.manifest = {
|
|
|
2149
2159
|
executeItemFormDropdownAction: {
|
|
2150
2160
|
name: 'executeItemFormDropdownAction',
|
|
2151
2161
|
comment: {
|
|
2152
|
-
|
|
2162
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `itemFormDropdownActions()` hook.',
|
|
2153
2163
|
tag: 'dropdownActions',
|
|
2154
2164
|
},
|
|
2155
2165
|
nonCtxArguments: [
|
|
@@ -2164,12 +2174,12 @@ exports.manifest = {
|
|
|
2164
2174
|
{
|
|
2165
2175
|
name: 'ItemFormAdditionalProperties',
|
|
2166
2176
|
comment: {
|
|
2167
|
-
|
|
2177
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
2168
2178
|
},
|
|
2169
2179
|
items: {
|
|
2170
2180
|
locale: {
|
|
2171
2181
|
comment: {
|
|
2172
|
-
|
|
2182
|
+
markdownText: 'The currently active locale for the record.',
|
|
2173
2183
|
},
|
|
2174
2184
|
location: {
|
|
2175
2185
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2179,7 +2189,7 @@ exports.manifest = {
|
|
|
2179
2189
|
},
|
|
2180
2190
|
item: {
|
|
2181
2191
|
comment: {
|
|
2182
|
-
|
|
2192
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
2183
2193
|
},
|
|
2184
2194
|
location: {
|
|
2185
2195
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2189,7 +2199,7 @@ exports.manifest = {
|
|
|
2189
2199
|
},
|
|
2190
2200
|
itemType: {
|
|
2191
2201
|
comment: {
|
|
2192
|
-
|
|
2202
|
+
markdownText: 'The model for the record being edited.',
|
|
2193
2203
|
},
|
|
2194
2204
|
location: {
|
|
2195
2205
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2199,7 +2209,7 @@ exports.manifest = {
|
|
|
2199
2209
|
},
|
|
2200
2210
|
formValues: {
|
|
2201
2211
|
comment: {
|
|
2202
|
-
|
|
2212
|
+
markdownText: 'The complete internal form state.',
|
|
2203
2213
|
},
|
|
2204
2214
|
location: {
|
|
2205
2215
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2209,7 +2219,7 @@ exports.manifest = {
|
|
|
2209
2219
|
},
|
|
2210
2220
|
itemStatus: {
|
|
2211
2221
|
comment: {
|
|
2212
|
-
|
|
2222
|
+
markdownText: 'The current status of the record being edited.',
|
|
2213
2223
|
},
|
|
2214
2224
|
location: {
|
|
2215
2225
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2219,7 +2229,7 @@ exports.manifest = {
|
|
|
2219
2229
|
},
|
|
2220
2230
|
isSubmitting: {
|
|
2221
2231
|
comment: {
|
|
2222
|
-
|
|
2232
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
2223
2233
|
},
|
|
2224
2234
|
location: {
|
|
2225
2235
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2229,7 +2239,7 @@ exports.manifest = {
|
|
|
2229
2239
|
},
|
|
2230
2240
|
isFormDirty: {
|
|
2231
2241
|
comment: {
|
|
2232
|
-
|
|
2242
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
2233
2243
|
},
|
|
2234
2244
|
location: {
|
|
2235
2245
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2239,7 +2249,7 @@ exports.manifest = {
|
|
|
2239
2249
|
},
|
|
2240
2250
|
blocksAnalysis: {
|
|
2241
2251
|
comment: {
|
|
2242
|
-
|
|
2252
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
2243
2253
|
},
|
|
2244
2254
|
location: {
|
|
2245
2255
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2265,12 +2275,12 @@ exports.manifest = {
|
|
|
2265
2275
|
{
|
|
2266
2276
|
name: 'ItemFormAdditionalMethods',
|
|
2267
2277
|
comment: {
|
|
2268
|
-
|
|
2278
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
2269
2279
|
},
|
|
2270
2280
|
items: {
|
|
2271
2281
|
toggleField: {
|
|
2272
2282
|
comment: {
|
|
2273
|
-
|
|
2283
|
+
markdownText: 'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
|
|
2274
2284
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
|
|
2275
2285
|
},
|
|
2276
2286
|
location: {
|
|
@@ -2281,7 +2291,7 @@ exports.manifest = {
|
|
|
2281
2291
|
},
|
|
2282
2292
|
disableField: {
|
|
2283
2293
|
comment: {
|
|
2284
|
-
|
|
2294
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
2285
2295
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
|
|
2286
2296
|
},
|
|
2287
2297
|
location: {
|
|
@@ -2292,7 +2302,7 @@ exports.manifest = {
|
|
|
2292
2302
|
},
|
|
2293
2303
|
scrollToField: {
|
|
2294
2304
|
comment: {
|
|
2295
|
-
|
|
2305
|
+
markdownText: 'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
|
|
2296
2306
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
|
|
2297
2307
|
},
|
|
2298
2308
|
location: {
|
|
@@ -2303,7 +2313,7 @@ exports.manifest = {
|
|
|
2303
2313
|
},
|
|
2304
2314
|
setFieldValue: {
|
|
2305
2315
|
comment: {
|
|
2306
|
-
|
|
2316
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
2307
2317
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
|
|
2308
2318
|
},
|
|
2309
2319
|
location: {
|
|
@@ -2314,7 +2324,7 @@ exports.manifest = {
|
|
|
2314
2324
|
},
|
|
2315
2325
|
formValuesToItem: {
|
|
2316
2326
|
comment: {
|
|
2317
|
-
|
|
2327
|
+
markdownText: 'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
|
|
2318
2328
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
2319
2329
|
},
|
|
2320
2330
|
location: {
|
|
@@ -2325,7 +2335,7 @@ exports.manifest = {
|
|
|
2325
2335
|
},
|
|
2326
2336
|
itemToFormValues: {
|
|
2327
2337
|
comment: {
|
|
2328
|
-
|
|
2338
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
2329
2339
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
2330
2340
|
},
|
|
2331
2341
|
location: {
|
|
@@ -2336,7 +2346,7 @@ exports.manifest = {
|
|
|
2336
2346
|
},
|
|
2337
2347
|
saveCurrentItem: {
|
|
2338
2348
|
comment: {
|
|
2339
|
-
|
|
2349
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
2340
2350
|
example: 'await ctx.saveCurrentItem();',
|
|
2341
2351
|
},
|
|
2342
2352
|
location: {
|
|
@@ -2358,7 +2368,7 @@ exports.manifest = {
|
|
|
2358
2368
|
executeFieldDropdownAction: {
|
|
2359
2369
|
name: 'executeFieldDropdownAction',
|
|
2360
2370
|
comment: {
|
|
2361
|
-
|
|
2371
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `fieldDropdownActions()` hook.',
|
|
2362
2372
|
tag: 'dropdownActions',
|
|
2363
2373
|
},
|
|
2364
2374
|
nonCtxArguments: [
|
|
@@ -2373,12 +2383,12 @@ exports.manifest = {
|
|
|
2373
2383
|
{
|
|
2374
2384
|
name: 'ItemFormAdditionalProperties',
|
|
2375
2385
|
comment: {
|
|
2376
|
-
|
|
2386
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
2377
2387
|
},
|
|
2378
2388
|
items: {
|
|
2379
2389
|
locale: {
|
|
2380
2390
|
comment: {
|
|
2381
|
-
|
|
2391
|
+
markdownText: 'The currently active locale for the record.',
|
|
2382
2392
|
},
|
|
2383
2393
|
location: {
|
|
2384
2394
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2388,7 +2398,7 @@ exports.manifest = {
|
|
|
2388
2398
|
},
|
|
2389
2399
|
item: {
|
|
2390
2400
|
comment: {
|
|
2391
|
-
|
|
2401
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
2392
2402
|
},
|
|
2393
2403
|
location: {
|
|
2394
2404
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2398,7 +2408,7 @@ exports.manifest = {
|
|
|
2398
2408
|
},
|
|
2399
2409
|
itemType: {
|
|
2400
2410
|
comment: {
|
|
2401
|
-
|
|
2411
|
+
markdownText: 'The model for the record being edited.',
|
|
2402
2412
|
},
|
|
2403
2413
|
location: {
|
|
2404
2414
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2408,7 +2418,7 @@ exports.manifest = {
|
|
|
2408
2418
|
},
|
|
2409
2419
|
formValues: {
|
|
2410
2420
|
comment: {
|
|
2411
|
-
|
|
2421
|
+
markdownText: 'The complete internal form state.',
|
|
2412
2422
|
},
|
|
2413
2423
|
location: {
|
|
2414
2424
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2418,7 +2428,7 @@ exports.manifest = {
|
|
|
2418
2428
|
},
|
|
2419
2429
|
itemStatus: {
|
|
2420
2430
|
comment: {
|
|
2421
|
-
|
|
2431
|
+
markdownText: 'The current status of the record being edited.',
|
|
2422
2432
|
},
|
|
2423
2433
|
location: {
|
|
2424
2434
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2428,7 +2438,7 @@ exports.manifest = {
|
|
|
2428
2438
|
},
|
|
2429
2439
|
isSubmitting: {
|
|
2430
2440
|
comment: {
|
|
2431
|
-
|
|
2441
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
2432
2442
|
},
|
|
2433
2443
|
location: {
|
|
2434
2444
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2438,7 +2448,7 @@ exports.manifest = {
|
|
|
2438
2448
|
},
|
|
2439
2449
|
isFormDirty: {
|
|
2440
2450
|
comment: {
|
|
2441
|
-
|
|
2451
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
2442
2452
|
},
|
|
2443
2453
|
location: {
|
|
2444
2454
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2448,7 +2458,7 @@ exports.manifest = {
|
|
|
2448
2458
|
},
|
|
2449
2459
|
blocksAnalysis: {
|
|
2450
2460
|
comment: {
|
|
2451
|
-
|
|
2461
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
2452
2462
|
},
|
|
2453
2463
|
location: {
|
|
2454
2464
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2461,12 +2471,12 @@ exports.manifest = {
|
|
|
2461
2471
|
{
|
|
2462
2472
|
name: 'FieldAdditionalProperties',
|
|
2463
2473
|
comment: {
|
|
2464
|
-
|
|
2474
|
+
markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
|
|
2465
2475
|
},
|
|
2466
2476
|
items: {
|
|
2467
2477
|
disabled: {
|
|
2468
2478
|
comment: {
|
|
2469
|
-
|
|
2479
|
+
markdownText: 'Whether the field is currently disabled or not.',
|
|
2470
2480
|
},
|
|
2471
2481
|
location: {
|
|
2472
2482
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2476,7 +2486,7 @@ exports.manifest = {
|
|
|
2476
2486
|
},
|
|
2477
2487
|
fieldPath: {
|
|
2478
2488
|
comment: {
|
|
2479
|
-
|
|
2489
|
+
markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
|
|
2480
2490
|
},
|
|
2481
2491
|
location: {
|
|
2482
2492
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2486,7 +2496,7 @@ exports.manifest = {
|
|
|
2486
2496
|
},
|
|
2487
2497
|
field: {
|
|
2488
2498
|
comment: {
|
|
2489
|
-
|
|
2499
|
+
markdownText: 'The field where the field extension is installed to.',
|
|
2490
2500
|
},
|
|
2491
2501
|
location: {
|
|
2492
2502
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2496,7 +2506,7 @@ exports.manifest = {
|
|
|
2496
2506
|
},
|
|
2497
2507
|
parentField: {
|
|
2498
2508
|
comment: {
|
|
2499
|
-
|
|
2509
|
+
markdownText: 'If the field extension is installed in a field of a block, returns the top\nlevel Modular Content/Structured Text field containing the block itself.',
|
|
2500
2510
|
},
|
|
2501
2511
|
location: {
|
|
2502
2512
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2506,7 +2516,7 @@ exports.manifest = {
|
|
|
2506
2516
|
},
|
|
2507
2517
|
block: {
|
|
2508
2518
|
comment: {
|
|
2509
|
-
|
|
2519
|
+
markdownText: 'If the field extension is installed in a field of a block, returns the ID\nof the block — or `undefined` if the block is still not persisted — and the\nblock model.',
|
|
2510
2520
|
},
|
|
2511
2521
|
location: {
|
|
2512
2522
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2532,12 +2542,12 @@ exports.manifest = {
|
|
|
2532
2542
|
{
|
|
2533
2543
|
name: 'ItemFormAdditionalMethods',
|
|
2534
2544
|
comment: {
|
|
2535
|
-
|
|
2545
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
2536
2546
|
},
|
|
2537
2547
|
items: {
|
|
2538
2548
|
toggleField: {
|
|
2539
2549
|
comment: {
|
|
2540
|
-
|
|
2550
|
+
markdownText: 'Hides/shows a specific field in the form. Please be aware that when a field\nis hidden, the field editor for that field will be removed from the DOM\nitself, including any associated plugins. When it is shown again, its\nplugins will be reinitialized.',
|
|
2541
2551
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.toggleField(fieldPath, true);",
|
|
2542
2552
|
},
|
|
2543
2553
|
location: {
|
|
@@ -2548,7 +2558,7 @@ exports.manifest = {
|
|
|
2548
2558
|
},
|
|
2549
2559
|
disableField: {
|
|
2550
2560
|
comment: {
|
|
2551
|
-
|
|
2561
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
2552
2562
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.disableField(fieldPath, true);",
|
|
2553
2563
|
},
|
|
2554
2564
|
location: {
|
|
@@ -2559,7 +2569,7 @@ exports.manifest = {
|
|
|
2559
2569
|
},
|
|
2560
2570
|
scrollToField: {
|
|
2561
2571
|
comment: {
|
|
2562
|
-
|
|
2572
|
+
markdownText: 'Smoothly navigates to a specific field in the form. If the field is\nlocalized it will switch language tab and then navigate to the chosen\nfield.',
|
|
2563
2573
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.scrollToField(fieldPath);",
|
|
2564
2574
|
},
|
|
2565
2575
|
location: {
|
|
@@ -2570,7 +2580,7 @@ exports.manifest = {
|
|
|
2570
2580
|
},
|
|
2571
2581
|
setFieldValue: {
|
|
2572
2582
|
comment: {
|
|
2573
|
-
|
|
2583
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
2574
2584
|
example: "const fieldPath = prompt(\n 'Please insert the path of a field in the form',\n ctx.fieldPath,\n);\n\nawait ctx.setFieldValue(fieldPath, 'new value');",
|
|
2575
2585
|
},
|
|
2576
2586
|
location: {
|
|
@@ -2581,7 +2591,7 @@ exports.manifest = {
|
|
|
2581
2591
|
},
|
|
2582
2592
|
formValuesToItem: {
|
|
2583
2593
|
comment: {
|
|
2584
|
-
|
|
2594
|
+
markdownText: 'Takes the internal form state, and transforms it into an Item entity\ncompatible with DatoCMS API.\n\nWhen `skipUnchangedFields`, only the fields that changed value will be\nserialized.\n\nIf the required nested blocks are still not loaded, this method will return\n`undefined`.',
|
|
2585
2595
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
2586
2596
|
},
|
|
2587
2597
|
location: {
|
|
@@ -2592,7 +2602,7 @@ exports.manifest = {
|
|
|
2592
2602
|
},
|
|
2593
2603
|
itemToFormValues: {
|
|
2594
2604
|
comment: {
|
|
2595
|
-
|
|
2605
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
2596
2606
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
2597
2607
|
},
|
|
2598
2608
|
location: {
|
|
@@ -2603,7 +2613,7 @@ exports.manifest = {
|
|
|
2603
2613
|
},
|
|
2604
2614
|
saveCurrentItem: {
|
|
2605
2615
|
comment: {
|
|
2606
|
-
|
|
2616
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
2607
2617
|
example: 'await ctx.saveCurrentItem();',
|
|
2608
2618
|
},
|
|
2609
2619
|
location: {
|
|
@@ -2625,7 +2635,7 @@ exports.manifest = {
|
|
|
2625
2635
|
customMarksForStructuredTextField: {
|
|
2626
2636
|
name: 'customMarksForStructuredTextField',
|
|
2627
2637
|
comment: {
|
|
2628
|
-
|
|
2638
|
+
markdownText: 'Use this function to define a number of custom marks for a specific\nStructured Text field.',
|
|
2629
2639
|
tag: 'structuredText',
|
|
2630
2640
|
},
|
|
2631
2641
|
nonCtxArguments: [
|
|
@@ -2660,7 +2670,7 @@ exports.manifest = {
|
|
|
2660
2670
|
customBlockStylesForStructuredTextField: {
|
|
2661
2671
|
name: 'customBlockStylesForStructuredTextField',
|
|
2662
2672
|
comment: {
|
|
2663
|
-
|
|
2673
|
+
markdownText: 'Use this function to define a number of custom block styles for a specific\nStructured Text field.',
|
|
2664
2674
|
tag: 'structuredText',
|
|
2665
2675
|
},
|
|
2666
2676
|
nonCtxArguments: [
|
|
@@ -2695,7 +2705,7 @@ exports.manifest = {
|
|
|
2695
2705
|
contentAreaSidebarItems: {
|
|
2696
2706
|
name: 'contentAreaSidebarItems',
|
|
2697
2707
|
comment: {
|
|
2698
|
-
|
|
2708
|
+
markdownText: 'Use this function to declare new items in the content area sidebar.',
|
|
2699
2709
|
tag: 'sidebarItems',
|
|
2700
2710
|
},
|
|
2701
2711
|
nonCtxArguments: [],
|
|
@@ -2713,7 +2723,7 @@ exports.manifest = {
|
|
|
2713
2723
|
buildItemPresentationInfo: {
|
|
2714
2724
|
name: 'buildItemPresentationInfo',
|
|
2715
2725
|
comment: {
|
|
2716
|
-
|
|
2726
|
+
markdownText: 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field.',
|
|
2717
2727
|
tag: 'presentation',
|
|
2718
2728
|
},
|
|
2719
2729
|
nonCtxArguments: [
|
|
@@ -2736,7 +2746,7 @@ exports.manifest = {
|
|
|
2736
2746
|
assetSources: {
|
|
2737
2747
|
name: 'assetSources',
|
|
2738
2748
|
comment: {
|
|
2739
|
-
|
|
2749
|
+
markdownText: 'Use this function to declare additional sources to be shown when users want\nto upload new assets.',
|
|
2740
2750
|
tag: 'assetSources',
|
|
2741
2751
|
},
|
|
2742
2752
|
nonCtxArguments: [],
|
|
@@ -2757,12 +2767,12 @@ exports.manifest = {
|
|
|
2757
2767
|
{
|
|
2758
2768
|
name: 'PluginProperties',
|
|
2759
2769
|
comment: {
|
|
2760
|
-
|
|
2770
|
+
markdownText: "Information about the current plugin. Useful to access the plugin's global\nconfiguration object.",
|
|
2761
2771
|
},
|
|
2762
2772
|
items: {
|
|
2763
2773
|
plugin: {
|
|
2764
2774
|
comment: {
|
|
2765
|
-
|
|
2775
|
+
markdownText: 'The current plugin.',
|
|
2766
2776
|
},
|
|
2767
2777
|
location: {
|
|
2768
2778
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2775,12 +2785,12 @@ exports.manifest = {
|
|
|
2775
2785
|
{
|
|
2776
2786
|
name: 'AuthenticationProperties',
|
|
2777
2787
|
comment: {
|
|
2778
|
-
|
|
2788
|
+
markdownText: 'Information about the current user using the CMS.',
|
|
2779
2789
|
},
|
|
2780
2790
|
items: {
|
|
2781
2791
|
currentUser: {
|
|
2782
2792
|
comment: {
|
|
2783
|
-
|
|
2793
|
+
markdownText: 'The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO).',
|
|
2784
2794
|
},
|
|
2785
2795
|
location: {
|
|
2786
2796
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2790,7 +2800,7 @@ exports.manifest = {
|
|
|
2790
2800
|
},
|
|
2791
2801
|
currentRole: {
|
|
2792
2802
|
comment: {
|
|
2793
|
-
|
|
2803
|
+
markdownText: 'The role for the current DatoCMS user.',
|
|
2794
2804
|
},
|
|
2795
2805
|
location: {
|
|
2796
2806
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2800,7 +2810,7 @@ exports.manifest = {
|
|
|
2800
2810
|
},
|
|
2801
2811
|
currentUserAccessToken: {
|
|
2802
2812
|
comment: {
|
|
2803
|
-
|
|
2813
|
+
markdownText: 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted.',
|
|
2804
2814
|
},
|
|
2805
2815
|
location: {
|
|
2806
2816
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2815,7 +2825,7 @@ exports.manifest = {
|
|
|
2815
2825
|
items: {
|
|
2816
2826
|
site: {
|
|
2817
2827
|
comment: {
|
|
2818
|
-
|
|
2828
|
+
markdownText: 'The current DatoCMS project.',
|
|
2819
2829
|
},
|
|
2820
2830
|
location: {
|
|
2821
2831
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2825,7 +2835,7 @@ exports.manifest = {
|
|
|
2825
2835
|
},
|
|
2826
2836
|
environment: {
|
|
2827
2837
|
comment: {
|
|
2828
|
-
|
|
2838
|
+
markdownText: 'The ID of the current environment.',
|
|
2829
2839
|
},
|
|
2830
2840
|
location: {
|
|
2831
2841
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2835,7 +2845,7 @@ exports.manifest = {
|
|
|
2835
2845
|
},
|
|
2836
2846
|
owner: {
|
|
2837
2847
|
comment: {
|
|
2838
|
-
|
|
2848
|
+
markdownText: 'The account/organization that is the project owner.',
|
|
2839
2849
|
},
|
|
2840
2850
|
location: {
|
|
2841
2851
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2845,7 +2855,8 @@ exports.manifest = {
|
|
|
2845
2855
|
},
|
|
2846
2856
|
account: {
|
|
2847
2857
|
comment: {
|
|
2848
|
-
|
|
2858
|
+
markdownText: 'The account that is the project owner.',
|
|
2859
|
+
deprecatedMarkdownText: 'Please use `.owner` instead, as the project owner can also be\nan organization',
|
|
2849
2860
|
},
|
|
2850
2861
|
location: {
|
|
2851
2862
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2855,7 +2866,7 @@ exports.manifest = {
|
|
|
2855
2866
|
},
|
|
2856
2867
|
ui: {
|
|
2857
2868
|
comment: {
|
|
2858
|
-
|
|
2869
|
+
markdownText: 'UI preferences of the current user (right now, only the preferred locale is\navailable).',
|
|
2859
2870
|
},
|
|
2860
2871
|
location: {
|
|
2861
2872
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2865,7 +2876,7 @@ exports.manifest = {
|
|
|
2865
2876
|
},
|
|
2866
2877
|
theme: {
|
|
2867
2878
|
comment: {
|
|
2868
|
-
|
|
2879
|
+
markdownText: 'An object containing the theme colors for the current DatoCMS project.',
|
|
2869
2880
|
},
|
|
2870
2881
|
location: {
|
|
2871
2882
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2878,12 +2889,12 @@ exports.manifest = {
|
|
|
2878
2889
|
{
|
|
2879
2890
|
name: 'EntityReposProperties',
|
|
2880
2891
|
comment: {
|
|
2881
|
-
|
|
2892
|
+
markdownText: 'These properties provide access to "entity repos", that is, the collection of\nresources of a particular type that have been loaded by the CMS up to this\nmoment. The entity repos are objects, indexed by the ID of the entity itself.',
|
|
2882
2893
|
},
|
|
2883
2894
|
items: {
|
|
2884
2895
|
itemTypes: {
|
|
2885
2896
|
comment: {
|
|
2886
|
-
|
|
2897
|
+
markdownText: 'All the models of the current DatoCMS project, indexed by ID.',
|
|
2887
2898
|
},
|
|
2888
2899
|
location: {
|
|
2889
2900
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2893,7 +2904,7 @@ exports.manifest = {
|
|
|
2893
2904
|
},
|
|
2894
2905
|
fields: {
|
|
2895
2906
|
comment: {
|
|
2896
|
-
|
|
2907
|
+
markdownText: 'All the fields currently loaded for the current DatoCMS project, indexed by\nID. If some fields you need are not present, use the `loadItemTypeFields`\nfunction to load them.',
|
|
2897
2908
|
},
|
|
2898
2909
|
location: {
|
|
2899
2910
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2903,7 +2914,7 @@ exports.manifest = {
|
|
|
2903
2914
|
},
|
|
2904
2915
|
fieldsets: {
|
|
2905
2916
|
comment: {
|
|
2906
|
-
|
|
2917
|
+
markdownText: 'All the fieldsets currently loaded for the current DatoCMS project, indexed\nby ID. If some fields you need are not present, use the\n`loadItemTypeFieldsets` function to load them.',
|
|
2907
2918
|
},
|
|
2908
2919
|
location: {
|
|
2909
2920
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2913,7 +2924,7 @@ exports.manifest = {
|
|
|
2913
2924
|
},
|
|
2914
2925
|
users: {
|
|
2915
2926
|
comment: {
|
|
2916
|
-
|
|
2927
|
+
markdownText: 'All the regular users currently loaded for the current DatoCMS project,\nindexed by ID. It will always contain the current user. If some users you\nneed are not present, use the `loadUsers` function to load them.',
|
|
2917
2928
|
},
|
|
2918
2929
|
location: {
|
|
2919
2930
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2923,7 +2934,7 @@ exports.manifest = {
|
|
|
2923
2934
|
},
|
|
2924
2935
|
ssoUsers: {
|
|
2925
2936
|
comment: {
|
|
2926
|
-
|
|
2937
|
+
markdownText: 'All the SSO users currently loaded for the current DatoCMS project, indexed\nby ID. It will always contain the current user. If some users you need are\nnot present, use the `loadSsoUsers` function to load them.',
|
|
2927
2938
|
},
|
|
2928
2939
|
location: {
|
|
2929
2940
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2938,12 +2949,12 @@ exports.manifest = {
|
|
|
2938
2949
|
{
|
|
2939
2950
|
name: 'LoadDataMethods',
|
|
2940
2951
|
comment: {
|
|
2941
|
-
|
|
2952
|
+
markdownText: 'These methods can be used to asyncronously load additional information your\nplugin needs to work.',
|
|
2942
2953
|
},
|
|
2943
2954
|
items: {
|
|
2944
2955
|
loadItemTypeFields: {
|
|
2945
2956
|
comment: {
|
|
2946
|
-
|
|
2957
|
+
markdownText: 'Loads all the fields for a specific model (or block). Fields will be\nreturned and will also be available in the the `fields` property.',
|
|
2947
2958
|
example: "const itemTypeId = prompt('Please insert a model ID:');\n\nconst fields = await ctx.loadItemTypeFields(itemTypeId);\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);",
|
|
2948
2959
|
},
|
|
2949
2960
|
location: {
|
|
@@ -2954,7 +2965,7 @@ exports.manifest = {
|
|
|
2954
2965
|
},
|
|
2955
2966
|
loadItemTypeFieldsets: {
|
|
2956
2967
|
comment: {
|
|
2957
|
-
|
|
2968
|
+
markdownText: 'Loads all the fieldsets for a specific model (or block). Fieldsets will be\nreturned and will also be available in the the `fieldsets` property.',
|
|
2958
2969
|
example: "const itemTypeId = prompt('Please insert a model ID:');\n\nconst fieldsets = await ctx.loadItemTypeFieldsets(itemTypeId);\n\nctx.notice(\n `Success! ${fieldsets\n .map((fieldset) => fieldset.attributes.title)\n .join(', ')}`,\n);",
|
|
2959
2970
|
},
|
|
2960
2971
|
location: {
|
|
@@ -2965,7 +2976,7 @@ exports.manifest = {
|
|
|
2965
2976
|
},
|
|
2966
2977
|
loadFieldsUsingPlugin: {
|
|
2967
2978
|
comment: {
|
|
2968
|
-
|
|
2979
|
+
markdownText: 'Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.',
|
|
2969
2980
|
example: "const fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);",
|
|
2970
2981
|
},
|
|
2971
2982
|
location: {
|
|
@@ -2976,7 +2987,7 @@ exports.manifest = {
|
|
|
2976
2987
|
},
|
|
2977
2988
|
loadUsers: {
|
|
2978
2989
|
comment: {
|
|
2979
|
-
|
|
2990
|
+
markdownText: 'Loads all regular users. Users will be returned and will also be available\nin the the `users` property.',
|
|
2980
2991
|
example: "const users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
|
|
2981
2992
|
},
|
|
2982
2993
|
location: {
|
|
@@ -2987,7 +2998,7 @@ exports.manifest = {
|
|
|
2987
2998
|
},
|
|
2988
2999
|
loadSsoUsers: {
|
|
2989
3000
|
comment: {
|
|
2990
|
-
|
|
3001
|
+
markdownText: 'Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.',
|
|
2991
3002
|
example: "const users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
|
|
2992
3003
|
},
|
|
2993
3004
|
location: {
|
|
@@ -3001,12 +3012,12 @@ exports.manifest = {
|
|
|
3001
3012
|
{
|
|
3002
3013
|
name: 'UpdatePluginParametersMethods',
|
|
3003
3014
|
comment: {
|
|
3004
|
-
|
|
3015
|
+
markdownText: 'These methods can be used to update both plugin parameters and manual field\nextensions configuration.',
|
|
3005
3016
|
},
|
|
3006
3017
|
items: {
|
|
3007
3018
|
updatePluginParameters: {
|
|
3008
3019
|
comment: {
|
|
3009
|
-
|
|
3020
|
+
markdownText: 'Updates the plugin parameters.\n\nAlways check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.',
|
|
3010
3021
|
example: "await ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');",
|
|
3011
3022
|
},
|
|
3012
3023
|
location: {
|
|
@@ -3017,7 +3028,7 @@ exports.manifest = {
|
|
|
3017
3028
|
},
|
|
3018
3029
|
updateFieldAppearance: {
|
|
3019
3030
|
comment: {
|
|
3020
|
-
|
|
3031
|
+
markdownText: 'Performs changes in the appearance of a field. You can install/remove a\nmanual field extension, or tweak their parameters. If multiple changes are\npassed, they will be applied sequencially.\n\nAlways check `ctx.currentRole.meta.final_permissions.can_edit_schema`\nbefore calling this, as the user might not have the permission to perform\nthe operation.',
|
|
3021
3032
|
example: "const fields = await ctx.loadFieldsUsingPlugin();\n\nif (fields.length === 0) {\n ctx.alert('No field is using this plugin as a manual extension!');\n return;\n}\n\nfor (const field of fields) {\n const { appearance } = field.attributes;\n const operations = [];\n\n if (appearance.editor === ctx.plugin.id) {\n operations.push({\n operation: 'updateEditor',\n newParameters: {\n ...appearance.parameters,\n foo: 'bar',\n },\n });\n }\n\n appearance.addons.forEach((addon, i) => {\n if (addon.id !== ctx.plugin.id) {\n return;\n }\n\n operations.push({\n operation: 'updateAddon',\n index: i,\n newParameters: { ...addon.parameters, foo: 'bar' },\n });\n });\n\n await ctx.updateFieldAppearance(field.id, operations);\n ctx.notice(`Successfully edited field ${field.attributes.api_key}`);\n}",
|
|
3022
3033
|
},
|
|
3023
3034
|
location: {
|
|
@@ -3031,12 +3042,12 @@ exports.manifest = {
|
|
|
3031
3042
|
{
|
|
3032
3043
|
name: 'ToastMethods',
|
|
3033
3044
|
comment: {
|
|
3034
|
-
|
|
3045
|
+
markdownText: 'These methods can be used to show UI-consistent toast notifications to the\nend-user.',
|
|
3035
3046
|
},
|
|
3036
3047
|
items: {
|
|
3037
3048
|
alert: {
|
|
3038
3049
|
comment: {
|
|
3039
|
-
|
|
3050
|
+
markdownText: 'Triggers an "error" toast displaying the selected message.',
|
|
3040
3051
|
example: "const message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);",
|
|
3041
3052
|
},
|
|
3042
3053
|
location: {
|
|
@@ -3047,7 +3058,7 @@ exports.manifest = {
|
|
|
3047
3058
|
},
|
|
3048
3059
|
notice: {
|
|
3049
3060
|
comment: {
|
|
3050
|
-
|
|
3061
|
+
markdownText: 'Triggers a "success" toast displaying the selected message.',
|
|
3051
3062
|
example: "const message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);",
|
|
3052
3063
|
},
|
|
3053
3064
|
location: {
|
|
@@ -3058,7 +3069,7 @@ exports.manifest = {
|
|
|
3058
3069
|
},
|
|
3059
3070
|
customToast: {
|
|
3060
3071
|
comment: {
|
|
3061
|
-
|
|
3072
|
+
markdownText: 'Triggers a custom toast displaying the selected message (and optionally a\nCTA).',
|
|
3062
3073
|
example: "const result = await ctx.customToast({\n type: 'warning',\n message: 'Just a sample warning notification!',\n dismissOnPageChange: true,\n dismissAfterTimeout: 5000,\n cta: {\n label: 'Execute call-to-action',\n value: 'cta',\n },\n});\n\nif (result === 'cta') {\n ctx.notice(`Clicked CTA!`);\n}",
|
|
3063
3074
|
},
|
|
3064
3075
|
location: {
|
|
@@ -3072,12 +3083,12 @@ exports.manifest = {
|
|
|
3072
3083
|
{
|
|
3073
3084
|
name: 'ItemDialogMethods',
|
|
3074
3085
|
comment: {
|
|
3075
|
-
|
|
3086
|
+
markdownText: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records.',
|
|
3076
3087
|
},
|
|
3077
3088
|
items: {
|
|
3078
3089
|
createNewItem: {
|
|
3079
3090
|
comment: {
|
|
3080
|
-
|
|
3091
|
+
markdownText: 'Opens a dialog for creating a new record. It returns a promise resolved\nwith the newly created record or `null` if the user closes the dialog\nwithout creating anything.',
|
|
3081
3092
|
example: "const itemTypeId = prompt('Please insert a model ID:');\n\nconst item = await ctx.createNewItem(itemTypeId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3082
3093
|
},
|
|
3083
3094
|
location: {
|
|
@@ -3088,7 +3099,7 @@ exports.manifest = {
|
|
|
3088
3099
|
},
|
|
3089
3100
|
selectItem: {
|
|
3090
3101
|
comment: {
|
|
3091
|
-
|
|
3102
|
+
markdownText: 'Opens a dialog for selecting one (or multiple) record(s) from a list of\nexisting records of type `itemTypeId`. It returns a promise resolved with\nthe selected record(s), or `null` if the user closes the dialog without\nchoosing any record.',
|
|
3092
3103
|
example: "const itemTypeId = prompt('Please insert a model ID:');\n\nconst items = await ctx.selectItem(itemTypeId, { multiple: true });\n\nif (items) {\n ctx.notice(`Success! ${items.map((i) => i.id).join(', ')}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3093
3104
|
},
|
|
3094
3105
|
location: {
|
|
@@ -3099,7 +3110,7 @@ exports.manifest = {
|
|
|
3099
3110
|
},
|
|
3100
3111
|
editItem: {
|
|
3101
3112
|
comment: {
|
|
3102
|
-
|
|
3113
|
+
markdownText: 'Opens a dialog for editing an existing record. It returns a promise\nresolved with the edited record, or `null` if the user closes the dialog\nwithout persisting any change.',
|
|
3103
3114
|
example: "const itemId = prompt('Please insert a record ID:');\n\nconst item = await ctx.editItem(itemId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3104
3115
|
},
|
|
3105
3116
|
location: {
|
|
@@ -3113,12 +3124,12 @@ exports.manifest = {
|
|
|
3113
3124
|
{
|
|
3114
3125
|
name: 'UploadDialogMethods',
|
|
3115
3126
|
comment: {
|
|
3116
|
-
|
|
3127
|
+
markdownText: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets.',
|
|
3117
3128
|
},
|
|
3118
3129
|
items: {
|
|
3119
3130
|
selectUpload: {
|
|
3120
3131
|
comment: {
|
|
3121
|
-
|
|
3132
|
+
markdownText: 'Opens a dialog for selecting one (or multiple) existing asset(s). It\nreturns a promise resolved with the selected asset(s), or `null` if the\nuser closes the dialog without selecting any upload.',
|
|
3122
3133
|
example: "const item = await ctx.selectUpload({ multiple: false });\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3123
3134
|
},
|
|
3124
3135
|
location: {
|
|
@@ -3129,7 +3140,7 @@ exports.manifest = {
|
|
|
3129
3140
|
},
|
|
3130
3141
|
editUpload: {
|
|
3131
3142
|
comment: {
|
|
3132
|
-
|
|
3143
|
+
markdownText: 'Opens a dialog for editing a Media Area asset. It returns a promise\nresolved with:\n\n- The updated asset, if the user persists some changes to the asset itself\n- `null`, if the user closes the dialog without persisting any change\n- An asset structure with an additional `deleted` property set to true, if\n the user deletes the asset.',
|
|
3133
3144
|
example: "const uploadId = prompt('Please insert an asset ID:');\n\nconst item = await ctx.editUpload(uploadId);\n\nif (item) {\n ctx.notice(`Success! ${item.id}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3134
3145
|
},
|
|
3135
3146
|
location: {
|
|
@@ -3140,7 +3151,7 @@ exports.manifest = {
|
|
|
3140
3151
|
},
|
|
3141
3152
|
editUploadMetadata: {
|
|
3142
3153
|
comment: {
|
|
3143
|
-
|
|
3154
|
+
markdownText: 'Opens a dialog for editing a "single asset" field structure. It returns a\npromise resolved with the updated structure, or `null` if the user closes\nthe dialog without persisting any change.',
|
|
3144
3155
|
example: "const uploadId = prompt('Please insert an asset ID:');\n\nconst result = await ctx.editUploadMetadata({\n upload_id: uploadId,\n alt: null,\n title: null,\n custom_data: {},\n focal_point: null,\n});\n\nif (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3145
3156
|
},
|
|
3146
3157
|
location: {
|
|
@@ -3154,12 +3165,12 @@ exports.manifest = {
|
|
|
3154
3165
|
{
|
|
3155
3166
|
name: 'CustomDialogMethods',
|
|
3156
3167
|
comment: {
|
|
3157
|
-
|
|
3168
|
+
markdownText: 'These methods can be used to open custom dialogs/confirmation panels.',
|
|
3158
3169
|
},
|
|
3159
3170
|
items: {
|
|
3160
3171
|
openModal: {
|
|
3161
3172
|
comment: {
|
|
3162
|
-
|
|
3173
|
+
markdownText: 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function.',
|
|
3163
3174
|
example: "const result = await ctx.openModal({\n id: 'regular',\n title: 'Custom title!',\n width: 'l',\n parameters: { foo: 'bar' },\n});\n\nif (result) {\n ctx.notice(`Success! ${JSON.stringify(result)}`);\n} else {\n ctx.alert('Closed!');\n}",
|
|
3164
3175
|
},
|
|
3165
3176
|
location: {
|
|
@@ -3170,7 +3181,7 @@ exports.manifest = {
|
|
|
3170
3181
|
},
|
|
3171
3182
|
openConfirm: {
|
|
3172
3183
|
comment: {
|
|
3173
|
-
|
|
3184
|
+
markdownText: 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user.',
|
|
3174
3185
|
example: "const result = await ctx.openConfirm({\n title: 'Custom title',\n content:\n 'Lorem Ipsum is simply dummy text of the printing and typesetting industry',\n choices: [\n {\n label: 'Positive',\n value: 'positive',\n intent: 'positive',\n },\n {\n label: 'Negative',\n value: 'negative',\n intent: 'negative',\n },\n ],\n cancel: {\n label: 'Cancel',\n value: false,\n },\n});\n\nif (result) {\n ctx.notice(`Success! ${result}`);\n} else {\n ctx.alert('Cancelled!');\n}",
|
|
3175
3186
|
},
|
|
3176
3187
|
location: {
|
|
@@ -3184,12 +3195,12 @@ exports.manifest = {
|
|
|
3184
3195
|
{
|
|
3185
3196
|
name: 'NavigateMethods',
|
|
3186
3197
|
comment: {
|
|
3187
|
-
|
|
3198
|
+
markdownText: 'These methods can be used to take the user to different pages.',
|
|
3188
3199
|
},
|
|
3189
3200
|
items: {
|
|
3190
3201
|
navigateTo: {
|
|
3191
3202
|
comment: {
|
|
3192
|
-
|
|
3203
|
+
markdownText: 'Moves the user to another URL internal to the backend.',
|
|
3193
3204
|
example: "await ctx.navigateTo('/');",
|
|
3194
3205
|
},
|
|
3195
3206
|
location: {
|
|
@@ -3205,12 +3216,12 @@ exports.manifest = {
|
|
|
3205
3216
|
selfResizingPluginFrameCtxSizingUtilities: {
|
|
3206
3217
|
name: 'SizingUtilities',
|
|
3207
3218
|
comment: {
|
|
3208
|
-
|
|
3219
|
+
markdownText: 'A number of methods that you can use to control the size of the plugin frame.',
|
|
3209
3220
|
},
|
|
3210
3221
|
items: {
|
|
3211
3222
|
startAutoResizer: {
|
|
3212
3223
|
comment: {
|
|
3213
|
-
|
|
3224
|
+
markdownText: "Listens for DOM changes and automatically calls `setHeight` when it detects\na change. If you're using `datocms-react-ui` package, the `<Canvas />`\ncomponent already takes care of calling this method for you.",
|
|
3214
3225
|
},
|
|
3215
3226
|
location: {
|
|
3216
3227
|
filePath: 'src/ctx/commonExtras/sizing.ts',
|
|
@@ -3220,7 +3231,7 @@ exports.manifest = {
|
|
|
3220
3231
|
},
|
|
3221
3232
|
stopAutoResizer: {
|
|
3222
3233
|
comment: {
|
|
3223
|
-
|
|
3234
|
+
markdownText: 'Stops resizing the iframe automatically.',
|
|
3224
3235
|
},
|
|
3225
3236
|
location: {
|
|
3226
3237
|
filePath: 'src/ctx/commonExtras/sizing.ts',
|
|
@@ -3230,7 +3241,7 @@ exports.manifest = {
|
|
|
3230
3241
|
},
|
|
3231
3242
|
updateHeight: {
|
|
3232
3243
|
comment: {
|
|
3233
|
-
|
|
3244
|
+
markdownText: "Triggers a change in the size of the iframe. If you don't explicitely pass\na `newHeight` it will be automatically calculated using the iframe content\nat the moment.",
|
|
3234
3245
|
},
|
|
3235
3246
|
location: {
|
|
3236
3247
|
filePath: 'src/ctx/commonExtras/sizing.ts',
|