datocms-plugin-sdk 2.0.2 → 2.0.3
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/manifest.js +254 -253
- package/dist/cjs/manifest.js.map +1 -1
- package/dist/esm/ctx/base.d.ts +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 +254 -253
- 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/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 +254 -253
- package/package.json +2 -2
- package/src/ctx/base.ts +1 -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 +408 -374
- 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 `itemFormOutlets()` hook.',
|
|
1068
1068
|
tag: 'outlets',
|
|
1069
1069
|
},
|
|
1070
1070
|
nonCtxArguments: [
|
|
@@ -1080,7 +1080,7 @@ 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',
|
|
@@ -1102,7 +1102,7 @@ exports.manifest = {
|
|
|
1102
1102
|
renderFieldExtension: {
|
|
1103
1103
|
name: 'renderFieldExtension',
|
|
1104
1104
|
comment: {
|
|
1105
|
-
|
|
1105
|
+
markdownText: 'This function will be called when the plugin needs to render a field\nextension (see the `manualFieldExtensions` and `overrideFieldExtensions`\nfunctions).',
|
|
1106
1106
|
tag: 'forcedFieldExtensions',
|
|
1107
1107
|
},
|
|
1108
1108
|
nonCtxArguments: [
|
|
@@ -1117,12 +1117,12 @@ exports.manifest = {
|
|
|
1117
1117
|
{
|
|
1118
1118
|
name: 'ItemFormAdditionalProperties',
|
|
1119
1119
|
comment: {
|
|
1120
|
-
|
|
1120
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
1121
1121
|
},
|
|
1122
1122
|
items: {
|
|
1123
1123
|
locale: {
|
|
1124
1124
|
comment: {
|
|
1125
|
-
|
|
1125
|
+
markdownText: 'The currently active locale for the record.',
|
|
1126
1126
|
},
|
|
1127
1127
|
location: {
|
|
1128
1128
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1132,7 +1132,7 @@ exports.manifest = {
|
|
|
1132
1132
|
},
|
|
1133
1133
|
item: {
|
|
1134
1134
|
comment: {
|
|
1135
|
-
|
|
1135
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
1136
1136
|
},
|
|
1137
1137
|
location: {
|
|
1138
1138
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1142,7 +1142,7 @@ exports.manifest = {
|
|
|
1142
1142
|
},
|
|
1143
1143
|
itemType: {
|
|
1144
1144
|
comment: {
|
|
1145
|
-
|
|
1145
|
+
markdownText: 'The model for the record being edited.',
|
|
1146
1146
|
},
|
|
1147
1147
|
location: {
|
|
1148
1148
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1152,7 +1152,7 @@ exports.manifest = {
|
|
|
1152
1152
|
},
|
|
1153
1153
|
formValues: {
|
|
1154
1154
|
comment: {
|
|
1155
|
-
|
|
1155
|
+
markdownText: 'The complete internal form state.',
|
|
1156
1156
|
},
|
|
1157
1157
|
location: {
|
|
1158
1158
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1162,7 +1162,7 @@ exports.manifest = {
|
|
|
1162
1162
|
},
|
|
1163
1163
|
itemStatus: {
|
|
1164
1164
|
comment: {
|
|
1165
|
-
|
|
1165
|
+
markdownText: 'The current status of the record being edited.',
|
|
1166
1166
|
},
|
|
1167
1167
|
location: {
|
|
1168
1168
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1172,7 +1172,7 @@ exports.manifest = {
|
|
|
1172
1172
|
},
|
|
1173
1173
|
isSubmitting: {
|
|
1174
1174
|
comment: {
|
|
1175
|
-
|
|
1175
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
1176
1176
|
},
|
|
1177
1177
|
location: {
|
|
1178
1178
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1182,7 +1182,7 @@ exports.manifest = {
|
|
|
1182
1182
|
},
|
|
1183
1183
|
isFormDirty: {
|
|
1184
1184
|
comment: {
|
|
1185
|
-
|
|
1185
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
1186
1186
|
},
|
|
1187
1187
|
location: {
|
|
1188
1188
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1192,7 +1192,7 @@ exports.manifest = {
|
|
|
1192
1192
|
},
|
|
1193
1193
|
blocksAnalysis: {
|
|
1194
1194
|
comment: {
|
|
1195
|
-
|
|
1195
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
1196
1196
|
},
|
|
1197
1197
|
location: {
|
|
1198
1198
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1205,12 +1205,12 @@ exports.manifest = {
|
|
|
1205
1205
|
{
|
|
1206
1206
|
name: 'FieldAdditionalProperties',
|
|
1207
1207
|
comment: {
|
|
1208
|
-
|
|
1208
|
+
markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
|
|
1209
1209
|
},
|
|
1210
1210
|
items: {
|
|
1211
1211
|
disabled: {
|
|
1212
1212
|
comment: {
|
|
1213
|
-
|
|
1213
|
+
markdownText: 'Whether the field is currently disabled or not.',
|
|
1214
1214
|
},
|
|
1215
1215
|
location: {
|
|
1216
1216
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1220,7 +1220,7 @@ exports.manifest = {
|
|
|
1220
1220
|
},
|
|
1221
1221
|
fieldPath: {
|
|
1222
1222
|
comment: {
|
|
1223
|
-
|
|
1223
|
+
markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
|
|
1224
1224
|
},
|
|
1225
1225
|
location: {
|
|
1226
1226
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1230,7 +1230,7 @@ exports.manifest = {
|
|
|
1230
1230
|
},
|
|
1231
1231
|
field: {
|
|
1232
1232
|
comment: {
|
|
1233
|
-
|
|
1233
|
+
markdownText: 'The field where the field extension is installed to.',
|
|
1234
1234
|
},
|
|
1235
1235
|
location: {
|
|
1236
1236
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1240,7 +1240,7 @@ exports.manifest = {
|
|
|
1240
1240
|
},
|
|
1241
1241
|
parentField: {
|
|
1242
1242
|
comment: {
|
|
1243
|
-
|
|
1243
|
+
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
1244
|
},
|
|
1245
1245
|
location: {
|
|
1246
1246
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1250,7 +1250,7 @@ exports.manifest = {
|
|
|
1250
1250
|
},
|
|
1251
1251
|
block: {
|
|
1252
1252
|
comment: {
|
|
1253
|
-
|
|
1253
|
+
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
1254
|
},
|
|
1255
1255
|
location: {
|
|
1256
1256
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -1264,7 +1264,7 @@ exports.manifest = {
|
|
|
1264
1264
|
items: {
|
|
1265
1265
|
fieldExtensionId: {
|
|
1266
1266
|
comment: {
|
|
1267
|
-
|
|
1267
|
+
markdownText: 'The ID of the field extension that needs to be rendered.',
|
|
1268
1268
|
},
|
|
1269
1269
|
location: {
|
|
1270
1270
|
filePath: 'src/hooks/renderFieldExtension.ts',
|
|
@@ -1274,7 +1274,7 @@ exports.manifest = {
|
|
|
1274
1274
|
},
|
|
1275
1275
|
parameters: {
|
|
1276
1276
|
comment: {
|
|
1277
|
-
|
|
1277
|
+
markdownText: 'The arbitrary `parameters` of the field extension.',
|
|
1278
1278
|
},
|
|
1279
1279
|
location: {
|
|
1280
1280
|
filePath: 'src/hooks/renderFieldExtension.ts',
|
|
@@ -1289,12 +1289,12 @@ exports.manifest = {
|
|
|
1289
1289
|
{
|
|
1290
1290
|
name: 'ItemFormAdditionalMethods',
|
|
1291
1291
|
comment: {
|
|
1292
|
-
|
|
1292
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
1293
1293
|
},
|
|
1294
1294
|
items: {
|
|
1295
1295
|
toggleField: {
|
|
1296
1296
|
comment: {
|
|
1297
|
-
|
|
1297
|
+
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
1298
|
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
1299
|
},
|
|
1300
1300
|
location: {
|
|
@@ -1305,7 +1305,7 @@ exports.manifest = {
|
|
|
1305
1305
|
},
|
|
1306
1306
|
disableField: {
|
|
1307
1307
|
comment: {
|
|
1308
|
-
|
|
1308
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
1309
1309
|
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
1310
|
},
|
|
1311
1311
|
location: {
|
|
@@ -1316,7 +1316,7 @@ exports.manifest = {
|
|
|
1316
1316
|
},
|
|
1317
1317
|
scrollToField: {
|
|
1318
1318
|
comment: {
|
|
1319
|
-
|
|
1319
|
+
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
1320
|
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
1321
|
},
|
|
1322
1322
|
location: {
|
|
@@ -1327,7 +1327,7 @@ exports.manifest = {
|
|
|
1327
1327
|
},
|
|
1328
1328
|
setFieldValue: {
|
|
1329
1329
|
comment: {
|
|
1330
|
-
|
|
1330
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
1331
1331
|
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
1332
|
},
|
|
1333
1333
|
location: {
|
|
@@ -1338,7 +1338,7 @@ exports.manifest = {
|
|
|
1338
1338
|
},
|
|
1339
1339
|
formValuesToItem: {
|
|
1340
1340
|
comment: {
|
|
1341
|
-
|
|
1341
|
+
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
1342
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
1343
1343
|
},
|
|
1344
1344
|
location: {
|
|
@@ -1349,7 +1349,7 @@ exports.manifest = {
|
|
|
1349
1349
|
},
|
|
1350
1350
|
itemToFormValues: {
|
|
1351
1351
|
comment: {
|
|
1352
|
-
|
|
1352
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
1353
1353
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
1354
1354
|
},
|
|
1355
1355
|
location: {
|
|
@@ -1360,7 +1360,7 @@ exports.manifest = {
|
|
|
1360
1360
|
},
|
|
1361
1361
|
saveCurrentItem: {
|
|
1362
1362
|
comment: {
|
|
1363
|
-
|
|
1363
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
1364
1364
|
example: 'await ctx.saveCurrentItem();',
|
|
1365
1365
|
},
|
|
1366
1366
|
location: {
|
|
@@ -1382,7 +1382,7 @@ exports.manifest = {
|
|
|
1382
1382
|
renderConfigScreen: {
|
|
1383
1383
|
name: 'renderConfigScreen',
|
|
1384
1384
|
comment: {
|
|
1385
|
-
|
|
1385
|
+
markdownText: "This function will be called when the plugin needs to render the plugin's\nconfiguration form.",
|
|
1386
1386
|
tag: 'configScreen',
|
|
1387
1387
|
},
|
|
1388
1388
|
nonCtxArguments: [],
|
|
@@ -1400,7 +1400,7 @@ exports.manifest = {
|
|
|
1400
1400
|
renderAssetSource: {
|
|
1401
1401
|
name: 'renderAssetSource',
|
|
1402
1402
|
comment: {
|
|
1403
|
-
|
|
1403
|
+
markdownText: "This function will be called when the user selects one of the plugin's\nasset sources to upload a new media file.",
|
|
1404
1404
|
tag: 'assetSources',
|
|
1405
1405
|
},
|
|
1406
1406
|
nonCtxArguments: [
|
|
@@ -1416,7 +1416,7 @@ exports.manifest = {
|
|
|
1416
1416
|
items: {
|
|
1417
1417
|
assetSourceId: {
|
|
1418
1418
|
comment: {
|
|
1419
|
-
|
|
1419
|
+
markdownText: 'The ID of the assetSource that needs to be rendered.',
|
|
1420
1420
|
},
|
|
1421
1421
|
location: {
|
|
1422
1422
|
filePath: 'src/hooks/renderAssetSource.ts',
|
|
@@ -1432,7 +1432,7 @@ exports.manifest = {
|
|
|
1432
1432
|
items: {
|
|
1433
1433
|
select: {
|
|
1434
1434
|
comment: {
|
|
1435
|
-
|
|
1435
|
+
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
1436
|
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
1437
|
},
|
|
1438
1438
|
location: {
|
|
@@ -1454,7 +1454,7 @@ exports.manifest = {
|
|
|
1454
1454
|
overrideFieldExtensions: {
|
|
1455
1455
|
name: 'overrideFieldExtensions',
|
|
1456
1456
|
comment: {
|
|
1457
|
-
|
|
1457
|
+
markdownText: 'Use this function to automatically force one or more field extensions to a\nparticular field.',
|
|
1458
1458
|
tag: 'forcedFieldExtensions',
|
|
1459
1459
|
},
|
|
1460
1460
|
nonCtxArguments: [
|
|
@@ -1489,7 +1489,7 @@ exports.manifest = {
|
|
|
1489
1489
|
onBoot: {
|
|
1490
1490
|
name: 'onBoot',
|
|
1491
1491
|
comment: {
|
|
1492
|
-
|
|
1492
|
+
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
1493
|
tag: 'boot',
|
|
1494
1494
|
},
|
|
1495
1495
|
nonCtxArguments: [],
|
|
@@ -1507,7 +1507,7 @@ exports.manifest = {
|
|
|
1507
1507
|
onBeforeItemsUnpublish: {
|
|
1508
1508
|
name: 'onBeforeItemsUnpublish',
|
|
1509
1509
|
comment: {
|
|
1510
|
-
|
|
1510
|
+
markdownText: 'This function will be called before unpublishing records. You can stop the\naction by returning `false`.',
|
|
1511
1511
|
tag: 'beforeHooks',
|
|
1512
1512
|
},
|
|
1513
1513
|
nonCtxArguments: [
|
|
@@ -1530,7 +1530,7 @@ exports.manifest = {
|
|
|
1530
1530
|
onBeforeItemsPublish: {
|
|
1531
1531
|
name: 'onBeforeItemsPublish',
|
|
1532
1532
|
comment: {
|
|
1533
|
-
|
|
1533
|
+
markdownText: 'This function will be called before publishing records. You can stop the\naction by returning `false`.',
|
|
1534
1534
|
tag: 'beforeHooks',
|
|
1535
1535
|
},
|
|
1536
1536
|
nonCtxArguments: [
|
|
@@ -1553,7 +1553,7 @@ exports.manifest = {
|
|
|
1553
1553
|
onBeforeItemsDestroy: {
|
|
1554
1554
|
name: 'onBeforeItemsDestroy',
|
|
1555
1555
|
comment: {
|
|
1556
|
-
|
|
1556
|
+
markdownText: 'This function will be called before destroying records. You can stop the\naction by returning `false`.',
|
|
1557
1557
|
tag: 'beforeHooks',
|
|
1558
1558
|
},
|
|
1559
1559
|
nonCtxArguments: [
|
|
@@ -1576,7 +1576,7 @@ exports.manifest = {
|
|
|
1576
1576
|
onBeforeItemUpsert: {
|
|
1577
1577
|
name: 'onBeforeItemUpsert',
|
|
1578
1578
|
comment: {
|
|
1579
|
-
|
|
1579
|
+
markdownText: 'This function will be called before saving a new version of a record. You\ncan stop the action by returning `false`.',
|
|
1580
1580
|
tag: 'beforeHooks',
|
|
1581
1581
|
},
|
|
1582
1582
|
nonCtxArguments: [
|
|
@@ -1599,7 +1599,7 @@ exports.manifest = {
|
|
|
1599
1599
|
manualFieldExtensions: {
|
|
1600
1600
|
name: 'manualFieldExtensions',
|
|
1601
1601
|
comment: {
|
|
1602
|
-
|
|
1602
|
+
markdownText: 'Use this function to declare new field extensions that users will be able\nto install manually in some field.',
|
|
1603
1603
|
tag: 'manualFieldExtensions',
|
|
1604
1604
|
},
|
|
1605
1605
|
nonCtxArguments: [],
|
|
@@ -1617,7 +1617,7 @@ exports.manifest = {
|
|
|
1617
1617
|
mainNavigationTabs: {
|
|
1618
1618
|
name: 'mainNavigationTabs',
|
|
1619
1619
|
comment: {
|
|
1620
|
-
|
|
1620
|
+
markdownText: 'Use this function to declare new tabs you want to add in the top-bar of the\nUI.',
|
|
1621
1621
|
tag: 'pages',
|
|
1622
1622
|
},
|
|
1623
1623
|
nonCtxArguments: [],
|
|
@@ -1635,7 +1635,7 @@ exports.manifest = {
|
|
|
1635
1635
|
itemsDropdownActions: {
|
|
1636
1636
|
name: 'itemsDropdownActions',
|
|
1637
1637
|
comment: {
|
|
1638
|
-
|
|
1638
|
+
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
1639
|
tag: 'dropdownActions',
|
|
1640
1640
|
},
|
|
1641
1641
|
nonCtxArguments: [
|
|
@@ -1670,7 +1670,7 @@ exports.manifest = {
|
|
|
1670
1670
|
itemFormSidebars: {
|
|
1671
1671
|
name: 'itemFormSidebars',
|
|
1672
1672
|
comment: {
|
|
1673
|
-
|
|
1673
|
+
markdownText: 'Use this function to declare new sidebar to be shown when the user edits\nrecords of a particular model.',
|
|
1674
1674
|
tag: 'sidebarPanels',
|
|
1675
1675
|
},
|
|
1676
1676
|
nonCtxArguments: [
|
|
@@ -1693,7 +1693,7 @@ exports.manifest = {
|
|
|
1693
1693
|
itemFormSidebarPanels: {
|
|
1694
1694
|
name: 'itemFormSidebarPanels',
|
|
1695
1695
|
comment: {
|
|
1696
|
-
|
|
1696
|
+
markdownText: 'Use this function to declare new sidebar panels to be shown when the user\nedits records of a particular model.',
|
|
1697
1697
|
tag: 'sidebarPanels',
|
|
1698
1698
|
},
|
|
1699
1699
|
nonCtxArguments: [
|
|
@@ -1716,7 +1716,7 @@ exports.manifest = {
|
|
|
1716
1716
|
itemFormOutlets: {
|
|
1717
1717
|
name: 'itemFormOutlets',
|
|
1718
1718
|
comment: {
|
|
1719
|
-
|
|
1719
|
+
markdownText: "Use this function to declare custom outlets to be shown at the top of the\nrecord's editing page.",
|
|
1720
1720
|
tag: 'outlets',
|
|
1721
1721
|
},
|
|
1722
1722
|
nonCtxArguments: [
|
|
@@ -1739,7 +1739,7 @@ exports.manifest = {
|
|
|
1739
1739
|
itemFormDropdownActions: {
|
|
1740
1740
|
name: 'itemFormDropdownActions',
|
|
1741
1741
|
comment: {
|
|
1742
|
-
|
|
1742
|
+
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
1743
|
tag: 'dropdownActions',
|
|
1744
1744
|
},
|
|
1745
1745
|
nonCtxArguments: [
|
|
@@ -1754,12 +1754,12 @@ exports.manifest = {
|
|
|
1754
1754
|
{
|
|
1755
1755
|
name: 'ItemFormAdditionalProperties',
|
|
1756
1756
|
comment: {
|
|
1757
|
-
|
|
1757
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
1758
1758
|
},
|
|
1759
1759
|
items: {
|
|
1760
1760
|
locale: {
|
|
1761
1761
|
comment: {
|
|
1762
|
-
|
|
1762
|
+
markdownText: 'The currently active locale for the record.',
|
|
1763
1763
|
},
|
|
1764
1764
|
location: {
|
|
1765
1765
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1769,7 +1769,7 @@ exports.manifest = {
|
|
|
1769
1769
|
},
|
|
1770
1770
|
item: {
|
|
1771
1771
|
comment: {
|
|
1772
|
-
|
|
1772
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
1773
1773
|
},
|
|
1774
1774
|
location: {
|
|
1775
1775
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1779,7 +1779,7 @@ exports.manifest = {
|
|
|
1779
1779
|
},
|
|
1780
1780
|
itemType: {
|
|
1781
1781
|
comment: {
|
|
1782
|
-
|
|
1782
|
+
markdownText: 'The model for the record being edited.',
|
|
1783
1783
|
},
|
|
1784
1784
|
location: {
|
|
1785
1785
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1789,7 +1789,7 @@ exports.manifest = {
|
|
|
1789
1789
|
},
|
|
1790
1790
|
formValues: {
|
|
1791
1791
|
comment: {
|
|
1792
|
-
|
|
1792
|
+
markdownText: 'The complete internal form state.',
|
|
1793
1793
|
},
|
|
1794
1794
|
location: {
|
|
1795
1795
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1799,7 +1799,7 @@ exports.manifest = {
|
|
|
1799
1799
|
},
|
|
1800
1800
|
itemStatus: {
|
|
1801
1801
|
comment: {
|
|
1802
|
-
|
|
1802
|
+
markdownText: 'The current status of the record being edited.',
|
|
1803
1803
|
},
|
|
1804
1804
|
location: {
|
|
1805
1805
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1809,7 +1809,7 @@ exports.manifest = {
|
|
|
1809
1809
|
},
|
|
1810
1810
|
isSubmitting: {
|
|
1811
1811
|
comment: {
|
|
1812
|
-
|
|
1812
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
1813
1813
|
},
|
|
1814
1814
|
location: {
|
|
1815
1815
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1819,7 +1819,7 @@ exports.manifest = {
|
|
|
1819
1819
|
},
|
|
1820
1820
|
isFormDirty: {
|
|
1821
1821
|
comment: {
|
|
1822
|
-
|
|
1822
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
1823
1823
|
},
|
|
1824
1824
|
location: {
|
|
1825
1825
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1829,7 +1829,7 @@ exports.manifest = {
|
|
|
1829
1829
|
},
|
|
1830
1830
|
blocksAnalysis: {
|
|
1831
1831
|
comment: {
|
|
1832
|
-
|
|
1832
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
1833
1833
|
},
|
|
1834
1834
|
location: {
|
|
1835
1835
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1851,7 +1851,7 @@ exports.manifest = {
|
|
|
1851
1851
|
itemCollectionOutlets: {
|
|
1852
1852
|
name: 'itemCollectionOutlets',
|
|
1853
1853
|
comment: {
|
|
1854
|
-
|
|
1854
|
+
markdownText: 'Use this function to declare custom outlets to be shown at the top of a\ncollection of records of a particular model.',
|
|
1855
1855
|
tag: 'outlets',
|
|
1856
1856
|
},
|
|
1857
1857
|
nonCtxArguments: [
|
|
@@ -1874,7 +1874,7 @@ exports.manifest = {
|
|
|
1874
1874
|
initialLocationQueryForItemSelector: {
|
|
1875
1875
|
name: 'initialLocationQueryForItemSelector',
|
|
1876
1876
|
comment: {
|
|
1877
|
-
|
|
1877
|
+
markdownText: 'Use this function to customize the initial filters when opening a record\nselector via a "Single link" or "Multiple links" field.',
|
|
1878
1878
|
tag: 'locationQuery',
|
|
1879
1879
|
},
|
|
1880
1880
|
nonCtxArguments: [
|
|
@@ -1901,7 +1901,7 @@ exports.manifest = {
|
|
|
1901
1901
|
fieldDropdownActions: {
|
|
1902
1902
|
name: 'fieldDropdownActions',
|
|
1903
1903
|
comment: {
|
|
1904
|
-
|
|
1904
|
+
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
1905
|
tag: 'dropdownActions',
|
|
1906
1906
|
},
|
|
1907
1907
|
nonCtxArguments: [
|
|
@@ -1916,12 +1916,12 @@ exports.manifest = {
|
|
|
1916
1916
|
{
|
|
1917
1917
|
name: 'ItemFormAdditionalProperties',
|
|
1918
1918
|
comment: {
|
|
1919
|
-
|
|
1919
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
1920
1920
|
},
|
|
1921
1921
|
items: {
|
|
1922
1922
|
locale: {
|
|
1923
1923
|
comment: {
|
|
1924
|
-
|
|
1924
|
+
markdownText: 'The currently active locale for the record.',
|
|
1925
1925
|
},
|
|
1926
1926
|
location: {
|
|
1927
1927
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1931,7 +1931,7 @@ exports.manifest = {
|
|
|
1931
1931
|
},
|
|
1932
1932
|
item: {
|
|
1933
1933
|
comment: {
|
|
1934
|
-
|
|
1934
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
1935
1935
|
},
|
|
1936
1936
|
location: {
|
|
1937
1937
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1941,7 +1941,7 @@ exports.manifest = {
|
|
|
1941
1941
|
},
|
|
1942
1942
|
itemType: {
|
|
1943
1943
|
comment: {
|
|
1944
|
-
|
|
1944
|
+
markdownText: 'The model for the record being edited.',
|
|
1945
1945
|
},
|
|
1946
1946
|
location: {
|
|
1947
1947
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1951,7 +1951,7 @@ exports.manifest = {
|
|
|
1951
1951
|
},
|
|
1952
1952
|
formValues: {
|
|
1953
1953
|
comment: {
|
|
1954
|
-
|
|
1954
|
+
markdownText: 'The complete internal form state.',
|
|
1955
1955
|
},
|
|
1956
1956
|
location: {
|
|
1957
1957
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1961,7 +1961,7 @@ exports.manifest = {
|
|
|
1961
1961
|
},
|
|
1962
1962
|
itemStatus: {
|
|
1963
1963
|
comment: {
|
|
1964
|
-
|
|
1964
|
+
markdownText: 'The current status of the record being edited.',
|
|
1965
1965
|
},
|
|
1966
1966
|
location: {
|
|
1967
1967
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1971,7 +1971,7 @@ exports.manifest = {
|
|
|
1971
1971
|
},
|
|
1972
1972
|
isSubmitting: {
|
|
1973
1973
|
comment: {
|
|
1974
|
-
|
|
1974
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
1975
1975
|
},
|
|
1976
1976
|
location: {
|
|
1977
1977
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1981,7 +1981,7 @@ exports.manifest = {
|
|
|
1981
1981
|
},
|
|
1982
1982
|
isFormDirty: {
|
|
1983
1983
|
comment: {
|
|
1984
|
-
|
|
1984
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
1985
1985
|
},
|
|
1986
1986
|
location: {
|
|
1987
1987
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -1991,7 +1991,7 @@ exports.manifest = {
|
|
|
1991
1991
|
},
|
|
1992
1992
|
blocksAnalysis: {
|
|
1993
1993
|
comment: {
|
|
1994
|
-
|
|
1994
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
1995
1995
|
},
|
|
1996
1996
|
location: {
|
|
1997
1997
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2004,12 +2004,12 @@ exports.manifest = {
|
|
|
2004
2004
|
{
|
|
2005
2005
|
name: 'FieldAdditionalProperties',
|
|
2006
2006
|
comment: {
|
|
2007
|
-
|
|
2007
|
+
markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
|
|
2008
2008
|
},
|
|
2009
2009
|
items: {
|
|
2010
2010
|
disabled: {
|
|
2011
2011
|
comment: {
|
|
2012
|
-
|
|
2012
|
+
markdownText: 'Whether the field is currently disabled or not.',
|
|
2013
2013
|
},
|
|
2014
2014
|
location: {
|
|
2015
2015
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2019,7 +2019,7 @@ exports.manifest = {
|
|
|
2019
2019
|
},
|
|
2020
2020
|
fieldPath: {
|
|
2021
2021
|
comment: {
|
|
2022
|
-
|
|
2022
|
+
markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
|
|
2023
2023
|
},
|
|
2024
2024
|
location: {
|
|
2025
2025
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2029,7 +2029,7 @@ exports.manifest = {
|
|
|
2029
2029
|
},
|
|
2030
2030
|
field: {
|
|
2031
2031
|
comment: {
|
|
2032
|
-
|
|
2032
|
+
markdownText: 'The field where the field extension is installed to.',
|
|
2033
2033
|
},
|
|
2034
2034
|
location: {
|
|
2035
2035
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2039,7 +2039,7 @@ exports.manifest = {
|
|
|
2039
2039
|
},
|
|
2040
2040
|
parentField: {
|
|
2041
2041
|
comment: {
|
|
2042
|
-
|
|
2042
|
+
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
2043
|
},
|
|
2044
2044
|
location: {
|
|
2045
2045
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2049,7 +2049,7 @@ exports.manifest = {
|
|
|
2049
2049
|
},
|
|
2050
2050
|
block: {
|
|
2051
2051
|
comment: {
|
|
2052
|
-
|
|
2052
|
+
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
2053
|
},
|
|
2054
2054
|
location: {
|
|
2055
2055
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2071,7 +2071,7 @@ exports.manifest = {
|
|
|
2071
2071
|
executeUploadsDropdownAction: {
|
|
2072
2072
|
name: 'executeUploadsDropdownAction',
|
|
2073
2073
|
comment: {
|
|
2074
|
-
|
|
2074
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `uploadsDropdownActions()` hook.',
|
|
2075
2075
|
tag: 'dropdownActions',
|
|
2076
2076
|
},
|
|
2077
2077
|
nonCtxArguments: [
|
|
@@ -2110,7 +2110,7 @@ exports.manifest = {
|
|
|
2110
2110
|
executeItemsDropdownAction: {
|
|
2111
2111
|
name: 'executeItemsDropdownAction',
|
|
2112
2112
|
comment: {
|
|
2113
|
-
|
|
2113
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `itemsDropdownActions()` hook.',
|
|
2114
2114
|
tag: 'dropdownActions',
|
|
2115
2115
|
},
|
|
2116
2116
|
nonCtxArguments: [
|
|
@@ -2149,7 +2149,7 @@ exports.manifest = {
|
|
|
2149
2149
|
executeItemFormDropdownAction: {
|
|
2150
2150
|
name: 'executeItemFormDropdownAction',
|
|
2151
2151
|
comment: {
|
|
2152
|
-
|
|
2152
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `itemFormDropdownActions()` hook.',
|
|
2153
2153
|
tag: 'dropdownActions',
|
|
2154
2154
|
},
|
|
2155
2155
|
nonCtxArguments: [
|
|
@@ -2164,12 +2164,12 @@ exports.manifest = {
|
|
|
2164
2164
|
{
|
|
2165
2165
|
name: 'ItemFormAdditionalProperties',
|
|
2166
2166
|
comment: {
|
|
2167
|
-
|
|
2167
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
2168
2168
|
},
|
|
2169
2169
|
items: {
|
|
2170
2170
|
locale: {
|
|
2171
2171
|
comment: {
|
|
2172
|
-
|
|
2172
|
+
markdownText: 'The currently active locale for the record.',
|
|
2173
2173
|
},
|
|
2174
2174
|
location: {
|
|
2175
2175
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2179,7 +2179,7 @@ exports.manifest = {
|
|
|
2179
2179
|
},
|
|
2180
2180
|
item: {
|
|
2181
2181
|
comment: {
|
|
2182
|
-
|
|
2182
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
2183
2183
|
},
|
|
2184
2184
|
location: {
|
|
2185
2185
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2189,7 +2189,7 @@ exports.manifest = {
|
|
|
2189
2189
|
},
|
|
2190
2190
|
itemType: {
|
|
2191
2191
|
comment: {
|
|
2192
|
-
|
|
2192
|
+
markdownText: 'The model for the record being edited.',
|
|
2193
2193
|
},
|
|
2194
2194
|
location: {
|
|
2195
2195
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2199,7 +2199,7 @@ exports.manifest = {
|
|
|
2199
2199
|
},
|
|
2200
2200
|
formValues: {
|
|
2201
2201
|
comment: {
|
|
2202
|
-
|
|
2202
|
+
markdownText: 'The complete internal form state.',
|
|
2203
2203
|
},
|
|
2204
2204
|
location: {
|
|
2205
2205
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2209,7 +2209,7 @@ exports.manifest = {
|
|
|
2209
2209
|
},
|
|
2210
2210
|
itemStatus: {
|
|
2211
2211
|
comment: {
|
|
2212
|
-
|
|
2212
|
+
markdownText: 'The current status of the record being edited.',
|
|
2213
2213
|
},
|
|
2214
2214
|
location: {
|
|
2215
2215
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2219,7 +2219,7 @@ exports.manifest = {
|
|
|
2219
2219
|
},
|
|
2220
2220
|
isSubmitting: {
|
|
2221
2221
|
comment: {
|
|
2222
|
-
|
|
2222
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
2223
2223
|
},
|
|
2224
2224
|
location: {
|
|
2225
2225
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2229,7 +2229,7 @@ exports.manifest = {
|
|
|
2229
2229
|
},
|
|
2230
2230
|
isFormDirty: {
|
|
2231
2231
|
comment: {
|
|
2232
|
-
|
|
2232
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
2233
2233
|
},
|
|
2234
2234
|
location: {
|
|
2235
2235
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2239,7 +2239,7 @@ exports.manifest = {
|
|
|
2239
2239
|
},
|
|
2240
2240
|
blocksAnalysis: {
|
|
2241
2241
|
comment: {
|
|
2242
|
-
|
|
2242
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
2243
2243
|
},
|
|
2244
2244
|
location: {
|
|
2245
2245
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2265,12 +2265,12 @@ exports.manifest = {
|
|
|
2265
2265
|
{
|
|
2266
2266
|
name: 'ItemFormAdditionalMethods',
|
|
2267
2267
|
comment: {
|
|
2268
|
-
|
|
2268
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
2269
2269
|
},
|
|
2270
2270
|
items: {
|
|
2271
2271
|
toggleField: {
|
|
2272
2272
|
comment: {
|
|
2273
|
-
|
|
2273
|
+
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
2274
|
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
2275
|
},
|
|
2276
2276
|
location: {
|
|
@@ -2281,7 +2281,7 @@ exports.manifest = {
|
|
|
2281
2281
|
},
|
|
2282
2282
|
disableField: {
|
|
2283
2283
|
comment: {
|
|
2284
|
-
|
|
2284
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
2285
2285
|
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
2286
|
},
|
|
2287
2287
|
location: {
|
|
@@ -2292,7 +2292,7 @@ exports.manifest = {
|
|
|
2292
2292
|
},
|
|
2293
2293
|
scrollToField: {
|
|
2294
2294
|
comment: {
|
|
2295
|
-
|
|
2295
|
+
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
2296
|
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
2297
|
},
|
|
2298
2298
|
location: {
|
|
@@ -2303,7 +2303,7 @@ exports.manifest = {
|
|
|
2303
2303
|
},
|
|
2304
2304
|
setFieldValue: {
|
|
2305
2305
|
comment: {
|
|
2306
|
-
|
|
2306
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
2307
2307
|
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
2308
|
},
|
|
2309
2309
|
location: {
|
|
@@ -2314,7 +2314,7 @@ exports.manifest = {
|
|
|
2314
2314
|
},
|
|
2315
2315
|
formValuesToItem: {
|
|
2316
2316
|
comment: {
|
|
2317
|
-
|
|
2317
|
+
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
2318
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
2319
2319
|
},
|
|
2320
2320
|
location: {
|
|
@@ -2325,7 +2325,7 @@ exports.manifest = {
|
|
|
2325
2325
|
},
|
|
2326
2326
|
itemToFormValues: {
|
|
2327
2327
|
comment: {
|
|
2328
|
-
|
|
2328
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
2329
2329
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
2330
2330
|
},
|
|
2331
2331
|
location: {
|
|
@@ -2336,7 +2336,7 @@ exports.manifest = {
|
|
|
2336
2336
|
},
|
|
2337
2337
|
saveCurrentItem: {
|
|
2338
2338
|
comment: {
|
|
2339
|
-
|
|
2339
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
2340
2340
|
example: 'await ctx.saveCurrentItem();',
|
|
2341
2341
|
},
|
|
2342
2342
|
location: {
|
|
@@ -2358,7 +2358,7 @@ exports.manifest = {
|
|
|
2358
2358
|
executeFieldDropdownAction: {
|
|
2359
2359
|
name: 'executeFieldDropdownAction',
|
|
2360
2360
|
comment: {
|
|
2361
|
-
|
|
2361
|
+
markdownText: 'Use this function to execute a particular dropdown action defined via\nthe `fieldDropdownActions()` hook.',
|
|
2362
2362
|
tag: 'dropdownActions',
|
|
2363
2363
|
},
|
|
2364
2364
|
nonCtxArguments: [
|
|
@@ -2373,12 +2373,12 @@ exports.manifest = {
|
|
|
2373
2373
|
{
|
|
2374
2374
|
name: 'ItemFormAdditionalProperties',
|
|
2375
2375
|
comment: {
|
|
2376
|
-
|
|
2376
|
+
markdownText: "These information describe the current state of the form that's being shown\nto the end-user to edit a record.",
|
|
2377
2377
|
},
|
|
2378
2378
|
items: {
|
|
2379
2379
|
locale: {
|
|
2380
2380
|
comment: {
|
|
2381
|
-
|
|
2381
|
+
markdownText: 'The currently active locale for the record.',
|
|
2382
2382
|
},
|
|
2383
2383
|
location: {
|
|
2384
2384
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2388,7 +2388,7 @@ exports.manifest = {
|
|
|
2388
2388
|
},
|
|
2389
2389
|
item: {
|
|
2390
2390
|
comment: {
|
|
2391
|
-
|
|
2391
|
+
markdownText: 'If an already persisted record is being edited, returns the full record\nentity.',
|
|
2392
2392
|
},
|
|
2393
2393
|
location: {
|
|
2394
2394
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2398,7 +2398,7 @@ exports.manifest = {
|
|
|
2398
2398
|
},
|
|
2399
2399
|
itemType: {
|
|
2400
2400
|
comment: {
|
|
2401
|
-
|
|
2401
|
+
markdownText: 'The model for the record being edited.',
|
|
2402
2402
|
},
|
|
2403
2403
|
location: {
|
|
2404
2404
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2408,7 +2408,7 @@ exports.manifest = {
|
|
|
2408
2408
|
},
|
|
2409
2409
|
formValues: {
|
|
2410
2410
|
comment: {
|
|
2411
|
-
|
|
2411
|
+
markdownText: 'The complete internal form state.',
|
|
2412
2412
|
},
|
|
2413
2413
|
location: {
|
|
2414
2414
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2418,7 +2418,7 @@ exports.manifest = {
|
|
|
2418
2418
|
},
|
|
2419
2419
|
itemStatus: {
|
|
2420
2420
|
comment: {
|
|
2421
|
-
|
|
2421
|
+
markdownText: 'The current status of the record being edited.',
|
|
2422
2422
|
},
|
|
2423
2423
|
location: {
|
|
2424
2424
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2428,7 +2428,7 @@ exports.manifest = {
|
|
|
2428
2428
|
},
|
|
2429
2429
|
isSubmitting: {
|
|
2430
2430
|
comment: {
|
|
2431
|
-
|
|
2431
|
+
markdownText: 'Whether the form is currently submitting itself or not.',
|
|
2432
2432
|
},
|
|
2433
2433
|
location: {
|
|
2434
2434
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2438,7 +2438,7 @@ exports.manifest = {
|
|
|
2438
2438
|
},
|
|
2439
2439
|
isFormDirty: {
|
|
2440
2440
|
comment: {
|
|
2441
|
-
|
|
2441
|
+
markdownText: 'Whether the form has some non-persisted changes or not.',
|
|
2442
2442
|
},
|
|
2443
2443
|
location: {
|
|
2444
2444
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2448,7 +2448,7 @@ exports.manifest = {
|
|
|
2448
2448
|
},
|
|
2449
2449
|
blocksAnalysis: {
|
|
2450
2450
|
comment: {
|
|
2451
|
-
|
|
2451
|
+
markdownText: 'Provides information on how many blocks are currently present in the form.',
|
|
2452
2452
|
},
|
|
2453
2453
|
location: {
|
|
2454
2454
|
filePath: 'src/ctx/commonExtras/itemForm.ts',
|
|
@@ -2461,12 +2461,12 @@ exports.manifest = {
|
|
|
2461
2461
|
{
|
|
2462
2462
|
name: 'FieldAdditionalProperties',
|
|
2463
2463
|
comment: {
|
|
2464
|
-
|
|
2464
|
+
markdownText: 'These information describe the current state of the field where this plugin\nis applied to.',
|
|
2465
2465
|
},
|
|
2466
2466
|
items: {
|
|
2467
2467
|
disabled: {
|
|
2468
2468
|
comment: {
|
|
2469
|
-
|
|
2469
|
+
markdownText: 'Whether the field is currently disabled or not.',
|
|
2470
2470
|
},
|
|
2471
2471
|
location: {
|
|
2472
2472
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2476,7 +2476,7 @@ exports.manifest = {
|
|
|
2476
2476
|
},
|
|
2477
2477
|
fieldPath: {
|
|
2478
2478
|
comment: {
|
|
2479
|
-
|
|
2479
|
+
markdownText: 'The path in the `formValues` object where to find the current value for the\nfield.',
|
|
2480
2480
|
},
|
|
2481
2481
|
location: {
|
|
2482
2482
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2486,7 +2486,7 @@ exports.manifest = {
|
|
|
2486
2486
|
},
|
|
2487
2487
|
field: {
|
|
2488
2488
|
comment: {
|
|
2489
|
-
|
|
2489
|
+
markdownText: 'The field where the field extension is installed to.',
|
|
2490
2490
|
},
|
|
2491
2491
|
location: {
|
|
2492
2492
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2496,7 +2496,7 @@ exports.manifest = {
|
|
|
2496
2496
|
},
|
|
2497
2497
|
parentField: {
|
|
2498
2498
|
comment: {
|
|
2499
|
-
|
|
2499
|
+
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
2500
|
},
|
|
2501
2501
|
location: {
|
|
2502
2502
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2506,7 +2506,7 @@ exports.manifest = {
|
|
|
2506
2506
|
},
|
|
2507
2507
|
block: {
|
|
2508
2508
|
comment: {
|
|
2509
|
-
|
|
2509
|
+
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
2510
|
},
|
|
2511
2511
|
location: {
|
|
2512
2512
|
filePath: 'src/ctx/commonExtras/field.ts',
|
|
@@ -2532,12 +2532,12 @@ exports.manifest = {
|
|
|
2532
2532
|
{
|
|
2533
2533
|
name: 'ItemFormAdditionalMethods',
|
|
2534
2534
|
comment: {
|
|
2535
|
-
|
|
2535
|
+
markdownText: "These methods can be used to interact with the form that's being shown to the\nend-user to edit a record.",
|
|
2536
2536
|
},
|
|
2537
2537
|
items: {
|
|
2538
2538
|
toggleField: {
|
|
2539
2539
|
comment: {
|
|
2540
|
-
|
|
2540
|
+
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
2541
|
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
2542
|
},
|
|
2543
2543
|
location: {
|
|
@@ -2548,7 +2548,7 @@ exports.manifest = {
|
|
|
2548
2548
|
},
|
|
2549
2549
|
disableField: {
|
|
2550
2550
|
comment: {
|
|
2551
|
-
|
|
2551
|
+
markdownText: 'Disables/re-enables a specific field in the form.',
|
|
2552
2552
|
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
2553
|
},
|
|
2554
2554
|
location: {
|
|
@@ -2559,7 +2559,7 @@ exports.manifest = {
|
|
|
2559
2559
|
},
|
|
2560
2560
|
scrollToField: {
|
|
2561
2561
|
comment: {
|
|
2562
|
-
|
|
2562
|
+
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
2563
|
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
2564
|
},
|
|
2565
2565
|
location: {
|
|
@@ -2570,7 +2570,7 @@ exports.manifest = {
|
|
|
2570
2570
|
},
|
|
2571
2571
|
setFieldValue: {
|
|
2572
2572
|
comment: {
|
|
2573
|
-
|
|
2573
|
+
markdownText: 'Changes a specific path of the `formValues` object.',
|
|
2574
2574
|
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
2575
|
},
|
|
2576
2576
|
location: {
|
|
@@ -2581,7 +2581,7 @@ exports.manifest = {
|
|
|
2581
2581
|
},
|
|
2582
2582
|
formValuesToItem: {
|
|
2583
2583
|
comment: {
|
|
2584
|
-
|
|
2584
|
+
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
2585
|
example: 'await ctx.formValuesToItem(ctx.formValues, false);',
|
|
2586
2586
|
},
|
|
2587
2587
|
location: {
|
|
@@ -2592,7 +2592,7 @@ exports.manifest = {
|
|
|
2592
2592
|
},
|
|
2593
2593
|
itemToFormValues: {
|
|
2594
2594
|
comment: {
|
|
2595
|
-
|
|
2595
|
+
markdownText: 'Takes an Item entity, and converts it into the internal form state.',
|
|
2596
2596
|
example: 'await ctx.itemToFormValues(ctx.item);',
|
|
2597
2597
|
},
|
|
2598
2598
|
location: {
|
|
@@ -2603,7 +2603,7 @@ exports.manifest = {
|
|
|
2603
2603
|
},
|
|
2604
2604
|
saveCurrentItem: {
|
|
2605
2605
|
comment: {
|
|
2606
|
-
|
|
2606
|
+
markdownText: 'Triggers a submit form for current record.',
|
|
2607
2607
|
example: 'await ctx.saveCurrentItem();',
|
|
2608
2608
|
},
|
|
2609
2609
|
location: {
|
|
@@ -2625,7 +2625,7 @@ exports.manifest = {
|
|
|
2625
2625
|
customMarksForStructuredTextField: {
|
|
2626
2626
|
name: 'customMarksForStructuredTextField',
|
|
2627
2627
|
comment: {
|
|
2628
|
-
|
|
2628
|
+
markdownText: 'Use this function to define a number of custom marks for a specific\nStructured Text field.',
|
|
2629
2629
|
tag: 'structuredText',
|
|
2630
2630
|
},
|
|
2631
2631
|
nonCtxArguments: [
|
|
@@ -2660,7 +2660,7 @@ exports.manifest = {
|
|
|
2660
2660
|
customBlockStylesForStructuredTextField: {
|
|
2661
2661
|
name: 'customBlockStylesForStructuredTextField',
|
|
2662
2662
|
comment: {
|
|
2663
|
-
|
|
2663
|
+
markdownText: 'Use this function to define a number of custom block styles for a specific\nStructured Text field.',
|
|
2664
2664
|
tag: 'structuredText',
|
|
2665
2665
|
},
|
|
2666
2666
|
nonCtxArguments: [
|
|
@@ -2695,7 +2695,7 @@ exports.manifest = {
|
|
|
2695
2695
|
contentAreaSidebarItems: {
|
|
2696
2696
|
name: 'contentAreaSidebarItems',
|
|
2697
2697
|
comment: {
|
|
2698
|
-
|
|
2698
|
+
markdownText: 'Use this function to declare new items in the content area sidebar.',
|
|
2699
2699
|
tag: 'sidebarItems',
|
|
2700
2700
|
},
|
|
2701
2701
|
nonCtxArguments: [],
|
|
@@ -2713,7 +2713,7 @@ exports.manifest = {
|
|
|
2713
2713
|
buildItemPresentationInfo: {
|
|
2714
2714
|
name: 'buildItemPresentationInfo',
|
|
2715
2715
|
comment: {
|
|
2716
|
-
|
|
2716
|
+
markdownText: 'Use this function to customize the presentation of a record in records\ncollections and "Single link" or "Multiple links" field.',
|
|
2717
2717
|
tag: 'presentation',
|
|
2718
2718
|
},
|
|
2719
2719
|
nonCtxArguments: [
|
|
@@ -2736,7 +2736,7 @@ exports.manifest = {
|
|
|
2736
2736
|
assetSources: {
|
|
2737
2737
|
name: 'assetSources',
|
|
2738
2738
|
comment: {
|
|
2739
|
-
|
|
2739
|
+
markdownText: 'Use this function to declare additional sources to be shown when users want\nto upload new assets.',
|
|
2740
2740
|
tag: 'assetSources',
|
|
2741
2741
|
},
|
|
2742
2742
|
nonCtxArguments: [],
|
|
@@ -2757,12 +2757,12 @@ exports.manifest = {
|
|
|
2757
2757
|
{
|
|
2758
2758
|
name: 'PluginProperties',
|
|
2759
2759
|
comment: {
|
|
2760
|
-
|
|
2760
|
+
markdownText: "Information about the current plugin. Useful to access the plugin's global\nconfiguration object.",
|
|
2761
2761
|
},
|
|
2762
2762
|
items: {
|
|
2763
2763
|
plugin: {
|
|
2764
2764
|
comment: {
|
|
2765
|
-
|
|
2765
|
+
markdownText: 'The current plugin.',
|
|
2766
2766
|
},
|
|
2767
2767
|
location: {
|
|
2768
2768
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2775,12 +2775,12 @@ exports.manifest = {
|
|
|
2775
2775
|
{
|
|
2776
2776
|
name: 'AuthenticationProperties',
|
|
2777
2777
|
comment: {
|
|
2778
|
-
|
|
2778
|
+
markdownText: 'Information about the current user using the CMS.',
|
|
2779
2779
|
},
|
|
2780
2780
|
items: {
|
|
2781
2781
|
currentUser: {
|
|
2782
2782
|
comment: {
|
|
2783
|
-
|
|
2783
|
+
markdownText: 'The current DatoCMS user. It can either be the owner or one of the\ncollaborators (regular or SSO).',
|
|
2784
2784
|
},
|
|
2785
2785
|
location: {
|
|
2786
2786
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2790,7 +2790,7 @@ exports.manifest = {
|
|
|
2790
2790
|
},
|
|
2791
2791
|
currentRole: {
|
|
2792
2792
|
comment: {
|
|
2793
|
-
|
|
2793
|
+
markdownText: 'The role for the current DatoCMS user.',
|
|
2794
2794
|
},
|
|
2795
2795
|
location: {
|
|
2796
2796
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2800,7 +2800,7 @@ exports.manifest = {
|
|
|
2800
2800
|
},
|
|
2801
2801
|
currentUserAccessToken: {
|
|
2802
2802
|
comment: {
|
|
2803
|
-
|
|
2803
|
+
markdownText: 'The access token to perform API calls on behalf of the current user. Only\navailable if `currentUserAccessToken` additional permission is granted.',
|
|
2804
2804
|
},
|
|
2805
2805
|
location: {
|
|
2806
2806
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2815,7 +2815,7 @@ exports.manifest = {
|
|
|
2815
2815
|
items: {
|
|
2816
2816
|
site: {
|
|
2817
2817
|
comment: {
|
|
2818
|
-
|
|
2818
|
+
markdownText: 'The current DatoCMS project.',
|
|
2819
2819
|
},
|
|
2820
2820
|
location: {
|
|
2821
2821
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2825,7 +2825,7 @@ exports.manifest = {
|
|
|
2825
2825
|
},
|
|
2826
2826
|
environment: {
|
|
2827
2827
|
comment: {
|
|
2828
|
-
|
|
2828
|
+
markdownText: 'The ID of the current environment.',
|
|
2829
2829
|
},
|
|
2830
2830
|
location: {
|
|
2831
2831
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2835,7 +2835,7 @@ exports.manifest = {
|
|
|
2835
2835
|
},
|
|
2836
2836
|
owner: {
|
|
2837
2837
|
comment: {
|
|
2838
|
-
|
|
2838
|
+
markdownText: 'The account/organization that is the project owner.',
|
|
2839
2839
|
},
|
|
2840
2840
|
location: {
|
|
2841
2841
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2845,7 +2845,8 @@ exports.manifest = {
|
|
|
2845
2845
|
},
|
|
2846
2846
|
account: {
|
|
2847
2847
|
comment: {
|
|
2848
|
-
|
|
2848
|
+
markdownText: 'The account that is the project owner.',
|
|
2849
|
+
deprecatedMarkdownText: 'Please use `.owner` instead, as the project owner can also be\nan organization',
|
|
2849
2850
|
},
|
|
2850
2851
|
location: {
|
|
2851
2852
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2855,7 +2856,7 @@ exports.manifest = {
|
|
|
2855
2856
|
},
|
|
2856
2857
|
ui: {
|
|
2857
2858
|
comment: {
|
|
2858
|
-
|
|
2859
|
+
markdownText: 'UI preferences of the current user (right now, only the preferred locale is\navailable).',
|
|
2859
2860
|
},
|
|
2860
2861
|
location: {
|
|
2861
2862
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2865,7 +2866,7 @@ exports.manifest = {
|
|
|
2865
2866
|
},
|
|
2866
2867
|
theme: {
|
|
2867
2868
|
comment: {
|
|
2868
|
-
|
|
2869
|
+
markdownText: 'An object containing the theme colors for the current DatoCMS project.',
|
|
2869
2870
|
},
|
|
2870
2871
|
location: {
|
|
2871
2872
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2878,12 +2879,12 @@ exports.manifest = {
|
|
|
2878
2879
|
{
|
|
2879
2880
|
name: 'EntityReposProperties',
|
|
2880
2881
|
comment: {
|
|
2881
|
-
|
|
2882
|
+
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
2883
|
},
|
|
2883
2884
|
items: {
|
|
2884
2885
|
itemTypes: {
|
|
2885
2886
|
comment: {
|
|
2886
|
-
|
|
2887
|
+
markdownText: 'All the models of the current DatoCMS project, indexed by ID.',
|
|
2887
2888
|
},
|
|
2888
2889
|
location: {
|
|
2889
2890
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2893,7 +2894,7 @@ exports.manifest = {
|
|
|
2893
2894
|
},
|
|
2894
2895
|
fields: {
|
|
2895
2896
|
comment: {
|
|
2896
|
-
|
|
2897
|
+
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
2898
|
},
|
|
2898
2899
|
location: {
|
|
2899
2900
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2903,7 +2904,7 @@ exports.manifest = {
|
|
|
2903
2904
|
},
|
|
2904
2905
|
fieldsets: {
|
|
2905
2906
|
comment: {
|
|
2906
|
-
|
|
2907
|
+
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
2908
|
},
|
|
2908
2909
|
location: {
|
|
2909
2910
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2913,7 +2914,7 @@ exports.manifest = {
|
|
|
2913
2914
|
},
|
|
2914
2915
|
users: {
|
|
2915
2916
|
comment: {
|
|
2916
|
-
|
|
2917
|
+
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
2918
|
},
|
|
2918
2919
|
location: {
|
|
2919
2920
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2923,7 +2924,7 @@ exports.manifest = {
|
|
|
2923
2924
|
},
|
|
2924
2925
|
ssoUsers: {
|
|
2925
2926
|
comment: {
|
|
2926
|
-
|
|
2927
|
+
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
2928
|
},
|
|
2928
2929
|
location: {
|
|
2929
2930
|
filePath: 'src/ctx/base.ts',
|
|
@@ -2938,12 +2939,12 @@ exports.manifest = {
|
|
|
2938
2939
|
{
|
|
2939
2940
|
name: 'LoadDataMethods',
|
|
2940
2941
|
comment: {
|
|
2941
|
-
|
|
2942
|
+
markdownText: 'These methods can be used to asyncronously load additional information your\nplugin needs to work.',
|
|
2942
2943
|
},
|
|
2943
2944
|
items: {
|
|
2944
2945
|
loadItemTypeFields: {
|
|
2945
2946
|
comment: {
|
|
2946
|
-
|
|
2947
|
+
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
2948
|
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
2949
|
},
|
|
2949
2950
|
location: {
|
|
@@ -2954,7 +2955,7 @@ exports.manifest = {
|
|
|
2954
2955
|
},
|
|
2955
2956
|
loadItemTypeFieldsets: {
|
|
2956
2957
|
comment: {
|
|
2957
|
-
|
|
2958
|
+
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
2959
|
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
2960
|
},
|
|
2960
2961
|
location: {
|
|
@@ -2965,7 +2966,7 @@ exports.manifest = {
|
|
|
2965
2966
|
},
|
|
2966
2967
|
loadFieldsUsingPlugin: {
|
|
2967
2968
|
comment: {
|
|
2968
|
-
|
|
2969
|
+
markdownText: 'Loads all the fields in the project that are currently using the plugin for\none of its manual field extensions.',
|
|
2969
2970
|
example: "const fields = await ctx.loadFieldsUsingPlugin();\n\nctx.notice(\n `Success! ${fields\n .map((field) => field.attributes.api_key)\n .join(', ')}`,\n);",
|
|
2970
2971
|
},
|
|
2971
2972
|
location: {
|
|
@@ -2976,7 +2977,7 @@ exports.manifest = {
|
|
|
2976
2977
|
},
|
|
2977
2978
|
loadUsers: {
|
|
2978
2979
|
comment: {
|
|
2979
|
-
|
|
2980
|
+
markdownText: 'Loads all regular users. Users will be returned and will also be available\nin the the `users` property.',
|
|
2980
2981
|
example: "const users = await ctx.loadUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
|
|
2981
2982
|
},
|
|
2982
2983
|
location: {
|
|
@@ -2987,7 +2988,7 @@ exports.manifest = {
|
|
|
2987
2988
|
},
|
|
2988
2989
|
loadSsoUsers: {
|
|
2989
2990
|
comment: {
|
|
2990
|
-
|
|
2991
|
+
markdownText: 'Loads all SSO users. Users will be returned and will also be available in\nthe the `ssoUsers` property.',
|
|
2991
2992
|
example: "const users = await ctx.loadSsoUsers();\n\nctx.notice(`Success! ${users.map((user) => user.id).join(', ')}`);",
|
|
2992
2993
|
},
|
|
2993
2994
|
location: {
|
|
@@ -3001,12 +3002,12 @@ exports.manifest = {
|
|
|
3001
3002
|
{
|
|
3002
3003
|
name: 'UpdatePluginParametersMethods',
|
|
3003
3004
|
comment: {
|
|
3004
|
-
|
|
3005
|
+
markdownText: 'These methods can be used to update both plugin parameters and manual field\nextensions configuration.',
|
|
3005
3006
|
},
|
|
3006
3007
|
items: {
|
|
3007
3008
|
updatePluginParameters: {
|
|
3008
3009
|
comment: {
|
|
3009
|
-
|
|
3010
|
+
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
3011
|
example: "await ctx.updatePluginParameters({ debugMode: true });\nawait ctx.notice('Plugin parameters successfully updated!');",
|
|
3011
3012
|
},
|
|
3012
3013
|
location: {
|
|
@@ -3017,7 +3018,7 @@ exports.manifest = {
|
|
|
3017
3018
|
},
|
|
3018
3019
|
updateFieldAppearance: {
|
|
3019
3020
|
comment: {
|
|
3020
|
-
|
|
3021
|
+
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
3022
|
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
3023
|
},
|
|
3023
3024
|
location: {
|
|
@@ -3031,12 +3032,12 @@ exports.manifest = {
|
|
|
3031
3032
|
{
|
|
3032
3033
|
name: 'ToastMethods',
|
|
3033
3034
|
comment: {
|
|
3034
|
-
|
|
3035
|
+
markdownText: 'These methods can be used to show UI-consistent toast notifications to the\nend-user.',
|
|
3035
3036
|
},
|
|
3036
3037
|
items: {
|
|
3037
3038
|
alert: {
|
|
3038
3039
|
comment: {
|
|
3039
|
-
|
|
3040
|
+
markdownText: 'Triggers an "error" toast displaying the selected message.',
|
|
3040
3041
|
example: "const message = prompt(\n 'Please insert a message:',\n 'This is an alert message!',\n);\n\nawait ctx.alert(message);",
|
|
3041
3042
|
},
|
|
3042
3043
|
location: {
|
|
@@ -3047,7 +3048,7 @@ exports.manifest = {
|
|
|
3047
3048
|
},
|
|
3048
3049
|
notice: {
|
|
3049
3050
|
comment: {
|
|
3050
|
-
|
|
3051
|
+
markdownText: 'Triggers a "success" toast displaying the selected message.',
|
|
3051
3052
|
example: "const message = prompt(\n 'Please insert a message:',\n 'This is a notice message!',\n);\n\nawait ctx.notice(message);",
|
|
3052
3053
|
},
|
|
3053
3054
|
location: {
|
|
@@ -3058,7 +3059,7 @@ exports.manifest = {
|
|
|
3058
3059
|
},
|
|
3059
3060
|
customToast: {
|
|
3060
3061
|
comment: {
|
|
3061
|
-
|
|
3062
|
+
markdownText: 'Triggers a custom toast displaying the selected message (and optionally a\nCTA).',
|
|
3062
3063
|
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
3064
|
},
|
|
3064
3065
|
location: {
|
|
@@ -3072,12 +3073,12 @@ exports.manifest = {
|
|
|
3072
3073
|
{
|
|
3073
3074
|
name: 'ItemDialogMethods',
|
|
3074
3075
|
comment: {
|
|
3075
|
-
|
|
3076
|
+
markdownText: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith records.',
|
|
3076
3077
|
},
|
|
3077
3078
|
items: {
|
|
3078
3079
|
createNewItem: {
|
|
3079
3080
|
comment: {
|
|
3080
|
-
|
|
3081
|
+
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
3082
|
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
3083
|
},
|
|
3083
3084
|
location: {
|
|
@@ -3088,7 +3089,7 @@ exports.manifest = {
|
|
|
3088
3089
|
},
|
|
3089
3090
|
selectItem: {
|
|
3090
3091
|
comment: {
|
|
3091
|
-
|
|
3092
|
+
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
3093
|
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
3094
|
},
|
|
3094
3095
|
location: {
|
|
@@ -3099,7 +3100,7 @@ exports.manifest = {
|
|
|
3099
3100
|
},
|
|
3100
3101
|
editItem: {
|
|
3101
3102
|
comment: {
|
|
3102
|
-
|
|
3103
|
+
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
3104
|
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
3105
|
},
|
|
3105
3106
|
location: {
|
|
@@ -3113,12 +3114,12 @@ exports.manifest = {
|
|
|
3113
3114
|
{
|
|
3114
3115
|
name: 'UploadDialogMethods',
|
|
3115
3116
|
comment: {
|
|
3116
|
-
|
|
3117
|
+
markdownText: 'These methods let you open the standard DatoCMS dialogs needed to interact\nwith Media Area assets.',
|
|
3117
3118
|
},
|
|
3118
3119
|
items: {
|
|
3119
3120
|
selectUpload: {
|
|
3120
3121
|
comment: {
|
|
3121
|
-
|
|
3122
|
+
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
3123
|
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
3124
|
},
|
|
3124
3125
|
location: {
|
|
@@ -3129,7 +3130,7 @@ exports.manifest = {
|
|
|
3129
3130
|
},
|
|
3130
3131
|
editUpload: {
|
|
3131
3132
|
comment: {
|
|
3132
|
-
|
|
3133
|
+
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
3134
|
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
3135
|
},
|
|
3135
3136
|
location: {
|
|
@@ -3140,7 +3141,7 @@ exports.manifest = {
|
|
|
3140
3141
|
},
|
|
3141
3142
|
editUploadMetadata: {
|
|
3142
3143
|
comment: {
|
|
3143
|
-
|
|
3144
|
+
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
3145
|
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
3146
|
},
|
|
3146
3147
|
location: {
|
|
@@ -3154,12 +3155,12 @@ exports.manifest = {
|
|
|
3154
3155
|
{
|
|
3155
3156
|
name: 'CustomDialogMethods',
|
|
3156
3157
|
comment: {
|
|
3157
|
-
|
|
3158
|
+
markdownText: 'These methods can be used to open custom dialogs/confirmation panels.',
|
|
3158
3159
|
},
|
|
3159
3160
|
items: {
|
|
3160
3161
|
openModal: {
|
|
3161
3162
|
comment: {
|
|
3162
|
-
|
|
3163
|
+
markdownText: 'Opens a custom modal. Returns a promise resolved with what the modal itself\nreturns calling the `resolve()` function.',
|
|
3163
3164
|
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
3165
|
},
|
|
3165
3166
|
location: {
|
|
@@ -3170,7 +3171,7 @@ exports.manifest = {
|
|
|
3170
3171
|
},
|
|
3171
3172
|
openConfirm: {
|
|
3172
3173
|
comment: {
|
|
3173
|
-
|
|
3174
|
+
markdownText: 'Opens a UI-consistent confirmation dialog. Returns a promise resolved with\nthe value of the choice made by the user.',
|
|
3174
3175
|
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
3176
|
},
|
|
3176
3177
|
location: {
|
|
@@ -3184,12 +3185,12 @@ exports.manifest = {
|
|
|
3184
3185
|
{
|
|
3185
3186
|
name: 'NavigateMethods',
|
|
3186
3187
|
comment: {
|
|
3187
|
-
|
|
3188
|
+
markdownText: 'These methods can be used to take the user to different pages.',
|
|
3188
3189
|
},
|
|
3189
3190
|
items: {
|
|
3190
3191
|
navigateTo: {
|
|
3191
3192
|
comment: {
|
|
3192
|
-
|
|
3193
|
+
markdownText: 'Moves the user to another URL internal to the backend.',
|
|
3193
3194
|
example: "await ctx.navigateTo('/');",
|
|
3194
3195
|
},
|
|
3195
3196
|
location: {
|
|
@@ -3205,12 +3206,12 @@ exports.manifest = {
|
|
|
3205
3206
|
selfResizingPluginFrameCtxSizingUtilities: {
|
|
3206
3207
|
name: 'SizingUtilities',
|
|
3207
3208
|
comment: {
|
|
3208
|
-
|
|
3209
|
+
markdownText: 'A number of methods that you can use to control the size of the plugin frame.',
|
|
3209
3210
|
},
|
|
3210
3211
|
items: {
|
|
3211
3212
|
startAutoResizer: {
|
|
3212
3213
|
comment: {
|
|
3213
|
-
|
|
3214
|
+
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
3215
|
},
|
|
3215
3216
|
location: {
|
|
3216
3217
|
filePath: 'src/ctx/commonExtras/sizing.ts',
|
|
@@ -3220,7 +3221,7 @@ exports.manifest = {
|
|
|
3220
3221
|
},
|
|
3221
3222
|
stopAutoResizer: {
|
|
3222
3223
|
comment: {
|
|
3223
|
-
|
|
3224
|
+
markdownText: 'Stops resizing the iframe automatically.',
|
|
3224
3225
|
},
|
|
3225
3226
|
location: {
|
|
3226
3227
|
filePath: 'src/ctx/commonExtras/sizing.ts',
|
|
@@ -3230,7 +3231,7 @@ exports.manifest = {
|
|
|
3230
3231
|
},
|
|
3231
3232
|
updateHeight: {
|
|
3232
3233
|
comment: {
|
|
3233
|
-
|
|
3234
|
+
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
3235
|
},
|
|
3235
3236
|
location: {
|
|
3236
3237
|
filePath: 'src/ctx/commonExtras/sizing.ts',
|