datocms-plugin-sdk 0.6.10 → 0.6.12
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/esm/connect.d.ts +20 -20
- package/dist/types/connect.d.ts +20 -20
- package/package.json +2 -2
- package/src/connect.ts +20 -20
- package/types.json +823 -648
package/dist/esm/connect.d.ts
CHANGED
|
@@ -37,84 +37,84 @@ export declare type FullConnectParameters = {
|
|
|
37
37
|
* This function will be called once at boot time and can be used to perform
|
|
38
38
|
* ie. some initial integrity checks on the configuration.
|
|
39
39
|
*
|
|
40
|
-
* @
|
|
40
|
+
* @tag boot
|
|
41
41
|
*/
|
|
42
42
|
onBoot: (ctx: OnBootCtx) => void;
|
|
43
43
|
/**
|
|
44
44
|
* Use this function to declare new tabs you want to add in the top-bar of the
|
|
45
45
|
* UI
|
|
46
46
|
*
|
|
47
|
-
* @
|
|
47
|
+
* @tag pages
|
|
48
48
|
*/
|
|
49
49
|
mainNavigationTabs: (ctx: IntentCtx) => MainNavigationTab[];
|
|
50
50
|
/**
|
|
51
51
|
* Use this function to declare new navigation sections in the Settings Area
|
|
52
52
|
* sidebar
|
|
53
53
|
*
|
|
54
|
-
* @
|
|
54
|
+
* @tag pages
|
|
55
55
|
*/
|
|
56
56
|
settingsAreaSidebarItemGroups: (ctx: IntentCtx) => SettingsAreaSidebarItemGroup[];
|
|
57
57
|
/**
|
|
58
58
|
* Use this function to declare new navigation items in the Content Area
|
|
59
59
|
* sidebar
|
|
60
60
|
*
|
|
61
|
-
* @
|
|
61
|
+
* @tag pages
|
|
62
62
|
*/
|
|
63
63
|
contentAreaSidebarItems: (ctx: IntentCtx) => ContentAreaSidebarItem[];
|
|
64
64
|
/**
|
|
65
65
|
* Use this function to declare new field extensions that users will be able
|
|
66
66
|
* to install manually in some field
|
|
67
67
|
*
|
|
68
|
-
* @
|
|
68
|
+
* @tag manualFieldExtensions
|
|
69
69
|
*/
|
|
70
70
|
manualFieldExtensions: (ctx: IntentCtx) => ManualFieldExtension[];
|
|
71
71
|
/**
|
|
72
72
|
* Use this function to declare additional sources to be shown when users want
|
|
73
73
|
* to upload new assets
|
|
74
74
|
*
|
|
75
|
-
* @
|
|
75
|
+
* @tag assetSources
|
|
76
76
|
*/
|
|
77
77
|
assetSources: (ctx: IntentCtx) => AssetSource[] | void;
|
|
78
78
|
/**
|
|
79
79
|
* Use this function to declare new sidebar panels to be shown when the user
|
|
80
80
|
* edits records of a particular model
|
|
81
81
|
*
|
|
82
|
-
* @
|
|
82
|
+
* @tag sidebarPanels
|
|
83
83
|
*/
|
|
84
84
|
itemFormSidebarPanels: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
85
85
|
/**
|
|
86
86
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
87
87
|
* record's editing page
|
|
88
88
|
*
|
|
89
|
-
* @
|
|
89
|
+
* @tag itemFormOutlets
|
|
90
90
|
*/
|
|
91
91
|
itemFormOutlets: (itemType: ItemType, ctx: IntentCtx) => ItemFormOutlet[];
|
|
92
92
|
/**
|
|
93
93
|
* Use this function to automatically force one or more field extensions to a
|
|
94
94
|
* particular field
|
|
95
95
|
*
|
|
96
|
-
* @
|
|
96
|
+
* @tag forcedFieldExtensions
|
|
97
97
|
*/
|
|
98
98
|
overrideFieldExtensions: (field: Field, ctx: FieldIntentCtx) => FieldExtensionOverride | void;
|
|
99
99
|
/**
|
|
100
100
|
* Use this function to define a number of custom marks for a specific
|
|
101
101
|
* Structured Text field
|
|
102
102
|
*
|
|
103
|
-
* @
|
|
103
|
+
* @tag structuredText
|
|
104
104
|
*/
|
|
105
105
|
customMarksForStructuredTextField: (field: Field, ctx: FieldIntentCtx) => StructuredTextCustomMark[] | void;
|
|
106
106
|
/**
|
|
107
107
|
* Use this function to define a number of custom block styles for a specific
|
|
108
108
|
* Structured Text field
|
|
109
109
|
*
|
|
110
|
-
* @
|
|
110
|
+
* @tag structuredText
|
|
111
111
|
*/
|
|
112
112
|
customBlockStylesForStructuredTextField: (field: Field, ctx: FieldIntentCtx) => StructuredTextCustomBlockStyle[] | void;
|
|
113
113
|
/**
|
|
114
114
|
* This function will be called when the plugin needs to render the plugin's
|
|
115
115
|
* configuration form
|
|
116
116
|
*
|
|
117
|
-
* @
|
|
117
|
+
* @tag configScreen
|
|
118
118
|
*/
|
|
119
119
|
renderConfigScreen: (ctx: RenderConfigScreenCtx) => void;
|
|
120
120
|
/**
|
|
@@ -122,35 +122,35 @@ export declare type FullConnectParameters = {
|
|
|
122
122
|
* page (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and
|
|
123
123
|
* `contentAreaSidebarItems` functions)
|
|
124
124
|
*
|
|
125
|
-
* @
|
|
125
|
+
* @tag pages
|
|
126
126
|
*/
|
|
127
127
|
renderPage: (pageId: string, ctx: RenderPageCtx) => void;
|
|
128
128
|
/**
|
|
129
129
|
* This function will be called when the plugin requested to open a modal (see
|
|
130
130
|
* the `openModal` function)
|
|
131
131
|
*
|
|
132
|
-
* @
|
|
132
|
+
* @tag modals
|
|
133
133
|
*/
|
|
134
134
|
renderModal: (modalId: string, ctx: RenderModalCtx) => void;
|
|
135
135
|
/**
|
|
136
136
|
* This function will be called when the plugin needs to render a sidebar
|
|
137
137
|
* panel (see the `itemFormSidebarPanels` function)
|
|
138
138
|
*
|
|
139
|
-
* @
|
|
139
|
+
* @tag sidebarPanels
|
|
140
140
|
*/
|
|
141
141
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
142
142
|
/**
|
|
143
143
|
* This function will be called when the plugin needs to render an outlet (see
|
|
144
144
|
* the `itemFormOutlets` function)
|
|
145
145
|
*
|
|
146
|
-
* @
|
|
146
|
+
* @tag itemFormOutlets
|
|
147
147
|
*/
|
|
148
148
|
renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
|
|
149
149
|
/**
|
|
150
150
|
* This function will be called when the user selects one of the plugin's
|
|
151
151
|
* asset sources to upload a new media file.
|
|
152
152
|
*
|
|
153
|
-
* @
|
|
153
|
+
* @tag assetSources
|
|
154
154
|
*/
|
|
155
155
|
renderAssetSource: (assetSourceId: string, ctx: RenderAssetSourceCtx) => void;
|
|
156
156
|
/**
|
|
@@ -158,7 +158,7 @@ export declare type FullConnectParameters = {
|
|
|
158
158
|
* extension (see the `manualFieldExtensions` and `overrideFieldExtensions`
|
|
159
159
|
* functions)
|
|
160
160
|
*
|
|
161
|
-
* @
|
|
161
|
+
* @tag forcedFieldExtensions
|
|
162
162
|
*/
|
|
163
163
|
renderFieldExtension: (fieldExtensionId: string, ctx: RenderFieldExtensionCtx) => void;
|
|
164
164
|
/**
|
|
@@ -166,14 +166,14 @@ export declare type FullConnectParameters = {
|
|
|
166
166
|
* configuration form for installing a field extension inside a particular
|
|
167
167
|
* field
|
|
168
168
|
*
|
|
169
|
-
* @
|
|
169
|
+
* @tag manualFieldExtensions
|
|
170
170
|
*/
|
|
171
171
|
renderManualFieldExtensionConfigScreen: (fieldExtensionId: string, ctx: RenderManualFieldExtensionConfigScreenCtx) => void;
|
|
172
172
|
/**
|
|
173
173
|
* This function will be called each time the configuration object changes. It
|
|
174
174
|
* must return an object containing possible validation errors
|
|
175
175
|
*
|
|
176
|
-
* @
|
|
176
|
+
* @tag manualFieldExtensions
|
|
177
177
|
*/
|
|
178
178
|
validateManualFieldExtensionParameters: (fieldExtensionId: string, parameters: Record<string, unknown>) => Record<string, unknown> | Promise<Record<string, unknown>>;
|
|
179
179
|
};
|
package/dist/types/connect.d.ts
CHANGED
|
@@ -37,84 +37,84 @@ export declare type FullConnectParameters = {
|
|
|
37
37
|
* This function will be called once at boot time and can be used to perform
|
|
38
38
|
* ie. some initial integrity checks on the configuration.
|
|
39
39
|
*
|
|
40
|
-
* @
|
|
40
|
+
* @tag boot
|
|
41
41
|
*/
|
|
42
42
|
onBoot: (ctx: OnBootCtx) => void;
|
|
43
43
|
/**
|
|
44
44
|
* Use this function to declare new tabs you want to add in the top-bar of the
|
|
45
45
|
* UI
|
|
46
46
|
*
|
|
47
|
-
* @
|
|
47
|
+
* @tag pages
|
|
48
48
|
*/
|
|
49
49
|
mainNavigationTabs: (ctx: IntentCtx) => MainNavigationTab[];
|
|
50
50
|
/**
|
|
51
51
|
* Use this function to declare new navigation sections in the Settings Area
|
|
52
52
|
* sidebar
|
|
53
53
|
*
|
|
54
|
-
* @
|
|
54
|
+
* @tag pages
|
|
55
55
|
*/
|
|
56
56
|
settingsAreaSidebarItemGroups: (ctx: IntentCtx) => SettingsAreaSidebarItemGroup[];
|
|
57
57
|
/**
|
|
58
58
|
* Use this function to declare new navigation items in the Content Area
|
|
59
59
|
* sidebar
|
|
60
60
|
*
|
|
61
|
-
* @
|
|
61
|
+
* @tag pages
|
|
62
62
|
*/
|
|
63
63
|
contentAreaSidebarItems: (ctx: IntentCtx) => ContentAreaSidebarItem[];
|
|
64
64
|
/**
|
|
65
65
|
* Use this function to declare new field extensions that users will be able
|
|
66
66
|
* to install manually in some field
|
|
67
67
|
*
|
|
68
|
-
* @
|
|
68
|
+
* @tag manualFieldExtensions
|
|
69
69
|
*/
|
|
70
70
|
manualFieldExtensions: (ctx: IntentCtx) => ManualFieldExtension[];
|
|
71
71
|
/**
|
|
72
72
|
* Use this function to declare additional sources to be shown when users want
|
|
73
73
|
* to upload new assets
|
|
74
74
|
*
|
|
75
|
-
* @
|
|
75
|
+
* @tag assetSources
|
|
76
76
|
*/
|
|
77
77
|
assetSources: (ctx: IntentCtx) => AssetSource[] | void;
|
|
78
78
|
/**
|
|
79
79
|
* Use this function to declare new sidebar panels to be shown when the user
|
|
80
80
|
* edits records of a particular model
|
|
81
81
|
*
|
|
82
|
-
* @
|
|
82
|
+
* @tag sidebarPanels
|
|
83
83
|
*/
|
|
84
84
|
itemFormSidebarPanels: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
85
85
|
/**
|
|
86
86
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
87
87
|
* record's editing page
|
|
88
88
|
*
|
|
89
|
-
* @
|
|
89
|
+
* @tag itemFormOutlets
|
|
90
90
|
*/
|
|
91
91
|
itemFormOutlets: (itemType: ItemType, ctx: IntentCtx) => ItemFormOutlet[];
|
|
92
92
|
/**
|
|
93
93
|
* Use this function to automatically force one or more field extensions to a
|
|
94
94
|
* particular field
|
|
95
95
|
*
|
|
96
|
-
* @
|
|
96
|
+
* @tag forcedFieldExtensions
|
|
97
97
|
*/
|
|
98
98
|
overrideFieldExtensions: (field: Field, ctx: FieldIntentCtx) => FieldExtensionOverride | void;
|
|
99
99
|
/**
|
|
100
100
|
* Use this function to define a number of custom marks for a specific
|
|
101
101
|
* Structured Text field
|
|
102
102
|
*
|
|
103
|
-
* @
|
|
103
|
+
* @tag structuredText
|
|
104
104
|
*/
|
|
105
105
|
customMarksForStructuredTextField: (field: Field, ctx: FieldIntentCtx) => StructuredTextCustomMark[] | void;
|
|
106
106
|
/**
|
|
107
107
|
* Use this function to define a number of custom block styles for a specific
|
|
108
108
|
* Structured Text field
|
|
109
109
|
*
|
|
110
|
-
* @
|
|
110
|
+
* @tag structuredText
|
|
111
111
|
*/
|
|
112
112
|
customBlockStylesForStructuredTextField: (field: Field, ctx: FieldIntentCtx) => StructuredTextCustomBlockStyle[] | void;
|
|
113
113
|
/**
|
|
114
114
|
* This function will be called when the plugin needs to render the plugin's
|
|
115
115
|
* configuration form
|
|
116
116
|
*
|
|
117
|
-
* @
|
|
117
|
+
* @tag configScreen
|
|
118
118
|
*/
|
|
119
119
|
renderConfigScreen: (ctx: RenderConfigScreenCtx) => void;
|
|
120
120
|
/**
|
|
@@ -122,35 +122,35 @@ export declare type FullConnectParameters = {
|
|
|
122
122
|
* page (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and
|
|
123
123
|
* `contentAreaSidebarItems` functions)
|
|
124
124
|
*
|
|
125
|
-
* @
|
|
125
|
+
* @tag pages
|
|
126
126
|
*/
|
|
127
127
|
renderPage: (pageId: string, ctx: RenderPageCtx) => void;
|
|
128
128
|
/**
|
|
129
129
|
* This function will be called when the plugin requested to open a modal (see
|
|
130
130
|
* the `openModal` function)
|
|
131
131
|
*
|
|
132
|
-
* @
|
|
132
|
+
* @tag modals
|
|
133
133
|
*/
|
|
134
134
|
renderModal: (modalId: string, ctx: RenderModalCtx) => void;
|
|
135
135
|
/**
|
|
136
136
|
* This function will be called when the plugin needs to render a sidebar
|
|
137
137
|
* panel (see the `itemFormSidebarPanels` function)
|
|
138
138
|
*
|
|
139
|
-
* @
|
|
139
|
+
* @tag sidebarPanels
|
|
140
140
|
*/
|
|
141
141
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
142
142
|
/**
|
|
143
143
|
* This function will be called when the plugin needs to render an outlet (see
|
|
144
144
|
* the `itemFormOutlets` function)
|
|
145
145
|
*
|
|
146
|
-
* @
|
|
146
|
+
* @tag itemFormOutlets
|
|
147
147
|
*/
|
|
148
148
|
renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
|
|
149
149
|
/**
|
|
150
150
|
* This function will be called when the user selects one of the plugin's
|
|
151
151
|
* asset sources to upload a new media file.
|
|
152
152
|
*
|
|
153
|
-
* @
|
|
153
|
+
* @tag assetSources
|
|
154
154
|
*/
|
|
155
155
|
renderAssetSource: (assetSourceId: string, ctx: RenderAssetSourceCtx) => void;
|
|
156
156
|
/**
|
|
@@ -158,7 +158,7 @@ export declare type FullConnectParameters = {
|
|
|
158
158
|
* extension (see the `manualFieldExtensions` and `overrideFieldExtensions`
|
|
159
159
|
* functions)
|
|
160
160
|
*
|
|
161
|
-
* @
|
|
161
|
+
* @tag forcedFieldExtensions
|
|
162
162
|
*/
|
|
163
163
|
renderFieldExtension: (fieldExtensionId: string, ctx: RenderFieldExtensionCtx) => void;
|
|
164
164
|
/**
|
|
@@ -166,14 +166,14 @@ export declare type FullConnectParameters = {
|
|
|
166
166
|
* configuration form for installing a field extension inside a particular
|
|
167
167
|
* field
|
|
168
168
|
*
|
|
169
|
-
* @
|
|
169
|
+
* @tag manualFieldExtensions
|
|
170
170
|
*/
|
|
171
171
|
renderManualFieldExtensionConfigScreen: (fieldExtensionId: string, ctx: RenderManualFieldExtensionConfigScreenCtx) => void;
|
|
172
172
|
/**
|
|
173
173
|
* This function will be called each time the configuration object changes. It
|
|
174
174
|
* must return an object containing possible validation errors
|
|
175
175
|
*
|
|
176
|
-
* @
|
|
176
|
+
* @tag manualFieldExtensions
|
|
177
177
|
*/
|
|
178
178
|
validateManualFieldExtensionParameters: (fieldExtensionId: string, parameters: Record<string, unknown>) => Record<string, unknown> | Promise<Record<string, unknown>>;
|
|
179
179
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "datocms-plugin-sdk",
|
|
3
|
-
"version": "0.6.
|
|
3
|
+
"version": "0.6.12",
|
|
4
4
|
"description": "DatoCMS Plugin SDK",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -43,5 +43,5 @@
|
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"typedoc": "^0.23.20"
|
|
45
45
|
},
|
|
46
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "2bb2ed65862e666c1aca46a5aeca387b78f1fbca"
|
|
47
47
|
}
|
package/src/connect.ts
CHANGED
|
@@ -92,21 +92,21 @@ export type FullConnectParameters = {
|
|
|
92
92
|
* This function will be called once at boot time and can be used to perform
|
|
93
93
|
* ie. some initial integrity checks on the configuration.
|
|
94
94
|
*
|
|
95
|
-
* @
|
|
95
|
+
* @tag boot
|
|
96
96
|
*/
|
|
97
97
|
onBoot: (ctx: OnBootCtx) => void;
|
|
98
98
|
/**
|
|
99
99
|
* Use this function to declare new tabs you want to add in the top-bar of the
|
|
100
100
|
* UI
|
|
101
101
|
*
|
|
102
|
-
* @
|
|
102
|
+
* @tag pages
|
|
103
103
|
*/
|
|
104
104
|
mainNavigationTabs: (ctx: IntentCtx) => MainNavigationTab[];
|
|
105
105
|
/**
|
|
106
106
|
* Use this function to declare new navigation sections in the Settings Area
|
|
107
107
|
* sidebar
|
|
108
108
|
*
|
|
109
|
-
* @
|
|
109
|
+
* @tag pages
|
|
110
110
|
*/
|
|
111
111
|
settingsAreaSidebarItemGroups: (
|
|
112
112
|
ctx: IntentCtx,
|
|
@@ -115,28 +115,28 @@ export type FullConnectParameters = {
|
|
|
115
115
|
* Use this function to declare new navigation items in the Content Area
|
|
116
116
|
* sidebar
|
|
117
117
|
*
|
|
118
|
-
* @
|
|
118
|
+
* @tag pages
|
|
119
119
|
*/
|
|
120
120
|
contentAreaSidebarItems: (ctx: IntentCtx) => ContentAreaSidebarItem[];
|
|
121
121
|
/**
|
|
122
122
|
* Use this function to declare new field extensions that users will be able
|
|
123
123
|
* to install manually in some field
|
|
124
124
|
*
|
|
125
|
-
* @
|
|
125
|
+
* @tag manualFieldExtensions
|
|
126
126
|
*/
|
|
127
127
|
manualFieldExtensions: (ctx: IntentCtx) => ManualFieldExtension[];
|
|
128
128
|
/**
|
|
129
129
|
* Use this function to declare additional sources to be shown when users want
|
|
130
130
|
* to upload new assets
|
|
131
131
|
*
|
|
132
|
-
* @
|
|
132
|
+
* @tag assetSources
|
|
133
133
|
*/
|
|
134
134
|
assetSources: (ctx: IntentCtx) => AssetSource[] | void;
|
|
135
135
|
/**
|
|
136
136
|
* Use this function to declare new sidebar panels to be shown when the user
|
|
137
137
|
* edits records of a particular model
|
|
138
138
|
*
|
|
139
|
-
* @
|
|
139
|
+
* @tag sidebarPanels
|
|
140
140
|
*/
|
|
141
141
|
itemFormSidebarPanels: (
|
|
142
142
|
itemType: ItemType,
|
|
@@ -147,7 +147,7 @@ export type FullConnectParameters = {
|
|
|
147
147
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
148
148
|
* record's editing page
|
|
149
149
|
*
|
|
150
|
-
* @
|
|
150
|
+
* @tag itemFormOutlets
|
|
151
151
|
*/
|
|
152
152
|
itemFormOutlets: (itemType: ItemType, ctx: IntentCtx) => ItemFormOutlet[];
|
|
153
153
|
|
|
@@ -155,7 +155,7 @@ export type FullConnectParameters = {
|
|
|
155
155
|
* Use this function to automatically force one or more field extensions to a
|
|
156
156
|
* particular field
|
|
157
157
|
*
|
|
158
|
-
* @
|
|
158
|
+
* @tag forcedFieldExtensions
|
|
159
159
|
*/
|
|
160
160
|
overrideFieldExtensions: (
|
|
161
161
|
field: Field,
|
|
@@ -166,7 +166,7 @@ export type FullConnectParameters = {
|
|
|
166
166
|
* Use this function to define a number of custom marks for a specific
|
|
167
167
|
* Structured Text field
|
|
168
168
|
*
|
|
169
|
-
* @
|
|
169
|
+
* @tag structuredText
|
|
170
170
|
*/
|
|
171
171
|
customMarksForStructuredTextField: (
|
|
172
172
|
field: Field,
|
|
@@ -177,7 +177,7 @@ export type FullConnectParameters = {
|
|
|
177
177
|
* Use this function to define a number of custom block styles for a specific
|
|
178
178
|
* Structured Text field
|
|
179
179
|
*
|
|
180
|
-
* @
|
|
180
|
+
* @tag structuredText
|
|
181
181
|
*/
|
|
182
182
|
customBlockStylesForStructuredTextField: (
|
|
183
183
|
field: Field,
|
|
@@ -188,7 +188,7 @@ export type FullConnectParameters = {
|
|
|
188
188
|
* This function will be called when the plugin needs to render the plugin's
|
|
189
189
|
* configuration form
|
|
190
190
|
*
|
|
191
|
-
* @
|
|
191
|
+
* @tag configScreen
|
|
192
192
|
*/
|
|
193
193
|
renderConfigScreen: (ctx: RenderConfigScreenCtx) => void;
|
|
194
194
|
/**
|
|
@@ -196,21 +196,21 @@ export type FullConnectParameters = {
|
|
|
196
196
|
* page (see the `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and
|
|
197
197
|
* `contentAreaSidebarItems` functions)
|
|
198
198
|
*
|
|
199
|
-
* @
|
|
199
|
+
* @tag pages
|
|
200
200
|
*/
|
|
201
201
|
renderPage: (pageId: string, ctx: RenderPageCtx) => void;
|
|
202
202
|
/**
|
|
203
203
|
* This function will be called when the plugin requested to open a modal (see
|
|
204
204
|
* the `openModal` function)
|
|
205
205
|
*
|
|
206
|
-
* @
|
|
206
|
+
* @tag modals
|
|
207
207
|
*/
|
|
208
208
|
renderModal: (modalId: string, ctx: RenderModalCtx) => void;
|
|
209
209
|
/**
|
|
210
210
|
* This function will be called when the plugin needs to render a sidebar
|
|
211
211
|
* panel (see the `itemFormSidebarPanels` function)
|
|
212
212
|
*
|
|
213
|
-
* @
|
|
213
|
+
* @tag sidebarPanels
|
|
214
214
|
*/
|
|
215
215
|
renderItemFormSidebarPanel: (
|
|
216
216
|
sidebarPaneId: string,
|
|
@@ -220,7 +220,7 @@ export type FullConnectParameters = {
|
|
|
220
220
|
* This function will be called when the plugin needs to render an outlet (see
|
|
221
221
|
* the `itemFormOutlets` function)
|
|
222
222
|
*
|
|
223
|
-
* @
|
|
223
|
+
* @tag itemFormOutlets
|
|
224
224
|
*/
|
|
225
225
|
renderItemFormOutlet: (
|
|
226
226
|
itemFormOutletId: string,
|
|
@@ -230,7 +230,7 @@ export type FullConnectParameters = {
|
|
|
230
230
|
* This function will be called when the user selects one of the plugin's
|
|
231
231
|
* asset sources to upload a new media file.
|
|
232
232
|
*
|
|
233
|
-
* @
|
|
233
|
+
* @tag assetSources
|
|
234
234
|
*/
|
|
235
235
|
renderAssetSource: (assetSourceId: string, ctx: RenderAssetSourceCtx) => void;
|
|
236
236
|
/**
|
|
@@ -238,7 +238,7 @@ export type FullConnectParameters = {
|
|
|
238
238
|
* extension (see the `manualFieldExtensions` and `overrideFieldExtensions`
|
|
239
239
|
* functions)
|
|
240
240
|
*
|
|
241
|
-
* @
|
|
241
|
+
* @tag forcedFieldExtensions
|
|
242
242
|
*/
|
|
243
243
|
renderFieldExtension: (
|
|
244
244
|
fieldExtensionId: string,
|
|
@@ -249,7 +249,7 @@ export type FullConnectParameters = {
|
|
|
249
249
|
* configuration form for installing a field extension inside a particular
|
|
250
250
|
* field
|
|
251
251
|
*
|
|
252
|
-
* @
|
|
252
|
+
* @tag manualFieldExtensions
|
|
253
253
|
*/
|
|
254
254
|
renderManualFieldExtensionConfigScreen: (
|
|
255
255
|
fieldExtensionId: string,
|
|
@@ -259,7 +259,7 @@ export type FullConnectParameters = {
|
|
|
259
259
|
* This function will be called each time the configuration object changes. It
|
|
260
260
|
* must return an object containing possible validation errors
|
|
261
261
|
*
|
|
262
|
-
* @
|
|
262
|
+
* @tag manualFieldExtensions
|
|
263
263
|
*/
|
|
264
264
|
validateManualFieldExtensionParameters: (
|
|
265
265
|
fieldExtensionId: string,
|