Skip to content

Commit 2ad5942

Browse files
added note on headless invisible panel
1 parent 65b4403 commit 2ad5942

1 file changed

Lines changed: 28 additions & 5 deletions

File tree

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -431,14 +431,37 @@ To make one or more of your panels an invisible panel, aka hidden from the Exten
431431
]
432432
```
433433

434+
If you want the extension to be completely headless without any UI, make sure to set the `type` to Custom as well:
435+
436+
```js
437+
panels: [
438+
{
439+
mainPath: "./main/index.html",
440+
name: "Invisible Bolt CEP",
441+
panelDisplayName: "",
442+
type: "Custom",
443+
...
444+
}
445+
]
446+
```
447+
434448
You'll want to ensure your panel can be launched from another panel with `csi.requestOpenExtension()` or with an auto-start event in `startOnEvents` in `cep.config.ts` event depending on the app:
435449

436450
```js
437-
startOnEvents: [
438-
"com.adobe.csxs.events.ApplicationActivate",
439-
"com.adobe.csxs.events.ApplicationInitialized",
440-
"applicationActivate",
441-
],
451+
panels: [
452+
{
453+
mainPath: "./main/index.html",
454+
name: "Invisible Bolt CEP",
455+
panelDisplayName: "",
456+
type: "Custom",
457+
startOnEvents: [
458+
"com.adobe.csxs.events.ApplicationActivate",
459+
"com.adobe.csxs.events.ApplicationInitialized",
460+
"applicationActivate",
461+
],
462+
...
463+
}
464+
]
442465
```
443466

444467
Reference the [Adobe CEP Cookbook](https://github.com/Adobe-CEP/CEP-Resources/blob/master/CEP_11.x/Documentation/CEP%2011.1%20HTML%20Extension%20Cookbook.md) for more info on [invisible panels](https://github.com/Adobe-CEP/CEP-Resources/blob/master/CEP_11.x/Documentation/CEP%2011.1%20HTML%20Extension%20Cookbook.md#invisible-html-extensions) and [CEP events](https://github.com/Adobe-CEP/CEP-Resources/blob/master/CEP_11.x/Documentation/CEP%2011.1%20HTML%20Extension%20Cookbook.md#invisible-html-extensions)

0 commit comments

Comments
 (0)