@blackbaud/skyux-lib-addin-client 14.0.1 → 14.1.0
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/README.md +39 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -320,3 +320,42 @@ export class MyModule { }
|
|
|
320
320
|
```
|
|
321
321
|
|
|
322
322
|
For more information on creating SKY Add-ins, view the documentation on the [SKY Developer Portal](https://developer.blackbaud.com/skyapi/docs/addins)
|
|
323
|
+
|
|
324
|
+
## Modal style
|
|
325
|
+
|
|
326
|
+
Requires version 14.1.0 of this library, which depends on `@blackbaud/sky-addin-client` 1.8.0 or later.
|
|
327
|
+
|
|
328
|
+
A modal add-in can independently configure its document background and the host's overlay through `modalConfig.style`. This library passes these options to `@blackbaud/sky-addin-client` unchanged and doesn't supply defaults.
|
|
329
|
+
|
|
330
|
+
| Option | Behavior |
|
|
331
|
+
|---|---|
|
|
332
|
+
| `transparentBackground: true` | Makes the add-in document's `html` and `body` backgrounds transparent. |
|
|
333
|
+
| `transparentBackground: false` or omitted | Preserves the add-in's document background. |
|
|
334
|
+
| `hostOverlay: false` | Asks the host to make its overlay transparent. Hosts that do not support this option ignore it. |
|
|
335
|
+
| `hostOverlay: true` or omitted | Preserves the host's visible overlay. |
|
|
336
|
+
|
|
337
|
+
```ts
|
|
338
|
+
args.ready({
|
|
339
|
+
showUI: true,
|
|
340
|
+
modalConfig: {
|
|
341
|
+
style: {
|
|
342
|
+
transparentBackground: true,
|
|
343
|
+
hostOverlay: false
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
});
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
With both options set on a compatible host, the add-in document is transparent and the host's overlay is transparent, so the SKY UX modal backdrop is the only visible scrim.
|
|
350
|
+
|
|
351
|
+
The add-in client applies `transparentBackground` itself, so it works on any host. When you set it, you can remove this historical rule:
|
|
352
|
+
|
|
353
|
+
```scss
|
|
354
|
+
::ng-deep body { background: transparent; }
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
`hostOverlay: false` requires a compatible host. Make these two changes together: remove the rule below and set `hostOverlay: false`. On a host that ignores `hostOverlay`, removing the rule shows the SKY UX backdrop on top of the host's overlay (a double scrim). On a compatible host, keeping the rule while setting `hostOverlay: false` leaves no scrim. If your add-in runs on hosts that don't support `hostOverlay`, keep this rule and omit `hostOverlay`:
|
|
358
|
+
|
|
359
|
+
```scss
|
|
360
|
+
::ng-deep .sky-modal-host-backdrop { display: none; }
|
|
361
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blackbaud/skyux-lib-addin-client",
|
|
3
|
-
"version": "14.0
|
|
3
|
+
"version": "14.1.0",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/blackbaud/skyux-lib-addin-client.git"
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"@skyux/theme": "^14.0.1"
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@blackbaud/sky-addin-client": "^1.
|
|
15
|
+
"@blackbaud/sky-addin-client": "^1.8.0",
|
|
16
16
|
"tslib": "^2.8.1"
|
|
17
17
|
},
|
|
18
18
|
"module": "fesm2022/blackbaud-skyux-lib-addin-client.mjs",
|