@blackbaud/sky-addin-client 1.1.3 → 1.1.4

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.4 (2023-01-11)
+
+- Add `actionButtonConfig` and `tabConfig` to AddinClientReadyArgs.
+
 # 1.1.3 (2022-05-12)
 - Updated `allowedOrigins` to support Education Management
 

package/README.md

@@ -468,8 +468,3 @@ catch (TokenValidationException ex)
 Once the token has been validated, the add-in's backend will know the Blackbaud user ID and can determine if a user mapping exists for a user in the add-in's system. If a mapping exists, then the add-in's backend can immediately present the content for the add-in. If no user mapping exists, the add-in can prompt the user to login.
 
 For more information on Blackbaud's SKY Add-in framework, please see https://developer.blackbaud.com/skyapi/docs/addins.
-
-## Deprecated help support
-
-Using the help widget experience in the context of an addin is generally not needed and contradicts BB's UX patterns.
-As a result, the widget support has been deprecated and will be remove in the next major release.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name":  "@blackbaud/sky-addin-client",
-    "version":  "1.1.3",
+    "version":  "1.1.4",
     "description":  "SKY add-in client",
     "main":  "dist/bundles/sky-addin-client.umd.js",
     "module":  "index.js",
@@ -58,7 +58,7 @@
                             "raw-loader":  "4.0.0",
                             "remap-istanbul":  "0.13.0",
                             "rimraf":  "3.0.2",
-                            "source-map-inline-loader":  "github:blackbaud-bobbyearl/source-map-inline-loader",
+                            "source-map-inline-loader":  "1.0.0",
                             "ts-loader":  "6.2.2",
                             "tslint":  "5.18.0",
                             "tslint-loader":  "3.5.4",

package/src/addin/client-interfaces/addin-action-button-config.d.ts

@@ -0,0 +1,10 @@
+export interface AddinActionButtonConfig {
+    /**
+     * The description content to display on the action button.
+     */
+    description?: string;
+    /**
+     * The icon to use for the action button.
+     */
+    icon?: string;
+}

package/src/addin/client-interfaces/addin-action-button-config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=addin-action-button-config.js.map

package/src/addin/client-interfaces/addin-action-button-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addin-action-button-config.js","sourceRoot":"","sources":["../../../../src/addin/client-interfaces/addin-action-button-config.ts"],"names":[],"mappings":""}

package/src/addin/client-interfaces/addin-client-ready-args.d.ts

@@ -1,5 +1,7 @@
+import { AddinActionButtonConfig } from './addin-action-button-config';
 import { AddinButtonConfig } from './addin-button-config';
 import { AddinModalConfig } from './addin-modal-config';
+import { AddinTabConfig } from './addin-tab-config';
 import { AddinTileConfig } from './addin-tile-config';
 /**
  * Interface for informing the AddinClient that the add-in is ready.
@@ -26,4 +28,12 @@ export interface AddinClientReadyArgs {
      * Provides additional configuration for Modal add-ins
      */
     modalConfig?: AddinModalConfig;
+    /**
+     * Provides additional configuration for Action Button add-ins
+     */
+    actionButtonConfig?: AddinActionButtonConfig;
+    /**
+     * Provides additional configuration for Tab add-ins
+     */
+    tabConfig?: AddinTabConfig;
 }

package/src/addin/client-interfaces/addin-tab-config.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Interface for defining configuration options for Tab add-ins
+ */
+export interface AddinTabConfig {
+    /**
+     * Displays a counter beside the tab header.
+     */
+    tabHeaderCount?: string;
+}

package/src/addin/client-interfaces/addin-tab-config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=addin-tab-config.js.map

package/src/addin/client-interfaces/addin-tab-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addin-tab-config.js","sourceRoot":"","sources":["../../../../src/addin/client-interfaces/addin-tab-config.ts"],"names":[],"mappings":""}