@blackbaud/sky-addin-client - npm Package Compare versions

Comparing version 1.0.21 to 1.1.0

CHANGELOG.md

		@@ -0,1 +1,4 @@
		# 1.1.0 (2020-11-19)
		- Deprecate help widget related functionality.

		# 1.0.21 (2020-11-04)
		@@ -2,0 +5,0 @@ - Add support for event handler to process blocking events from the add-in host.

package.json

		{
		"name": "@blackbaud/sky-addin-client",
		"version": "1.0.21",
		"version": "1.1.0",
		"description": "SKY add-in client",
		@@ -5,0 +5,0 @@ "main": "dist/bundles/sky-addin-client.umd.js",

README.md

		@@ -76,6 +76,6 @@ # sky-addin-client
		Tile add-ins support an optional configuration object that can be used to further control the look/feel/behavior of the tile within the host application. For
		example, to control whether any additional summary text/image is shown when the tile is collapsed, and control whether the "help" and "settings" icons appear
		example, to control whether any additional summary text/image is shown when the tile is collapsed, and control whether the "settings" icons appear
		in the tile header.

		Tile add-ins support optional callbacks for `helpClick` and `settingsClick`, which will be invoked whenever the user clicks the "help" or "settings" icons, respectively:
		Tile add-ins support optional callbacks for `settingsClick`, which will be invoked whenever the user clicks the "settings" icons, respectively:

		@@ -92,3 +92,2 @@ ```js
		summaryText: '18 records',
		showHelp: true,
		showSettings: true
		@@ -98,5 +97,2 @@ }
		},
		helpClick: () => {
		// The user has clicked the "Help" icon in the tile header
		},
		settingsClick: () => {
		@@ -222,11 +218,2 @@ // The user has clicked the "Settings" icon in the tile header

		#### Opening the Blackbaud Help flyout

		The add-in can instruct the parent page to display the Help flyout, and specify which topic to display. To do this, call the `openHelp` method on the `AddinClient` object. This function takes an object argument with property `helpKey` for the name of the help topic to display. A single .html file should be named.

		```js
		var client = new AddinClient({...});
		client.openHelp({ helpKey: '<target_page>.html' });
		```

		#### Showing a toast
		@@ -396,1 +383,6 @@
		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.

src/addin/addin-client.js

		@@ -376,2 +376,3 @@ "use strict";
		break;
		// TODO remove support for this message type when help support is removed in next major release
		case 'help-click':
		@@ -378,0 +379,0 @@ if (this.args.callbacks.helpClick) {

src/addin/client-interfaces/addin-client-callbacks.d.ts

		@@ -28,2 +28,3 @@ import { AddinClientInitArgs } from './addin-client-init-args';
		* Callback raised for tile add-ins indicating that the help button was clicked.
		* @deprecated See _Deprecated help support_ in README
		*/
		@@ -30,0 +31,0 @@ helpClick?: () => void;

src/addin/client-interfaces/addin-client-open-help-args.d.ts

		@@ -7,4 +7,5 @@ /**
		* The name of the help key to be launched.
		* @deprecated See _Deprecated help support_ in README
		*/
		helpKey: string;
		}

src/addin/client-interfaces/addin-tile-config.d.ts

		@@ -20,2 +20,3 @@ import { AddinTileSummaryStyle } from './addin-tile-summary-style';
		* Indicates whether to show the Help icon in the tile chrome
		* @deprecated See _Deprecated help support_ in README
		*/
		@@ -22,0 +23,0 @@ showHelp?: boolean;

src/addin/addin-client.js.map

Sorry, the diff of this file is not supported yet

@blackbaud/sky-addin-client - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics