@openfin/workspace-platform 17.0.9 → 17.0.11

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.
@@ -71,27 +71,40 @@ export interface DockButtonConfig extends CustomButtonConfig {
71
71
  *
72
72
  * ```ts
73
73
  * const sampleDropdownButton1: DockDropdownConfig = {
74
- * type: DockButtonNames.DropdownButton,
75
- * tooltip: "Sample Dropdown Button",
76
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
77
- * options: [
78
- * {
79
- * tooltip: "Dropdown Button 1",
80
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
81
- * action: {
82
- * id: "dropdownButton1",
83
- * customData: "dropdownButton1 clicked",
84
- * },
85
- * },
74
+ * type: DockButtonNames.DropdownButton,
75
+ * tooltip: 'Sample Dropdown Button',
76
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
77
+ * options: [
78
+ * {
79
+ * tooltip: 'Dropdown Button 1',
80
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
81
+ * action: {
82
+ * id: 'dropdownButton1',
83
+ * customData: 'dropdownButton1 clicked',
84
+ * },
85
+ * },
86
+ * {
87
+ * tooltip: 'Dropdown Button 2',
88
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
89
+ * action: {
90
+ * id: 'dropdownButton2',
91
+ * customData: 'dropdownButton2 clicked',
92
+ * },
93
+ * },
94
+ * {
95
+ * tooltip: 'Button with sub-options',
96
+ * options: [
86
97
  * {
87
- * tooltip: "Dropdown Button 2",
88
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
89
- * action: {
90
- * id: "dropdownButton2",
91
- * customData: "dropdownButton2 clicked",
92
- * },
98
+ * tooltip: 'Nested button 1',
99
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
100
+ * action: {
101
+ * id: 'nestedButton1',
102
+ * customData: 'nestedButton1 clicked',
103
+ * },
93
104
  * },
94
- * ],
105
+ * ],
106
+ * },
107
+ * ],
95
108
  * };
96
109
  * ```
97
110
  */
@@ -183,41 +196,54 @@ export interface DockProviderConfigWithIdentity extends ProviderInfo, DockProvid
183
196
  *
184
197
  * ```ts
185
198
  * const provider: DockProvider = {
186
- * id: "provider-id",
187
- * title: "Sample Dock",
188
- * icon: "https://www.openfin.co/favicon-32x32.png",
189
- * buttons: [
199
+ * id: 'provider-id',
200
+ * title: 'Sample Dock',
201
+ * icon: 'https://www.openfin.co/favicon-32x32.png',
202
+ * buttons: [
203
+ * {
204
+ * tooltip: 'Sample Button 1',
205
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
206
+ * action: {
207
+ * id: 'sampleButton1',
208
+ * },
209
+ * },
210
+ * {
211
+ * type: DockButtonNames.DropdownButton,
212
+ * tooltip: 'Sample Dropdown Button',
213
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
214
+ * options: [
190
215
  * {
191
- * tooltip: "Sample Button 1",
192
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
193
- * action: {
194
- * id: "sampleButton1",
195
- * },
216
+ * tooltip: 'Dropdown Button 1',
217
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
218
+ * action: {
219
+ * id: 'dropdownButton1',
220
+ * customData: 'dropdownButton1 clicked',
221
+ * },
222
+ * },
223
+ * {
224
+ * tooltip: 'Dropdown Button 2',
225
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
226
+ * action: {
227
+ * id: 'dropdownButton2',
228
+ * customData: 'dropdownButton2 clicked',
229
+ * },
196
230
  * },
197
231
  * {
198
- * type: DockButtonNames.DropdownButton,
199
- * tooltip: "Sample Dropdown Button",
200
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
201
- * options: [
202
- * {
203
- * tooltip: "Dropdown Button 1",
204
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
205
- * action: {
206
- * id: "dropdownButton1",
207
- * customData: "dropdownButton1 clicked",
208
- * },
209
- * },
210
- * {
211
- * tooltip: "Dropdown Button 2",
212
- * iconUrl: "https://www.openfin.co/favicon-32x32.png",
213
- * action: {
214
- * id: "dropdownButton2",
215
- * customData: "dropdownButton2 clicked",
216
- * },
217
- * },
218
- * ],
232
+ * tooltip: 'Button with sub-options',
233
+ * options: [
234
+ * {
235
+ * tooltip: 'Nested button 1',
236
+ * iconUrl: 'https://www.openfin.co/favicon-32x32.png',
237
+ * action: {
238
+ * id: 'nestedButton1',
239
+ * customData: 'nestedButton1 clicked',
240
+ * },
241
+ * },
242
+ * ],
219
243
  * },
220
- * ],
244
+ * ],
245
+ * },
246
+ * ],
221
247
  * };
222
248
  * ```
223
249
  *